GifPlainTextRenderingBlock

Inheritance: java.lang.Object, com.aspose.imaging.fileformats.gif.GifBlock

public class GifPlainTextRenderingBlock extends GifBlock

Gif plain text extension block. The plain text extension contains textual data and the parameters necessary to render that data as a graphic, in a simple form.

Constructors

Constructor	Description
GifPlainTextRenderingBlock()	Initializes a new instance of the GifPlainTextRenderingBlock class.
GifPlainTextRenderingBlock(int textGridLeftPosition, int textGridTopPosition, int textGridWidth, int textGridHeight, byte characterCellWidth, byte characterCellHeight, byte textForegroundColorIndex, byte textBackgroundColorIndex, byte[] data)	Initializes a new instance of the GifPlainTextRenderingBlock class.

Fields

Field	Description
EXTENSION_LABEL	The plain text extension label.
SUB_BLOCK_SIZE	The size of the sub block.
BLOCK_SIZE	The overall block size.

Methods

Method	Description
getTextForegroundColorIndex()	Gets or sets the index of the color in the global color palette used to draw the text foreground.
setTextForegroundColorIndex(byte value)	Gets or sets the index of the color in the global color palette used to draw the text foreground.
getTextBackgroundColorIndex()	Gets or sets the index of the color in the global color palette used to draw the text background.
setTextBackgroundColorIndex(byte value)	Gets or sets the index of the color in the global color palette used to draw the text background.
getCharacterCellWidth()	Gets or sets the character cell width, in pixels, of each cell in the grid.
setCharacterCellWidth(byte value)	Gets or sets the character cell width, in pixels, of each cell in the grid.
getCharacterCellHeight()	Gets or sets the character cell height, in pixels, of each cell in the grid.
setCharacterCellHeight(byte value)	Gets or sets the character cell height, in pixels, of each cell in the grid.
getTextGridLeftPosition()	Gets or sets the text grid left position.
setTextGridLeftPosition(int value)	Gets or sets the text grid left position.
getTextGridTopPosition()	Gets or sets the text grid top position.
setTextGridTopPosition(int value)	Gets or sets the text grid top position.
getTextGridWidth()	Gets or sets the text grid with in pixels
setTextGridWidth(int value)	Gets or sets the text grid with in pixels
getTextGridHeight()	Gets or sets the text grid height in pixels
setTextGridHeight(int value)	Gets or sets the text grid height in pixels
getPlainTextData()	Gets or sets the plain text data.
setPlainTextData(byte[] value)	Gets or sets the plain text data.

GifPlainTextRenderingBlock()

public GifPlainTextRenderingBlock()

Initializes a new instance of the GifPlainTextRenderingBlock class.

GifPlainTextRenderingBlock(int textGridLeftPosition, int textGridTopPosition, int textGridWidth, int textGridHeight, byte characterCellWidth, byte characterCellHeight, byte textForegroundColorIndex, byte textBackgroundColorIndex, byte[] data)

public GifPlainTextRenderingBlock(int textGridLeftPosition, int textGridTopPosition, int textGridWidth, int textGridHeight, byte characterCellWidth, byte characterCellHeight, byte textForegroundColorIndex, byte textBackgroundColorIndex, byte[] data)

Initializes a new instance of the GifPlainTextRenderingBlock class.

Parameters:

Parameter	Type	Description
textGridLeftPosition	int	The text grid left position.
textGridTopPosition	int	The text grid top position.
textGridWidth	int	The text grid width.
textGridHeight	int	The text grid height.
characterCellWidth	byte	The character cell width.
characterCellHeight	byte	The character cell height.
textForegroundColorIndex	byte	The foreground color index.
textBackgroundColorIndex	byte	The background color index.
data	byte[]	The plain text data.

EXTENSION_LABEL

public static final byte EXTENSION_LABEL

The plain text extension label.

SUB_BLOCK_SIZE

public static final byte SUB_BLOCK_SIZE

The size of the sub block.

BLOCK_SIZE

public static final byte BLOCK_SIZE

The overall block size.

getTextForegroundColorIndex()

public byte getTextForegroundColorIndex()

Gets or sets the index of the color in the global color palette used to draw the text foreground.

Value: The foreground color index.

Returns: byte

setTextForegroundColorIndex(byte value)

public void setTextForegroundColorIndex(byte value)

Gets or sets the index of the color in the global color palette used to draw the text foreground.

Value: The foreground color index.

Parameters:

Parameter	Type	Description
value	byte

getTextBackgroundColorIndex()

public byte getTextBackgroundColorIndex()

Gets or sets the index of the color in the global color palette used to draw the text background.

Value: The background color index.

Returns: byte

setTextBackgroundColorIndex(byte value)

public void setTextBackgroundColorIndex(byte value)

Gets or sets the index of the color in the global color palette used to draw the text background.

Value: The background color index.

Parameters:

Parameter	Type	Description
value	byte

getCharacterCellWidth()

public byte getCharacterCellWidth()

Gets or sets the character cell width, in pixels, of each cell in the grid.

Value: The character cell width.

Returns: byte

setCharacterCellWidth(byte value)

public void setCharacterCellWidth(byte value)

Gets or sets the character cell width, in pixels, of each cell in the grid.

Value: The character cell width.

Parameters:

Parameter	Type	Description
value	byte

getCharacterCellHeight()

public byte getCharacterCellHeight()

Gets or sets the character cell height, in pixels, of each cell in the grid.

Value: The character cell height.

Returns: byte

setCharacterCellHeight(byte value)

public void setCharacterCellHeight(byte value)

Gets or sets the character cell height, in pixels, of each cell in the grid.

Value: The character cell height.

Parameters:

Parameter	Type	Description
value	byte

getTextGridLeftPosition()

public int getTextGridLeftPosition()

Gets or sets the text grid left position.

Value: The text grid left position.

This is a column number, in pixels, of the left edge of the text grid, with respect to the left edge of the logical screen.

Returns: int

setTextGridLeftPosition(int value)

public void setTextGridLeftPosition(int value)

Gets or sets the text grid left position.

Value: The text grid left position.

This is a column number, in pixels, of the left edge of the text grid, with respect to the left edge of the logical screen.

Parameters:

Parameter	Type	Description
value	int

getTextGridTopPosition()

public int getTextGridTopPosition()

Gets or sets the text grid top position.

Value: The text grid top position.

This is a row number, in pixels, of the top edge of the text grid, with respect to the top edge of the logical screen.

Returns: int

setTextGridTopPosition(int value)

public void setTextGridTopPosition(int value)

Gets or sets the text grid top position.

Value: The text grid top position.

This is a row number, in pixels, of the top edge of the text grid, with respect to the top edge of the logical screen.

Parameters:

Parameter	Type	Description
value	int

getTextGridWidth()

public int getTextGridWidth()

Gets or sets the text grid with in pixels

Value: The text grid width in pixels.

Returns: int

setTextGridWidth(int value)

public void setTextGridWidth(int value)

Gets or sets the text grid with in pixels

Value: The text grid width in pixels.

Parameters:

Parameter	Type	Description
value	int

getTextGridHeight()

public int getTextGridHeight()

Gets or sets the text grid height in pixels

Value: The text grid height in pixels.

Returns: int

setTextGridHeight(int value)

public void setTextGridHeight(int value)

Gets or sets the text grid height in pixels

Value: The text grid height in pixels.

Parameters:

Parameter	Type	Description
value	int

getPlainTextData()

public byte[] getPlainTextData()

Gets or sets the plain text data.

Value: The plain text data.

Returns: byte[]

setPlainTextData(byte[] value)

public void setPlainTextData(byte[] value)

Gets or sets the plain text data.

Value: The plain text data.

Parameters:

Parameter	Type	Description
value	byte[]