com.lowagie.text.rtf.parser.destinations

Class RtfDestinationColorTable

public class RtfDestinationColorTable extends RtfDestination

RtfDestinationColorTable handles data destined for the color table destination

Since: 2.0.8

Author: Howard Shank (hgshank@yahoo.com)

Field Summary
intblue
The blue component of the current color being parsed.
HashMapcolorMap
Color map object for conversions
intcolorNr
The number of the current color being parsed.
intcshade
Specifies the shade when specifying a theme color.
intctint
Specifies the tint when specifying a theme color.
intgreen
The green component of the current color being parsed.
RtfImportMgrimportHeader
The RtfImportHeader to add color mappings to.
intred
The red component of the current color being parsed.
intthemeColor
Specifies the use of a theme color.
Constructor Summary
RtfDestinationColorTable()
Constructor.
RtfDestinationColorTable(RtfParser parser)
Constructs a new RtfColorTableParser.
Method Summary
booleancloseDestination()
ColorgetColor(String key)
Get the Color object that is mapped to the key.
booleanhandleCharacter(int ch)
booleanhandleCloseGroup()
booleanhandleControlWord(RtfCtrlWordData ctrlWordData)
booleanhandleOpenGroup()
booleanhandleOpeningSubGroup()
voidprocessColor()
Processes the color triplet parsed from the document.
voidsetBlue(int value)
Set the blue color value.
voidsetGreen(int value)
Set the green color value.
voidsetParser(RtfParser parser)
voidsetRed(int value)
Set the red color to value.
voidsetShade(int value)
Set the shade value
voidsetThemeColor(int value)
Set the theme color value.
voidsetTint(int value)
Set the tint value
voidsetToDefaults()
Set default values.

Field Detail

blue

private int blue
The blue component of the current color being parsed.

colorMap

private HashMap colorMap
Color map object for conversions

colorNr

private int colorNr
The number of the current color being parsed.

cshade

private int cshade
Specifies the shade when specifying a theme color. RTF control word cshade 0 - 255: 0 = full shade(black), 255 = no shade. Default value: 255 If shade is specified and is less than 255, ctint must equal 255. cshade/ctint are mutually exclusive

See Also: ctint themeColor

ctint

private int ctint
Specifies the tint when specifying a theme color. RTF control word ctint 0 - 255: 0 = full tint(white), 255 = no tint. Default value: 255 If tint is specified and is less than 255, cshade must equal 255. ctint/cshade are mutually exclusive

See Also: cshade themeColor

green

private int green
The green component of the current color being parsed.

importHeader

private RtfImportMgr importHeader
The RtfImportHeader to add color mappings to.

red

private int red
The red component of the current color being parsed.

themeColor

private int themeColor
Specifies the use of a theme color.

See Also: RtfColorThemes ctint cshade

Constructor Detail

RtfDestinationColorTable

public RtfDestinationColorTable()
Constructor.

RtfDestinationColorTable

public RtfDestinationColorTable(RtfParser parser)
Constructs a new RtfColorTableParser.

Parameters: parser an RtfParser

Method Detail

closeDestination

public boolean closeDestination()

getColor

public Color getColor(String key)
Get the Color object that is mapped to the key.

Parameters: key The map number. *@return Color object from the map. null if key does not exist.

handleCharacter

public boolean handleCharacter(int ch)

handleCloseGroup

public boolean handleCloseGroup()

handleControlWord

public boolean handleControlWord(RtfCtrlWordData ctrlWordData)

handleOpenGroup

public boolean handleOpenGroup()

handleOpeningSubGroup

public boolean handleOpeningSubGroup()

processColor

private void processColor()
Processes the color triplet parsed from the document. Add it to the import mapping so colors can be mapped when encountered in the RTF import or conversion.

setBlue

private void setBlue(int value)
Set the blue color value.

Parameters: value Value to set blue to.

setGreen

private void setGreen(int value)
Set the green color value.

Parameters: value Value to set green to.

setParser

public void setParser(RtfParser parser)

setRed

private void setRed(int value)
Set the red color to value.

Parameters: value Value to set red to.

setShade

private void setShade(int value)
Set the shade value

Parameters: value Value to set the shade to

See Also: cshade

setThemeColor

private void setThemeColor(int value)
Set the theme color value.

Parameters: value Value to set the theme color to

See Also: RtfColorThemes

setTint

private void setTint(int value)
Set the tint value

Parameters: value Value to set the tint to

See Also: ctint

setToDefaults

public void setToDefaults()
Set default values.