Package net.sf.jett.tag

Class PageBreakTag

java.lang.Object

net.sf.jett.tag.BaseTag

net.sf.jett.tag.PageBreakTag

All Implemented Interfaces:

Tag

public class PageBreakTag
extends BaseTag

A PageBreakTag turns on or turns off whether a column or a row has a page break on it. It must be bodiless.

Attributes:

• Inherits all attributes from BaseTag.
• type (required): String
  • none - Clear any row and column breaks to the right/bottom of this cell.
  • rows - Set a row break and clear any column break to the right/bottom of this cell.
  • cols - Clear a row break and set a column break to the right/bottom of this cell.
  • both - Set a row break and a column break to the right/bottom of this cell.
• display (optional): RichTextString

Since:

0.11.0

Author:

Randy Gettman

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ATTR_DISPLAY	Attribute that specifies the display value of the cell after this tag has been processed, if any.
static java.lang.String	ATTR_TYPE	Attribute that specifies which page breaks to clear and/or set at the bottom and to the right of the current cell.
static java.lang.String	TYPE_BOTH	Attribute value that specifies to set a row break below the current cell and a column break to the right of the current cell.
static java.lang.String	TYPE_COLS	Attribute value that specifies to clear any row break below the current cell and set a column break to the right of the current cell.
static java.lang.String	TYPE_NONE	Attribute value that specifies to clear both any row break below the current cell and any column break to the right of the current cell.
static java.lang.String	TYPE_ROWS	Attribute value that specifies to set a row break below the current cell and clear any column break to the right of the current cell.

Fields inherited from class net.sf.jett.tag.BaseTag

ATTR_ON_PROCESSED, SPEC_SEP

Constructor Summary

Constructors

Constructor	Description
PageBreakTag()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getName()	Returns this Tag's name.
protected java.util.List<java.lang.String>	getOptionalAttributes()	Returns a List of optional attribute names.
protected java.util.List<java.lang.String>	getRequiredAttributes()	Returns a List of required attribute names.
boolean	process()	Sets the given variable name to the given value.
void	validateAttributes()	Validates the attributes for this Tag.

Methods inherited from class net.sf.jett.tag.BaseTag

checkAttributes, clearBlock, deleteBlock, getAttributes, getContext, getLocation, getParentTag, getWorkbookContext, isBodiless, processTag, removeBlock, setAttributes, setBodiless, setContext, setParentTag, setWorkbookContext

Methods inherited from class java.lang.Object

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

Field Detail

ATTR_TYPE

public static final java.lang.String ATTR_TYPE

Attribute that specifies which page breaks to clear and/or set at the bottom and to the right of the current cell.

See Also:

Constant Field Values

ATTR_DISPLAY

public static final java.lang.String ATTR_DISPLAY

Attribute that specifies the display value of the cell after this tag has been processed, if any.

See Also:

Constant Field Values

TYPE_NONE

public static final java.lang.String TYPE_NONE

Attribute value that specifies to clear both any row break below the current cell and any column break to the right of the current cell.

See Also:

Constant Field Values

TYPE_ROWS

public static final java.lang.String TYPE_ROWS

Attribute value that specifies to set a row break below the current cell and clear any column break to the right of the current cell.

See Also:

Constant Field Values

TYPE_COLS

public static final java.lang.String TYPE_COLS

Attribute value that specifies to clear any row break below the current cell and set a column break to the right of the current cell.

See Also:

Constant Field Values

TYPE_BOTH

public static final java.lang.String TYPE_BOTH

Attribute value that specifies to set a row break below the current cell and a column break to the right of the current cell.

See Also:

Constant Field Values

Constructor Detail

PageBreakTag

public PageBreakTag()

Method Detail

getName

public java.lang.String getName()

Returns this Tag's name.

Returns:

This Tag's name.

getRequiredAttributes

protected java.util.List<java.lang.String> getRequiredAttributes()

Returns a List of required attribute names.

Overrides:

getRequiredAttributes in class BaseTag

Returns:

A List of required attribute names.

getOptionalAttributes

protected java.util.List<java.lang.String> getOptionalAttributes()

Returns a List of optional attribute names.

Overrides:

getOptionalAttributes in class BaseTag

Returns:

A List of optional attribute names.

validateAttributes

public void validateAttributes()
                        throws TagParseException

Validates the attributes for this Tag. The "type" attribute must be present.

Overrides:

validateAttributes in class BaseTag

Throws:

TagParseException - If the attribute values are illegal or unacceptable.

process

public boolean process()

Sets the given variable name to the given value.

Specified by:

process in class BaseTag

Returns:

Whether the first Cell in the Block associated with this Tag was processed.