com.aspose.imaging.fileformats.gif.blocks
Class GifPlainTextRenderingBlock

java.lang.Object
  extended by com.aspose.imaging.fileformats.gif.GifBlock
      extended by com.aspose.imaging.fileformats.gif.blocks.GifPlainTextRenderingBlock
All Implemented Interfaces:
IGifBlock

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.


Field Summary
static byte BlockSize
           The overall block size.
static byte ExtensionLabel
           The plain text extension label.
static byte SubBlockSize
           The size of the sub block.
 
Fields inherited from class com.aspose.imaging.fileformats.gif.GifBlock
ExtensionIntroducer
 
Constructor Summary
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.
 
Method Summary
 byte getCharacterCellHeight()
           Gets or sets the character cell height, in pixels, of each cell in the grid.
 byte getCharacterCellWidth()
           Gets or sets the character cell width, in pixels, of each cell in the grid.
 byte[] getPlainTextData()
           Gets or sets the plain text data.
 byte getTextBackgroundColorIndex()
           Gets or sets the index of the color in the global color palette used to draw the text background.
 byte getTextForegroundColorIndex()
           Gets or sets the index of the color in the global color palette used to draw the text foreground.
 int getTextGridHeight()
           Gets or sets the text grid height in pixels Value: The text grid height in pixels.
 int getTextGridLeftPosition()
           Gets or sets the text grid left position.
 int getTextGridTopPosition()
           Gets or sets the text grid top position.
 int getTextGridWidth()
           Gets or sets the text grid with in pixels Value: The text grid width in pixels.
 void save(java.io.InputStream stream)
           Saves the block to the specified InputStream.
 void saveInternal(Stream stream)
           Saves the block to the specified stream.
 void setCharacterCellHeight(byte value)
           
 void setCharacterCellWidth(byte value)
           
 void setPlainTextData(byte[] value)
           
 void setTextBackgroundColorIndex(byte value)
           
 void setTextForegroundColorIndex(byte value)
           
 void setTextGridHeight(int value)
           
 void setTextGridLeftPosition(int value)
           
 void setTextGridTopPosition(int value)
           
 void setTextGridWidth(int value)
           
 
Methods inherited from class com.aspose.imaging.fileformats.gif.GifBlock
isChanged, isChanged
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

BlockSize

public static final byte BlockSize

The overall block size.

See Also:
Constant Field Values

ExtensionLabel

public static final byte ExtensionLabel

The plain text extension label.

See Also:
Constant Field Values

SubBlockSize

public static final byte SubBlockSize

The size of the sub block.

See Also:
Constant Field Values
Constructor Detail

GifPlainTextRenderingBlock

public GifPlainTextRenderingBlock()

Initializes a new instance of the GifPlainTextRenderingBlock class.


GifPlainTextRenderingBlock

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:
textGridLeftPosition - The text grid left position.
textGridTopPosition - The text grid top position.
textGridWidth - The text grid width.
textGridHeight - The text grid height.
characterCellWidth - The character cell width.
characterCellHeight - The character cell height.
textForegroundColorIndex - The foreground color index.
textBackgroundColorIndex - The background color index.
data - The plain text data.
Method Detail

getCharacterCellHeight

public byte getCharacterCellHeight()

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

Value: The character cell height.


getCharacterCellWidth

public byte getCharacterCellWidth()

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

Value: The character cell width.


getPlainTextData

public byte[] getPlainTextData()

Gets or sets the plain text data.

Value: The plain text data.


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.


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.


getTextGridHeight

public int getTextGridHeight()

Gets or sets the text grid height in pixels

Value: The text grid height in pixels.


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.


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.


getTextGridWidth

public int getTextGridWidth()

Gets or sets the text grid with in pixels

Value: The text grid width in pixels.


save

public void save(java.io.InputStream stream)
Description copied from class: GifBlock

Saves the block to the specified InputStream.

Specified by:
save in interface IGifBlock
Overrides:
save in class GifBlock

saveInternal

public void saveInternal(Stream stream)

Saves the block to the specified stream.

Specified by:
saveInternal in interface IGifBlock
Specified by:
saveInternal in class GifBlock
Parameters:
stream - The stream to save data to.

setCharacterCellHeight

public void setCharacterCellHeight(byte value)

setCharacterCellWidth

public void setCharacterCellWidth(byte value)

setPlainTextData

public void setPlainTextData(byte[] value)

setTextBackgroundColorIndex

public void setTextBackgroundColorIndex(byte value)

setTextForegroundColorIndex

public void setTextForegroundColorIndex(byte value)

setTextGridHeight

public void setTextGridHeight(int value)

setTextGridLeftPosition

public void setTextGridLeftPosition(int value)

setTextGridTopPosition

public void setTextGridTopPosition(int value)

setTextGridWidth

public void setTextGridWidth(int value)