com.github.bordertech.wcomponents.examples

Class TextImage

java.lang.Object

com.github.bordertech.wcomponents.examples.TextImage

All Implemented Interfaces:

ContentAccess, Image, Serializable

public class TextImage
extends Object
implements Image

A simple text to image class, used by some of the examples.

Since:

1.0.0

Author:

Yiannis Pachalidis

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TextImage(String text) Creates a TextImage with the default size.
TextImage(String text, Dimension size) Creates a TextImage.

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getBytes()
String	getDescription() Retrieves some text that describes the image, for example the document filename or title.
String	getMimeType() Retrieves the mime type of the image - "image/jpeg", "image/gif" etc.
Dimension	getSize() Retrieves the natural size of the image.
void	setDescription(String description) Sets some text that describes the image, for example the document filename or title.
void	setSize(Dimension size) Sets the natural size of the image.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TextImage

public TextImage(String text)

Creates a TextImage with the default size.

Parameters:

text - the text to display on the image.

TextImage

public TextImage(String text,
         Dimension size)

Creates a TextImage.

Parameters:

text - the text to display on the image.

size - the size of the image to generate.

Method Detail

getMimeType

public String getMimeType()

Retrieves the mime type of the image - "image/jpeg", "image/gif" etc.

Specified by:

getMimeType in interface ContentAccess

Returns:

the image mime type.

getSize

public Dimension getSize()

Retrieves the natural size of the image. If only one dimension is known, a negative value will be returned for the other dimension.

Specified by:

getSize in interface Image

Returns:

the image size, or null if unknown.

setSize

public void setSize(Dimension size)

Sets the natural size of the image. If only one dimension is known, use a negative value for the other dimension. If the image size is unknown, set the size to null.

Parameters:

size - the image size.

getBytes

public byte[] getBytes()

Specified by:

getBytes in interface ContentAccess

Returns:

the bytes that make up the document content.

getDescription

public String getDescription()

Retrieves some text that describes the image, for example the document filename or title.

Specified by:

getDescription in interface ContentAccess

Returns:

a short document description

setDescription

public void setDescription(String description)

Sets some text that describes the image, for example the document filename or title.

Parameters:

description - the short document description.