com.webmethods.caf.faces.component.table

Class BaseExtendedColumn

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIColumn

com.webmethods.caf.faces.component.table.BaseExtendedColumn

All Implemented Interfaces:

IExtendedColumn, ITableRowStateHolder, Serializable, EventListener, PartialStateHolder, StateHolder, TransientStateHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder

Direct Known Subclasses:

BaseSelectRow, HiddenColumn, HtmlTableColumn, ScrollbarPager

public class BaseExtendedColumn
extends UIColumn
implements IExtendedColumn, ITableRowStateHolder

Base UIColumn with CAF column extensions.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	BaseExtendedColumn.PropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
protected static Integer	NEGATIVE_ONE
protected static Integer	ZERO

Fields inherited from class javax.faces.component.UIColumn

COMPONENT_FAMILY, COMPONENT_TYPE

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor and Description
BaseExtendedColumn()

Method Summary

Modifier and Type	Method and Description
void	encodeFooter(FacesContext context) Renders this column's header.
void	encodeHeader(FacesContext context) Renders this column's header.
String	getAlign() Horizontal alignment of column content ("left", "center", or "right").
String	getGroup() Display title of column group (for Add/Remove Columns dialog, etc.).
String	getLabel() Display title of column (for Add/Remove Columns dialog, etc.).
int	getOrdinal() Primacy of this column in sorting the table.
protected Object	getPropertyOrBindingValue(String name, Object specifiedValue, Object defaultValue)
int	getSecondaryEnd() Primary column under which this secondary column ends (zero-based, inclusive).
int	getSecondaryStart() Primary column under which this secondary column starts (zero-based, inclusive).
Object	getSort() Sort key for this column.
Object	getTableRowState() Gets this control's per-row state.
String	getValign() Vertical alignment of column content ("top", "middle", or "bottom").
String	getWidth() Fixed width of column in pixels ('100') or percent ('100%').
boolean	isAscending() True to sort column from A-Z or 1-100.
boolean	isExportable() Returns whether the column is exportable
boolean	isHidden() True if column is data column (not displayed).
boolean	isNowrap() True if column should be as wide as widest line in column content.
boolean	isOptional() True if column displayed only after user chooses via Add/Remove Columns dialog.
boolean	isSecondary() True if this column belongs in a sub-row beneath the main row.
void	setAlign(String align) Horizontal alignment of column content ("left", "center", or "right").
void	setAscending(boolean ascending) True to sort column from A-Z or 1-100.
void	setExportable(boolean isExportable) Sets whether the column is exportable
void	setGroup(String group) Display title of column group (for Add/Remove Columns dialog, etc.).
void	setHidden(boolean hidden) True if column is data column (not displayed).
void	setLabel(String label) Display title of column (for Add/Remove Columns dialog, etc.).
void	setNowrap(boolean nowrap) True if column should be as wide as widest line in column content.
void	setOptional(boolean optional) True if column displayed only after user chooses via Add/Remove Columns dialog.
void	setOrdinal(int ordinal) Primacy of this column in sorting the table.
void	setSecondary(boolean secondary) True if this column belongs in a sub-row beneath the main row.
void	setSecondaryEnd(int secondaryEnd) Primary column under which this secondary column ends (zero-based, inclusive).
void	setSecondaryStart(int secondaryStart) Primary column under which this secondary column starts (zero-based, inclusive).
void	setSort(Object sort) Sort key for this column.
void	setTableRowState(Object o) Sets this control's per-row state.
void	setValign(String valign) Vertical alignment of column content ("top", "middle", or "bottom").
void	setWidth(String width) Fixed width of column in pixels ('100') or percent ('100%').

Methods inherited from class javax.faces.component.UIColumn

getFamily, getFooter, getHeader, setFooter, setHeader

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

Methods inherited from class java.lang.Object

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

Field Detail

NEGATIVE_ONE

protected static final Integer NEGATIVE_ONE

ZERO

protected static final Integer ZERO

Constructor Detail

BaseExtendedColumn

public BaseExtendedColumn()

Method Detail

getTableRowState

public Object getTableRowState()

Gets this control's per-row state.

Specified by:

getTableRowState in interface ITableRowStateHolder

setTableRowState

public void setTableRowState(Object o)

Sets this control's per-row state.

Specified by:

setTableRowState in interface ITableRowStateHolder

encodeHeader

public void encodeHeader(FacesContext context)
                  throws IOException

Description copied from interface: IExtendedColumn

Renders this column's header.

Specified by:

encodeHeader in interface IExtendedColumn

Parameters:

context - Current context.

Throws:

IOException

encodeFooter

public void encodeFooter(FacesContext context)
                  throws IOException

Description copied from interface: IExtendedColumn

Renders this column's header.

Specified by:

encodeFooter in interface IExtendedColumn

Parameters:

context - Current context.

Throws:

IOException

getPropertyOrBindingValue

protected Object getPropertyOrBindingValue(String name,
                                           Object specifiedValue,
                                           Object defaultValue)

getAlign

public String getAlign()

Description copied from interface: IExtendedColumn

Horizontal alignment of column content ("left", "center", or "right").

Specified by:

getAlign in interface IExtendedColumn

isAscending

public boolean isAscending()

Description copied from interface: IExtendedColumn

True to sort column from A-Z or 1-100.

Specified by:

isAscending in interface IExtendedColumn

getGroup

public String getGroup()

Description copied from interface: IExtendedColumn

Display title of column group (for Add/Remove Columns dialog, etc.).

Specified by:

getGroup in interface IExtendedColumn

isHidden

public boolean isHidden()

Description copied from interface: IExtendedColumn

True if column is data column (not displayed).

Specified by:

isHidden in interface IExtendedColumn

getLabel

public String getLabel()

Description copied from interface: IExtendedColumn

Display title of column (for Add/Remove Columns dialog, etc.).

Specified by:

getLabel in interface IExtendedColumn

isNowrap

public boolean isNowrap()

Description copied from interface: IExtendedColumn

True if column should be as wide as widest line in column content.

Specified by:

isNowrap in interface IExtendedColumn

isOptional

public boolean isOptional()

Description copied from interface: IExtendedColumn

True if column displayed only after user chooses via Add/Remove Columns dialog.

Specified by:

isOptional in interface IExtendedColumn

getOrdinal

public int getOrdinal()

Description copied from interface: IExtendedColumn

Primacy of this column in sorting the table. 0 = none, 1 = primary, 2 = secondary, etc.

Specified by:

getOrdinal in interface IExtendedColumn

isSecondary

public boolean isSecondary()

Description copied from interface: IExtendedColumn

True if this column belongs in a sub-row beneath the main row.

Specified by:

isSecondary in interface IExtendedColumn

getSecondaryEnd

public int getSecondaryEnd()

Description copied from interface: IExtendedColumn

Primary column under which this secondary column ends (zero-based, inclusive). -1 if not a secondary column.

Specified by:

getSecondaryEnd in interface IExtendedColumn

getSecondaryStart

public int getSecondaryStart()

Description copied from interface: IExtendedColumn

Primary column under which this secondary column starts (zero-based, inclusive). -1 if not a secondary column.

Specified by:

getSecondaryStart in interface IExtendedColumn

getSort

public Object getSort()

Description copied from interface: IExtendedColumn

Sort key for this column.

Specified by:

getSort in interface IExtendedColumn

getValign

public String getValign()

Description copied from interface: IExtendedColumn

Vertical alignment of column content ("top", "middle", or "bottom").

Specified by:

getValign in interface IExtendedColumn

getWidth

public String getWidth()

Description copied from interface: IExtendedColumn

Fixed width of column in pixels ('100') or percent ('100%').

Specified by:

getWidth in interface IExtendedColumn

setAlign

public void setAlign(String align)

Description copied from interface: IExtendedColumn

Horizontal alignment of column content ("left", "center", or "right").

Specified by:

setAlign in interface IExtendedColumn

setAscending

public void setAscending(boolean ascending)

Description copied from interface: IExtendedColumn

True to sort column from A-Z or 1-100.

Specified by:

setAscending in interface IExtendedColumn

setGroup

public void setGroup(String group)

Description copied from interface: IExtendedColumn

Display title of column group (for Add/Remove Columns dialog, etc.).

Specified by:

setGroup in interface IExtendedColumn

setHidden

public void setHidden(boolean hidden)

Description copied from interface: IExtendedColumn

True if column is data column (not displayed).

Specified by:

setHidden in interface IExtendedColumn

setLabel

public void setLabel(String label)

Description copied from interface: IExtendedColumn

Display title of column (for Add/Remove Columns dialog, etc.).

Specified by:

setLabel in interface IExtendedColumn

setNowrap

public void setNowrap(boolean nowrap)

Description copied from interface: IExtendedColumn

True if column should be as wide as widest line in column content.

Specified by:

setNowrap in interface IExtendedColumn

setOptional

public void setOptional(boolean optional)

Description copied from interface: IExtendedColumn

True if column displayed only after user chooses via Add/Remove Columns dialog.

Specified by:

setOptional in interface IExtendedColumn

setOrdinal

public void setOrdinal(int ordinal)

Description copied from interface: IExtendedColumn

Primacy of this column in sorting the table. 0 = none, 1 = primary, 2 = secondary, etc.

Specified by:

setOrdinal in interface IExtendedColumn

setSecondary

public void setSecondary(boolean secondary)

Description copied from interface: IExtendedColumn

True if this column belongs in a sub-row beneath the main row.

Specified by:

setSecondary in interface IExtendedColumn

setSecondaryEnd

public void setSecondaryEnd(int secondaryEnd)

Description copied from interface: IExtendedColumn

Primary column under which this secondary column ends (zero-based, inclusive). -1 if not a secondary column.

Specified by:

setSecondaryEnd in interface IExtendedColumn

setSecondaryStart

public void setSecondaryStart(int secondaryStart)

Description copied from interface: IExtendedColumn

Primary column under which this secondary column starts (zero-based, inclusive). -1 if not a secondary column.

Specified by:

setSecondaryStart in interface IExtendedColumn

setSort

public void setSort(Object sort)

Description copied from interface: IExtendedColumn

Sort key for this column.

Specified by:

setSort in interface IExtendedColumn

setValign

public void setValign(String valign)

Description copied from interface: IExtendedColumn

Vertical alignment of column content ("top", "middle", or "bottom").

Specified by:

setValign in interface IExtendedColumn

setWidth

public void setWidth(String width)

Description copied from interface: IExtendedColumn

Fixed width of column in pixels ('100') or percent ('100%').

Specified by:

setWidth in interface IExtendedColumn

isExportable

public boolean isExportable()

Description copied from interface: IExtendedColumn

Returns whether the column is exportable

Specified by:

isExportable in interface IExtendedColumn

Returns:

true or false

setExportable

public void setExportable(boolean isExportable)

Description copied from interface: IExtendedColumn

Sets whether the column is exportable

Specified by:

setExportable in interface IExtendedColumn

Parameters:

isExportable - true if the column is exportable, false otherwise