com.sas.taglib.servlet.tbeans.tableview
Class BaseCellRendererTag

com.sas.taglib.servlet.tbeans.tableview.BaseCellRendererTag

All Implemented Interfaces:

java.io.Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag, javax.servlet.jsp.tagext.TryCatchFinally

Direct Known Subclasses:

CellEditorTag, CellRendererTag, ColumnHeaderRendererTag, RowHeaderRendererTag

public abstract class BaseCellRendererTag

The base object for all the CellRenderer, ColumnHeaderRenderer tag support handlers in the SAS Custom Tag Library.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.sas.taglib.BaseBodyTag

DELIMITERS, RB_KEY

Constructor Summary

BaseCellRendererTag()

Method Summary

protected void	applyAttributes() Apply BaseCellRenderer properties to the underlying com.sas.servlet.tbeans.tableview.html.BaseTableCell object
java.lang.String	getBgColor() Deprecated. The StyleInfo tag is now the preferred manner to change colors and other styles on cell renderers.
int	getColSpan() Returns the colSpan property of the BaseCellRendererTag.
java.lang.String	getCustomAttributes() Returns the customAttributes property of the BaseCellRendererTag.
java.lang.String	getHeaders() Returns the headers property of the BaseCellRendererTag.
int	getHeight() Returns the height property of the BaseCellRendererTag.
int	getHeightPercentage() Returns the heightPercentage property of the BaseCellRendererTag.
java.lang.String	getHorizontalAlignment() Returns the horizontalAlignment property of the BaseCellRendererTag.
int	getRowSpan() Returns the rowSpan property of the BaseCellRendererTag.
java.lang.String	getStyleClassPrefix() Returns the styleClassPrefix property of the BaseCellRendererTag.
java.lang.String	getVerticalAlignment() Returns the verticalAlignment property of the BaseCellRendererTag.
int	getWidth() Returns the width property of the BaseCellRendererTag.
int	getWidthPercentage() Returns the widthPercentage property of the BaseCellRendererTag.
protected void	initialize(boolean includeAttributes) Initializes attributes and variables for this tag handler.
boolean	isNoWrap() Returns the noWrap property of the BaseCellRendererTag.
void	setBgColor(java.lang.String color) Deprecated. The StyleInfo tag is now the preferred manner to change colors and other styles on cell renderers.
void	setColSpan(int colSpan) Sets the colSpan property of the BaseCellRendererTag.
void	setCustomAttributes(java.lang.String customAttributes) Sets the customAttributes property of the BaseCellRendererTag.
void	setHeaders(java.lang.String headers) Sets the headers property of the BaseCellRendererTag.
void	setHeight(int height) Sets the height property of the BaseCellRendererTag.
void	setHeightPercentage(int heightPercentage) Sets the heightPercentage property of the BaseCellRendererTag.
void	setHorizontalAlignment(java.lang.String horizontalAlignment) Sets the horizontalAlignment property of the BaseCellRendererTag.
void	setNoWrap(boolean noWrap) Sets the noWrap property of the BaseCellRendererTag.
void	setRowSpan(int rowSpan) Sets the rowSpan property of the BaseCellRendererTag.
void	setStyleClassPrefix(java.lang.String styleClassPrefix) Sets the styleClassPrefix property of the BaseCellRendererTag.
void	setVerticalAlignment(java.lang.String verticalAlignment) Sets the verticalAlignment property of the BaseCellRendererTag.
void	setWidth(int width) Sets the width property of the BaseCellRendererTag.
void	setWidthPercentage(int widthPercentage) Sets the widthPercentage property of the BaseCellRendererTag.

Methods inherited from class com.sas.taglib.BaseBodyTag

doCatch, doFinally, doStartTag, getApplyAttributes, getBodyStrings, getCompositeComponentKey, getInstantiate, getLocale, getPageContext, getRef, getScope, getTagScope, getWrappedClassName, getWrappedObject, getWrappedObject, loadBeanInstance, newInstance, release, removeFromScope, searchContext, setApplyAttributes, setCompositeComponentKey, setInstantiate, setLocale, setRef, setScope, setTagScope, setVariableWithinScope, setWrappedClassName, setWrappedObject, validate

Constructor Detail

BaseCellRendererTag

public BaseCellRendererTag()

Method Detail

initialize

protected void initialize(boolean includeAttributes)

Initializes attributes and variables for this tag handler.

Overrides:

initialize in class BaseBodyTag

Parameters:

includeAttributes - Set to true if attributes are to be set to default values.

setBgColor

public void setBgColor(java.lang.String color)

Deprecated. The StyleInfo tag is now the preferred manner to change colors and other styles on cell renderers.

Sets the bgColor property of the BaseCellRendererTag.

Parameters:

bgColor - The background color for this cell. The StyleInfo tag is now the preferred manner to change colors and other styles on cell renderers.

See Also:

getBgColor()

getBgColor

public java.lang.String getBgColor()

Deprecated. The StyleInfo tag is now the preferred manner to change colors and other styles on cell renderers.

Returns the bgColor property of the BaseCellRendererTag.

Returns:

the background color for this cell

See Also:

setBgColor(java.lang.String)

setColSpan

public void setColSpan(int colSpan)

Sets the colSpan property of the BaseCellRendererTag.

Parameters:

colSpan - The number of columns for this cell to span.

See Also:

getColSpan()

getColSpan

public int getColSpan()

Returns the colSpan property of the BaseCellRendererTag.

Returns:

the number of columns for this cell to span

See Also:

setColSpan(int)

setHeaders

public void setHeaders(java.lang.String headers)

Sets the headers property of the BaseCellRendererTag.

Parameters:

headers - Specifies the list of header cells that provide header information for the current data cell. The value of this attribute is a space-separated string of cell names. Those cells must be named by setting their id attribute.

See Also:

getHeaders()

getHeaders

public java.lang.String getHeaders()

Returns the headers property of the BaseCellRendererTag.

Returns:

the String that specifies the list of header cells that provide header information for the current data cell

See Also:

setHeaders(java.lang.String)

setHeight

public void setHeight(int height)

Sets the height property of the BaseCellRendererTag.

Parameters:

height - The height of the cell in pixels.

See Also:

getHeight()

getHeight

public int getHeight()

Returns the height property of the BaseCellRendererTag.

Returns:

the height of the cell in pixels

See Also:

setHeight(int)

setHeightPercentage

public void setHeightPercentage(int heightPercentage)

Sets the heightPercentage property of the BaseCellRendererTag.

Parameters:

heightPercentage - The height of the cell as a percentage.

See Also:

getHeightPercentage()

getHeightPercentage

public int getHeightPercentage()

Returns the heightPercentage property of the BaseCellRendererTag.

Returns:

the height of the cell as a percentage

See Also:

setHeightPercentage(int)

setHorizontalAlignment

public void setHorizontalAlignment(java.lang.String horizontalAlignment)

Sets the horizontalAlignment property of the BaseCellRendererTag.

Parameters:

horizontalAlignment - The horizontal alignment of the cell. Valid values are: LEFT, CENTER, RIGHT, JUSTIFY, CHAR or NONE. The default is NONE (i.e. the browser default).

See Also:

getHorizontalAlignment()

getHorizontalAlignment

public java.lang.String getHorizontalAlignment()

Returns the horizontalAlignment property of the BaseCellRendererTag.

Returns:

the horizontal alignment of the cell

See Also:

setHorizontalAlignment(java.lang.String)

setRowSpan

public void setRowSpan(int rowSpan)

Sets the rowSpan property of the BaseCellRendererTag.

Parameters:

rowSpan - The number of rows for this cell to span.

See Also:

getRowSpan()

getRowSpan

public int getRowSpan()

Returns the rowSpan property of the BaseCellRendererTag.

Returns:

the number of rows for the cell to span

See Also:

setRowSpan(int)

setStyleClassPrefix

public void setStyleClassPrefix(java.lang.String styleClassPrefix)

Sets the styleClassPrefix property of the BaseCellRendererTag.

Parameters:

styleClassPrefix - The string to prepend to the styleClass property.

See Also:

getStyleClassPrefix()

getStyleClassPrefix

public java.lang.String getStyleClassPrefix()

Returns the styleClassPrefix property of the BaseCellRendererTag.

Returns:

the String to prepend to the styleClass property

See Also:

setStyleClassPrefix(java.lang.String)

setVerticalAlignment

public void setVerticalAlignment(java.lang.String verticalAlignment)

Sets the verticalAlignment property of the BaseCellRendererTag.

Parameters:

verticalAlignment - The vertical alignment of the cell. Valid values are: TOP, CENTER, BOTTOM, BASELINE or NONE. The default is NONE (i.e. the browser default).

See Also:

getVerticalAlignment()

getVerticalAlignment

public java.lang.String getVerticalAlignment()

Returns the verticalAlignment property of the BaseCellRendererTag.

Returns:

the vertical alignment of the cell

See Also:

setVerticalAlignment(java.lang.String)

setWidth

public void setWidth(int width)

Sets the width property of the BaseCellRendererTag.

Parameters:

width - The width of the cell in pixels.

See Also:

getWidth()

getWidth

public int getWidth()

Returns the width property of the BaseCellRendererTag.

Returns:

the width of the cell in pixels

See Also:

setWidth(int)

setWidthPercentage

public void setWidthPercentage(int widthPercentage)

Sets the widthPercentage property of the BaseCellRendererTag.

Parameters:

widthPercentage - The width of the cell as a percentage.

See Also:

getWidthPercentage()

getWidthPercentage

public int getWidthPercentage()

Returns the widthPercentage property of the BaseCellRendererTag.

Returns:

the width of the cell as a percentage

See Also:

setWidthPercentage(int)

setNoWrap

public void setNoWrap(boolean noWrap)

Sets the noWrap property of the BaseCellRendererTag.

Parameters:

noWrap - If true, then automatic text wrapping is disabled. If used carelessly, this attribute may result in excessively wide cells.

See Also:

isNoWrap()

isNoWrap

public boolean isNoWrap()

Returns the noWrap property of the BaseCellRendererTag.

Returns:

true is automatic text wrapping for the cell is disabled

See Also:

setNoWrap(boolean)

setCustomAttributes

public void setCustomAttributes(java.lang.String customAttributes)

Sets the customAttributes property of the BaseCellRendererTag.

Parameters:

customAttributes - A list of attributes in the form of attribute="value", space delimited

See Also:

getCustomAttributes()

getCustomAttributes

public java.lang.String getCustomAttributes()

Returns the customAttributes property of the BaseCellRendererTag.

Returns:

String A list of attributes in the form of attribute="value", space delimited

See Also:

setCustomAttributes(java.lang.String)

applyAttributes

protected void applyAttributes()
                        throws javax.servlet.jsp.JspException

Apply BaseCellRenderer properties to the underlying com.sas.servlet.tbeans.tableview.html.BaseTableCell object

Overrides:

applyAttributes in class BaseBodyTag

Throws:

javax.servlet.jsp.JspException - Thrown if a JspException occurs.