Package net.sf.jett.tag

Class GroupTag

java.lang.Object

net.sf.jett.tag.BaseTag

net.sf.jett.tag.GroupTag

All Implemented Interfaces:

Tag

public class GroupTag
extends BaseTag

A GroupTag represents a set of rows or a set of columns that needs an Excel "group" associated with it. Optionally, it may be displayed expanded (default) or collapsed.

Attributes:

• Inherits all attributes from BaseTag.
• groupDir (optional): String
• collapse (optional): boolean

Since:

0.2.0

Author:

Randy Gettman

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ATTR_COLLAPSE	Attribute for specifying whether the group should be displayed collapsed.
static java.lang.String	ATTR_GROUP_DIR	Attribute for specifying the direction of the grouping.
static java.lang.String	GROUP_DIR_COLS	The "group dir" value to specify that columns should be grouped.
static java.lang.String	GROUP_DIR_NONE	The "group dir" value to specify that neither rows nor columns should be grouped.
static java.lang.String	GROUP_DIR_ROWS	The "group dir" value to specify that rows should be grouped.

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

ATTR_ON_PROCESSED, SPEC_SEP

Constructor Summary

Constructors

Constructor	Description
GroupTag()

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()	Create an Excel group of rows or columns around the height or the width of the block.
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_GROUP_DIR

public static final java.lang.String ATTR_GROUP_DIR

Attribute for specifying the direction of the grouping. This defaults to row grouping.

See Also:

GROUP_DIR_ROWS, GROUP_DIR_COLS, GROUP_DIR_NONE, Constant Field Values

ATTR_COLLAPSE

public static final java.lang.String ATTR_COLLAPSE

Attribute for specifying whether the group should be displayed collapsed.

See Also:

Constant Field Values

GROUP_DIR_COLS

public static final java.lang.String GROUP_DIR_COLS

The "group dir" value to specify that columns should be grouped.

See Also:

Constant Field Values

GROUP_DIR_ROWS

public static final java.lang.String GROUP_DIR_ROWS

The "group dir" value to specify that rows should be grouped.

See Also:

Constant Field Values

GROUP_DIR_NONE

public static final java.lang.String GROUP_DIR_NONE

The "group dir" value to specify that neither rows nor columns should be grouped.

See Also:

Constant Field Values

Constructor Detail

GroupTag

public GroupTag()

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. This tag must have a body.

Overrides:

validateAttributes in class BaseTag

Throws:

TagParseException - If the attribute values are illegal or unacceptable.

process

public boolean process()

Create an Excel group of rows or columns around the height or the width of the block.

Specified by:

process in class BaseTag

Returns:

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