edu.northwestern.at.wordhoard.tools.cm
Class TextElementRule

java.lang.Object
  edu.northwestern.at.wordhoard.tools.cm.Style
      edu.northwestern.at.wordhoard.tools.cm.TextElementRule

All Implemented Interfaces:

java.lang.Cloneable

public class TextElementRule
extends Style

A text element rule.

Field Summary

static byte	ALWAYS Always create a work part.
static byte	NEVER Never create a work part.
static byte	SOMETIMES Sometimes create a work part, in contexts where one must be interpolated.

Fields inherited from class edu.northwestern.at.wordhoard.tools.cm.Style

BOLD, CENTER, EXTENDED, ITALIC, LEFT, MONOSPACED, NO_CHANGE, OVERLINE, PLAIN, RIGHT, STYLE_NAMES, SUBSCRIPT, SUPERSCRIPT, UNDERLINE

Constructor Summary

TextElementRule(org.w3c.dom.Element el)
Creates a new text element rule.

Method Summary

byte	getCreatePart() Gets when to create a work part.
boolean	getDoNotCreateWorkParts() Returns true if descendants should never create work parts.
byte	getEmitTagName() Returns true to generate start and end tags for element.
boolean	getFootnote() Returns true to treat as footnote.
java.lang.String	getGenAfter() Gets the string to generate after processing the element.
java.lang.String	getGenBefore() Gets the string to generate before processing the element.
boolean	getIgnoreChildren() Returns true to ignore children.
boolean	getIgnoreRend() Returns true to ignore rend attribute.
boolean	getLineBreak() Returns true to generate line break before and after.
java.lang.String	getName() Returns the element name.
boolean	getParBreak() Returns true to generate paragraph break before and after.
boolean	getStyleChange() Returns true if this elements changes the style.

Methods inherited from class edu.northwestern.at.wordhoard.tools.cm.Style

add, clone, getIndent, getLineStyle, getWordStyles, setIndent, setLineStyle, setWordStyles, styleChange, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NEVER

public static final byte NEVER

Never create a work part.

See Also:

Constant Field Values

SOMETIMES

public static final byte SOMETIMES

Sometimes create a work part, in contexts where one must be interpolated.

See Also:

Constant Field Values

ALWAYS

public static final byte ALWAYS

Always create a work part.

See Also:

Constant Field Values

Constructor Detail

TextElementRule

public TextElementRule(org.w3c.dom.Element el)

Creates a new text element rule.

Parameters:

el - TextElementRule element.

Method Detail

getName

public java.lang.String getName()

Returns the element name.

Returns:

Element name.

getIgnoreChildren

public boolean getIgnoreChildren()

Returns true to ignore children.

Returns:

True to ignore children.

getLineBreak

public boolean getLineBreak()

Returns true to generate line break before and after.

Returns:

True to generate line break before and after.

getParBreak

public boolean getParBreak()

Returns true to generate paragraph break before and after.

Returns:

True to generate paragraph break before and after.

getCreatePart

public byte getCreatePart()

Gets when to create a work part.

Returns:

When to create a work part.

getFootnote

public boolean getFootnote()

Returns true to treat as footnote.

Returns:

True to treat as footnote.

getDoNotCreateWorkParts

public boolean getDoNotCreateWorkParts()

Returns true if descendants should never create work parts.

Returns:

True if descendants should never create work parts.

getIgnoreRend

public boolean getIgnoreRend()

Returns true to ignore rend attribute.

Returns:

True to ignore rend attribute.

getGenBefore

public java.lang.String getGenBefore()

Gets the string to generate before processing the element.

Returns:

String to generate before processing the element, or null if none.

getGenAfter

public java.lang.String getGenAfter()

Gets the string to generate after processing the element.

Returns:

String to generate after processing the element, null if none.

getStyleChange

public boolean getStyleChange()

Returns true if this elements changes the style.

Returns:

True if style change.

getEmitTagName

public byte getEmitTagName()

Returns true to generate start and end tags for element.

Returns:

When to generate start and end tags for element.