All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.kvisco.xsl.Formatter

com.kvisco.xsl.Formatter

public abstract class Formatter
An abstract class for processing Formatting Objects. Extend this class if you wish to do anything meaningful with Formatting Objects.

Author:
Keith Visco

Variable Index

 o BLOCK_LEVEL_BOX_TAG
The tag name of a block-level-box formatting object
 o BLOCK_LEVEL_BOX_TYPE
An int value denoting a block-level-box formatting object
 o BLOCK_TAG
The tag name of a block formatting object
 o BLOCK_TYPE
An int value denoting a block formatting object
 o CHARACTER_TAG
The tag name of a character formatting object
 o CHARACTER_TYPE
An int value denoting a character formatting object
 o flowObjectCodes
A Hashtable of formatting object tag names to values.
 o GRAPHIC_TAG
The tag name of a graphic formatting object
 o GRAPHIC_TYPE
An int value denoting a graphic formatting object
 o INLINE_BOX_TAG
The tag name of a inline-box formatting object
 o INLINE_BOX_TYPE
An int value denoting a inline-box formatting object
 o LINK_END_LOCATOR_TAG
The tag name of a link-end-locator formatting object
 o LINK_END_LOCATOR_TYPE
An int value denoting a line-end-locator formatting object
 o LINK_TAG
The tag name of a link formatting object
 o LINK_TYPE
An int value denoting a link formatting object
 o LIST_ITEM_LABEL_TAG
The tag name of a list-item-label formatting object
 o LIST_ITEM_LABEL_TYPE
An int value denoting a list-item-label formatting object
 o LIST_ITEM_TAG
The tag name of a list-item formatting object
 o LIST_ITEM_TYPE
An int value denoting a list-item formatting object
 o LIST_TAG
The tag name of a list formatting object
 o LIST_TYPE
An int value denoting a list formatting object
 o PAGE_NUMBER_TAG
The tag name of a page-number formatting object
 o PAGE_NUMBER_TYPE
An int value denoting a page-number formatting object
 o PAGE_SEQUENCE_TAG
The tag name of a page-sequence formatting object
 o PAGE_SEQUENCE_TYPE
An int value denoting a page-sequence formatting object
 o QUEUE_TAG
The tag name of a queue formatting object
 o QUEUE_TYPE
An int value denoting a queue formatting object
 o RULE_GRAPHIC_TAG
The tag name of a rule-graphic formatting object
 o RULE_GRAPHIC_TYPE
An int value denoting a rule-graphic formatting object
 o SCORE_TAG
The tag name of a score formatting object
 o SCORE_TYPE
An int value denoting a score formatting object
 o SEQUENCE_TAG
The tag name of a sequence formatting object
 o SEQUENCE_TYPE
An int value denoting a sequence formatting object
 o SIMPLE_PAGE_SEQUENCE_TAG
The tag name of a simple-page-sequence formatting object
 o SIMPLE_PAGE_SEQUENCE_TYPE
An int value denoting a simple-page-sequence formatting object

Constructor Index

 o Formatter()
Creates a new Formatter

Method Index

 o createCodeTable()
Creates a Hashtable of Formatting Object names and values The values are good for switching on.
 o getIndentResult()
Returns true if this Formatter is allowed to indent the result
 o getIndentSize()
Returns the indent size for this Formatter
 o process(Document, PrintWriter)
Processes the given set of nodes
 o setIndentResult(boolean)
Sets whether or not this Formatter can indent the result
 o setIndentSize(int)
Sets the size of the indentation

Variables

 o PAGE_SEQUENCE_TYPE
 public static final int PAGE_SEQUENCE_TYPE
An int value denoting a page-sequence formatting object

 o SIMPLE_PAGE_SEQUENCE_TYPE
 public static final int SIMPLE_PAGE_SEQUENCE_TYPE
An int value denoting a simple-page-sequence formatting object

 o SEQUENCE_TYPE
 public static final int SEQUENCE_TYPE
An int value denoting a sequence formatting object

 o QUEUE_TYPE
 public static final int QUEUE_TYPE
An int value denoting a queue formatting object

 o LIST_TYPE
 public static final int LIST_TYPE
An int value denoting a list formatting object

 o LIST_ITEM_TYPE
 public static final int LIST_ITEM_TYPE
An int value denoting a list-item formatting object

 o LIST_ITEM_LABEL_TYPE
 public static final int LIST_ITEM_LABEL_TYPE
An int value denoting a list-item-label formatting object

 o BLOCK_TYPE
 public static final int BLOCK_TYPE
An int value denoting a block formatting object

 o CHARACTER_TYPE
 public static final int CHARACTER_TYPE
An int value denoting a character formatting object

 o RULE_GRAPHIC_TYPE
 public static final int RULE_GRAPHIC_TYPE
An int value denoting a rule-graphic formatting object

 o GRAPHIC_TYPE
 public static final int GRAPHIC_TYPE
An int value denoting a graphic formatting object

 o SCORE_TYPE
 public static final int SCORE_TYPE
An int value denoting a score formatting object

 o INLINE_BOX_TYPE
 public static final int INLINE_BOX_TYPE
An int value denoting a inline-box formatting object

 o BLOCK_LEVEL_BOX_TYPE
 public static final int BLOCK_LEVEL_BOX_TYPE
An int value denoting a block-level-box formatting object

 o PAGE_NUMBER_TYPE
 public static final int PAGE_NUMBER_TYPE
An int value denoting a page-number formatting object

 o LINK_TYPE
 public static final int LINK_TYPE
An int value denoting a link formatting object

 o LINK_END_LOCATOR_TYPE
 public static final int LINK_END_LOCATOR_TYPE
An int value denoting a line-end-locator formatting object

 o PAGE_SEQUENCE_TAG
 public static final String PAGE_SEQUENCE_TAG
The tag name of a page-sequence formatting object

 o SIMPLE_PAGE_SEQUENCE_TAG
 public static final String SIMPLE_PAGE_SEQUENCE_TAG
The tag name of a simple-page-sequence formatting object

 o SEQUENCE_TAG
 public static final String SEQUENCE_TAG
The tag name of a sequence formatting object

 o QUEUE_TAG
 public static final String QUEUE_TAG
The tag name of a queue formatting object

 o LIST_TAG
 public static final String LIST_TAG
The tag name of a list formatting object

 o LIST_ITEM_TAG
 public static final String LIST_ITEM_TAG
The tag name of a list-item formatting object

 o LIST_ITEM_LABEL_TAG
 public static final String LIST_ITEM_LABEL_TAG
The tag name of a list-item-label formatting object

 o BLOCK_TAG
 public static final String BLOCK_TAG
The tag name of a block formatting object

 o CHARACTER_TAG
 public static final String CHARACTER_TAG
The tag name of a character formatting object

 o RULE_GRAPHIC_TAG
 public static final String RULE_GRAPHIC_TAG
The tag name of a rule-graphic formatting object

 o GRAPHIC_TAG
 public static final String GRAPHIC_TAG
The tag name of a graphic formatting object

 o SCORE_TAG
 public static final String SCORE_TAG
The tag name of a score formatting object

 o INLINE_BOX_TAG
 public static final String INLINE_BOX_TAG
The tag name of a inline-box formatting object

 o BLOCK_LEVEL_BOX_TAG
 public static final String BLOCK_LEVEL_BOX_TAG
The tag name of a block-level-box formatting object

 o PAGE_NUMBER_TAG
 public static final String PAGE_NUMBER_TAG
The tag name of a page-number formatting object

 o LINK_TAG
 public static final String LINK_TAG
The tag name of a link formatting object

 o LINK_END_LOCATOR_TAG
 public static final String LINK_END_LOCATOR_TAG
The tag name of a link-end-locator formatting object

 o flowObjectCodes
 public static Hashtable flowObjectCodes
A Hashtable of formatting object tag names to values.

Constructors

 o Formatter
 public Formatter()
Creates a new Formatter

Methods

 o createCodeTable
 public static Hashtable createCodeTable()
Creates a Hashtable of Formatting Object names and values The values are good for switching on.

Returns:
the Hashtable of formatting object names and type values
 o getIndentResult
 public boolean getIndentResult()
Returns true if this Formatter is allowed to indent the result

Returns:
true if this Formatter is allowed to indent the result
 o getIndentSize
 public int getIndentSize()
Returns the indent size for this Formatter

Returns:
the indent size for this Formatter
 o setIndentResult
 public void setIndentResult(boolean indentResult)
Sets whether or not this Formatter can indent the result

Parameters:
indentResult - the boolean indicating whether or not to allow indentation of the result
 o setIndentSize
 public void setIndentSize(int size)
Sets the size of the indentation

Parameters:
size - the number of spaces to indent, if indentation is allowed.
 o process
 public abstract void process(Document document,
                              PrintWriter output)
Processes the given set of nodes

Parameters:
document - the Document to process
output - the PrintStream for IO during processing.
See Also:
Document

All Packages  Class Hierarchy  This Package  Previous  Next  Index