Package net.sf.jett.tag

Class BaseHideTag

java.lang.Object

net.sf.jett.tag.BaseTag

net.sf.jett.tag.BaseHideTag

All Implemented Interfaces:

Tag

Direct Known Subclasses:

HideColsTag, HideRowsTag, HideSheetTag

public abstract class BaseHideTag
extends BaseTag

A BaseHideTag represents something that can be hidden conditionally.

Attributes:

• Inherits all attributes from BaseTag.
• test (required): boolean

Since:

0.9.1

Author:

Randy Gettman

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ATTR_TEST	Attribute for specifying whether to hide what is to be hidden.

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

ATTR_ON_PROCESSED, SPEC_SEP

Constructor Summary

Constructors

Constructor	Description
BaseHideTag()

Method Summary

Modifier and Type	Method	Description
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()	If the condition is met, hide something in the workbook.
abstract void	setHidden(boolean hide)	This method is called if the condition is true, to hide something in the workbook.
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

Methods inherited from interface net.sf.jett.tag.Tag

getName

Field Detail

ATTR_TEST

public static final java.lang.String ATTR_TEST

Attribute for specifying whether to hide what is to be hidden.

See Also:

Constant Field Values

Constructor Detail

BaseHideTag

public BaseHideTag()

Method Detail

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()

If the condition is met, hide something in the workbook.

Specified by:

process in class BaseTag

Returns:

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

setHidden

public abstract void setHidden(boolean hide)

This method is called if the condition is true, to hide something in the workbook.

Parameters:

hide - Whether to hide or show.