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
int	blue The blue component of the current color being parsed.
HashMap	colorMap Color map object for conversions
int	colorNr The number of the current color being parsed.
int	cshade Specifies the shade when specifying a theme color.
int	ctint Specifies the tint when specifying a theme color.
int	green The green component of the current color being parsed.
RtfImportMgr	importHeader The RtfImportHeader to add color mappings to.
int	red The red component of the current color being parsed.
int	themeColor Specifies the use of a theme color.

Constructor Summary
	RtfDestinationColorTable() Constructor.
	RtfDestinationColorTable(RtfParser parser) Constructs a new RtfColorTableParser.

Method Summary
boolean	closeDestination()
Color	getColor(String key) Get the `Color` object that is mapped to the key.
boolean	handleCharacter(int ch)
boolean	handleCloseGroup()
boolean	handleControlWord(RtfCtrlWordData ctrlWordData)
boolean	handleOpenGroup()
boolean	handleOpeningSubGroup()
void	processColor() Processes the color triplet parsed from the document.
void	setBlue(int value) Set the blue color value.
void	setGreen(int value) Set the green color value.
void	setParser(RtfParser parser)
void	setRed(int value) Set the red color to value.
void	setShade(int value) Set the shade value
void	setThemeColor(int value) Set the theme color value.
void	setTint(int value) Set the tint value
void	setToDefaults() 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.

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

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

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.

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.