Skip navigation links

oracle.adf.view.rich.component.rich.data
Class RichColumn

java.lang.Object
javax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
org.apache.myfaces.trinidad.component.UIXColumn
oracle.adf.view.rich.component.rich.data.RichColumn

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

public class RichColumn

extends org.apache.myfaces.trinidad.component.UIXColumn

implements javax.faces.component.behavior.ClientBehaviorHolder

The immediate children of a Table component must all be <af:column> components. Each visible Column component creates a separate column in the Table.

Use "headerText" attribute or the "header" facet on a Column to create the column header. The following example creates a two-column table with the column headers - "Firstname" and "Lastname":

   <af:table>
     <af:column>
       <f:facet name="header">
         <af:outputText value="Firstname"/>
       </f:facet>
       ...
     </af:column>
     <af:column>
       <f:facet name="header">
         <af:outputText value="Lastname"/>
       </f:facet>
       ...
     </af:column>
   </af:table>
           

The child components of each Column display the data for each row in that column. The Column does not create child components per row; instead, each child is repeatedly rendered (stamped) once per row. Because of this stamping behavior, only certain types of components are supported as children inside a Column. Supported components include all components with no behavior and most components that implement the EditableValueHolder or ActionSource interfaces.

As each row is stamped, the data for the current row ( see getRowData() on the Table) is copied into an EL reachable property. The name of this property is defined by the var property on the Table. Once the Table has completed rendering, this property is removed (or reverted back to its previous value). In the following example, the data for each row is placed under the EL property "row". Each Column displays the data for each row by getting further properties from the "row" property:

   <af:table var="row" value="#{myBean.employees}">
     <af:column>
       <af:outputText value="#{row.firstname}"/>
     </af:column>
     <af:column>
       <af:outputText value="#{row.lastname}"/>
     </af:column>
   </af:table>
           

shortDesc attribute is currently not supported for the <af:column> component. Tooltips are automatically displayed for header and data cells if noWrap is turned off and data in the cell is truncated.

<section name="Sorting">

In order to make a Column sortable, set the "sortable" property to true and set "sortProperty" to the name of the model that this column will sort. Sorting can be programatically turned on with the setSortCritiera() method on the table.

</section> <section name="Column_Group">

<af:column> tags can be nested to produce groups of columns. The header of a column group spans across all the columns it contains. The following example creates a column group that has the header "Name" and contains two sub columns with headers "First" and "Last":

   <af:table var="row" value="#{myBean.employees}">
     <af:column headerText="Name">
       <af:column headerText="First">
         <af:outputText value="#{row.firstname}"/>
       </af:column>
       <af:column headerText="Last">
         <af:outputText value="#{row.lastname}"/>
       </af:column>
     </af:column>
   </af:table>
           

</section> <section name="Styling">

The data cells in the table rendered by<af:column> tags can be styled by using styleClass and inlineStyle attributes. The column header cells can be styled using headerClass attribute. Please note that changing padding and border settings through these attributes is very dangerous. We calculate widths on the server side and expect padding and border attributes to be specified as skinning properties. If they get overridden, the aligment of the table cells might be messed up.

</section> <section name="Geometry_Management"> <html:ul> <html:li>This component can only be placed in a tree or treeTable and the dimensions of a column are controlled by either the columnStretching attribute of that parent component or by the width and minimumWidth attributes of the column.</html:li> <html:li>This component does not have support for stretching its children.</html:li> </html:ul> </section>

Events:

Type	Phases	Description
org.apache.myfaces.trinidad.event.AttributeChangeEvent	Invoke Application Apply Request Values	Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change event might include the width of a column that supported client-side resizing.

Field Summary

static java.lang.String	ALIGN_CENTER
static java.lang.String	ALIGN_END
static org.apache.myfaces.trinidad.bean.PropertyKey	ALIGN_KEY
static java.lang.String	ALIGN_LEFT
static java.lang.String	ALIGN_RIGHT
static java.lang.String	ALIGN_START
static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_ATTRIBUTES_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_COMPONENT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_LISTENERS_KEY
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	CONTEXT_FACET
static org.apache.myfaces.trinidad.bean.PropertyKey	CUSTOMIZATION_ID_KEY Deprecated.
static org.apache.myfaces.trinidad.bean.PropertyKey	DISPLAY_INDEX_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	DONT_PERSIST_KEY
static java.lang.String	FILTER_FACET
static org.apache.myfaces.trinidad.bean.PropertyKey	FILTER_FEATURES_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	FILTERABLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	FOOTER_CLASS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	FROZEN_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	HEADER_CLASS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	HEADER_NO_WRAP_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	HEADER_TEXT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	HELP_TOPIC_ID_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	INLINE_STYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	MINIMUM_WIDTH_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	NO_WRAP_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PARTIAL_TRIGGERS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PERSIST_KEY
static java.lang.String	ROW_HEADER_FALSE
static org.apache.myfaces.trinidad.bean.PropertyKey	ROW_HEADER_KEY
static java.lang.String	ROW_HEADER_TRUE
static java.lang.String	ROW_HEADER_UNSTYLED
static org.apache.myfaces.trinidad.bean.PropertyKey	SELECTED_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SEPARATE_ROWS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHORT_DESC_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHOW_REQUIRED_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SORTABLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	STYLE_CLASS_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	VISIBLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	WIDTH_KEY

Fields inherited from class org.apache.myfaces.trinidad.component.UIXColumn

FOOTER_FACET, HEADER_FACET, SORT_PROPERTY_KEY

Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Fields inherited from class javax.faces.component.UIComponent

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

Constructor Summary

	RichColumn() Construct an instance of the RichColumn.
protected	RichColumn(java.lang.String rendererType) Construct an instance of the RichColumn.

Method Summary

void	addClientBehavior(java.lang.String eventName, javax.faces.component.behavior.ClientBehavior behavior)
java.lang.String	getAlign() Gets The alignment for this column.
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.util.Set	getClientAttributes() Gets a set of client attribute names.
java.util.Map<java.lang.String,java.util.List<javax.faces.component.behavior.ClientBehavior>>	getClientBehaviors()
ClientListenerSet	getClientListeners() Gets a set of client listeners.
javax.faces.component.UIComponent	getContext() Location for contextual information.
java.lang.String	getCustomizationId() Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
java.lang.String	getDefaultEventName()
int	getDisplayIndex() Gets The display order index of the column.
java.lang.String[]	getDontPersist() Gets a list of attributes whose changes are NOT to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml.
java.util.Collection<java.lang.String>	getEventNames()
java.lang.String	getFamily()
javax.faces.component.UIComponent	getFilter() the node to use to render this column's filter.
java.util.Set	getFilterFeatures() Gets The filter features for this column.
java.lang.String	getFooterClass() Gets a CSS style class to use for the column footer.
java.lang.String	getHeaderClass() Gets a CSS style class to use for the column header.
java.lang.String	getHeaderText() Gets text to display in the header of the column.
java.lang.String	getHelpTopicId() Gets Id used to look up a topic in a helpProvider.
java.lang.String	getInlineStyle() Gets the CSS styles to use for this component.
java.lang.String	getMinimumWidth() Gets The minimum number of pixels that the column can become.
java.lang.String[]	getPartialTriggers() Gets the IDs of the components that should trigger a partial update.
java.lang.String[]	getPersist() Gets a list of attributes whose changes are to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml.
java.lang.String	getRowHeader() Gets Whether or not this column is considered a row header column for the table.
java.lang.String	getShortDesc() Gets This will display a small popup on the screen.
java.lang.String	getStyleClass() Gets a CSS style class to use for this component.
java.lang.String	getWidth() Gets The width of the column.
boolean	isClientComponent() Gets whether a client-side component will be generated.
boolean	isFilterable() Gets whether or not the column is filterable.
boolean	isFrozen() Gets Specifies whether the column is frozen.
boolean	isHeaderNoWrap() Gets whether or not the column header should be allowed to wrap
boolean	isNoWrap() Gets Specifies whether whitespace wrapping should be allowed in this column.
boolean	isRowHeader() Gets Whether or not this column is a row header column.
boolean	isSelected() Gets Specifies whether the column is selected.
boolean	isSeparateRows() Gets This property is currently not supported in the rich client.
boolean	isShowRequired() Gets Indicates whether the columns displays a visual indication of required user input.
boolean	isSortable() Gets whether or not the column is sortable.
boolean	isVisible() Gets the visibility of the column.
void	processDecodes(javax.faces.context.FacesContext context) Overridden to skip processing of hidden columns
void	processUpdates(javax.faces.context.FacesContext context) Overridden to skip processing of hidden columns
void	processValidators(javax.faces.context.FacesContext context) Overridden to skip processing of hidden columns
void	setAlign(java.lang.String align) Sets The alignment for this column.
void	setClientAttributes(java.util.Set clientAttributes) Sets a set of client attribute names.
void	setClientComponent(boolean clientComponent) Sets whether a client-side component will be generated.
void	setClientListeners(ClientListenerSet clientListeners) Sets a set of client listeners.
void	setContext(javax.faces.component.UIComponent contextFacet) Location for contextual information.
void	setCustomizationId(java.lang.String customizationId) Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
void	setDisplayIndex(int displayIndex) Sets The display order index of the column.
void	setDontPersist(java.lang.String[] dontPersist) Sets a list of attributes whose changes are NOT to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml.
void	setFilter(javax.faces.component.UIComponent filterFacet) the node to use to render this column's filter.
void	setFilterable(boolean filterable) Sets whether or not the column is filterable.
void	setFilterFeatures(java.util.Set filterFeatures) Sets The filter features for this column.
void	setFooterClass(java.lang.String footerClass) Sets a CSS style class to use for the column footer.
void	setFrozen(boolean frozen) Sets Specifies whether the column is frozen.
void	setHeaderClass(java.lang.String headerClass) Sets a CSS style class to use for the column header.
void	setHeaderNoWrap(boolean headerNoWrap) Sets whether or not the column header should be allowed to wrap
void	setHeaderText(java.lang.String headerText) Sets text to display in the header of the column.
void	setHelpTopicId(java.lang.String helpTopicId) Sets Id used to look up a topic in a helpProvider.
void	setInlineStyle(java.lang.String inlineStyle) Sets the CSS styles to use for this component.
void	setMinimumWidth(java.lang.String minimumWidth) Sets The minimum number of pixels that the column can become.
void	setNoWrap(boolean noWrap) Sets Specifies whether whitespace wrapping should be allowed in this column.
void	setPartialTriggers(java.lang.String[] partialTriggers) Sets the IDs of the components that should trigger a partial update.
void	setPersist(java.lang.String[] persist) Sets a list of attributes whose changes are to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml.
void	setRowHeader(boolean rowHeader) Sets Whether or not this column is a row header column.
void	setRowHeader(java.lang.String rowHeader) Sets Whether or not this column is considered a row header column for the table.
void	setSelected(boolean selected) Sets Specifies whether the column is selected.
void	setSeparateRows(boolean separateRows) Sets This property is currently not supported in the rich client.
void	setShortDesc(java.lang.String shortDesc) Sets This will display a small popup on the screen.
void	setShowRequired(boolean showRequired) Sets Indicates whether the columns displays a visual indication of required user input.
void	setSortable(boolean sortable) Sets whether or not the column is sortable.
void	setStyleClass(java.lang.String styleClass) Sets a CSS style class to use for this component.
void	setVisible(boolean visible) Sets the visibility of the column.
void	setWidth(java.lang.String width) Sets The width of the column.

Methods inherited from class org.apache.myfaces.trinidad.component.UIXColumn

getFooter, getHeader, getSortProperty, setFooter, setHeader, setPartialTarget, setSortProperty

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, clearInitialState, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, queueEvent, removeAttributeChangeListener, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, subscribeToEvent, toString, unsubscribeFromEvent, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent

addPartialTarget, clearCachedClientIds, clearCachedClientIds, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setupChildrenEncodingContext, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, setupVisitingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitAllChildren, visitChildren, visitChildren, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, setInView

Methods inherited from class java.lang.Object

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

Field Detail

ALIGN_START

public static final java.lang.String ALIGN_START

See Also:

Constant Field Values

ALIGN_END

public static final java.lang.String ALIGN_END

See Also:

Constant Field Values

ALIGN_CENTER

public static final java.lang.String ALIGN_CENTER

See Also:

Constant Field Values

ALIGN_LEFT

public static final java.lang.String ALIGN_LEFT

See Also:

Constant Field Values

ALIGN_RIGHT

public static final java.lang.String ALIGN_RIGHT

See Also:

Constant Field Values

ROW_HEADER_TRUE

public static final java.lang.String ROW_HEADER_TRUE

See Also:

Constant Field Values

ROW_HEADER_FALSE

public static final java.lang.String ROW_HEADER_FALSE

See Also:

Constant Field Values

ROW_HEADER_UNSTYLED

public static final java.lang.String ROW_HEADER_UNSTYLED

See Also:

Constant Field Values

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

INLINE_STYLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY

STYLE_CLASS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY

SHORT_DESC_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY

CUSTOMIZATION_ID_KEY

@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY

Deprecated.

CLIENT_COMPONENT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY

CLIENT_ATTRIBUTES_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY

PARTIAL_TRIGGERS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY

CLIENT_LISTENERS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY

PERSIST_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey PERSIST_KEY

DONT_PERSIST_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey DONT_PERSIST_KEY

ALIGN_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey ALIGN_KEY

FILTER_FEATURES_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey FILTER_FEATURES_KEY

HEADER_CLASS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey HEADER_CLASS_KEY

FOOTER_CLASS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey FOOTER_CLASS_KEY

WIDTH_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey WIDTH_KEY

MINIMUM_WIDTH_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey MINIMUM_WIDTH_KEY

HEADER_TEXT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey HEADER_TEXT_KEY

NO_WRAP_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey NO_WRAP_KEY

HEADER_NO_WRAP_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey HEADER_NO_WRAP_KEY

SORTABLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SORTABLE_KEY

FILTERABLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey FILTERABLE_KEY

SEPARATE_ROWS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SEPARATE_ROWS_KEY

ROW_HEADER_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey ROW_HEADER_KEY

SELECTED_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SELECTED_KEY

DISPLAY_INDEX_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey DISPLAY_INDEX_KEY

FROZEN_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey FROZEN_KEY

HELP_TOPIC_ID_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey HELP_TOPIC_ID_KEY

SHOW_REQUIRED_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHOW_REQUIRED_KEY

VISIBLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY

CONTEXT_FACET

public static final java.lang.String CONTEXT_FACET

See Also:

Constant Field Values

FILTER_FACET

public static final java.lang.String FILTER_FACET

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

RichColumn

public RichColumn()

Construct an instance of the RichColumn.

RichColumn

protected RichColumn(java.lang.String rendererType)

Construct an instance of the RichColumn.

Method Detail

isRowHeader

public final boolean isRowHeader()

Gets Whether or not this column is a row header column.

Returns:

the new rowHeader value

setRowHeader

public final void setRowHeader(boolean rowHeader)

Sets Whether or not this column is a row header column.

Parameters:

rowHeader - the new rowHeader value

processDecodes

public void processDecodes(javax.faces.context.FacesContext context)

Overridden to skip processing of hidden columns

Overrides:

processDecodes in class org.apache.myfaces.trinidad.component.UIXColumn

processUpdates

public void processUpdates(javax.faces.context.FacesContext context)

Overridden to skip processing of hidden columns

Overrides:

processUpdates in class org.apache.myfaces.trinidad.component.UIXColumn

processValidators

public void processValidators(javax.faces.context.FacesContext context)

Overridden to skip processing of hidden columns

Overrides:

processValidators in class org.apache.myfaces.trinidad.component.UIXColumn

getContext

public final javax.faces.component.UIComponent getContext()

Location for contextual information. A contextInfo component is expected. This facet is stamped in each cell of the column.

setContext

public final void setContext(javax.faces.component.UIComponent contextFacet)

Location for contextual information. A contextInfo component is expected. This facet is stamped in each cell of the column.

getFilter

public final javax.faces.component.UIComponent getFilter()

the node to use to render this column's filter. In most cases application developers will be able to use the filterable="true" and "sortProperty" attributes along with "filterModel" to automatically get the filter support through "inputText" components. However if an application developer wants to support a component other than "inputText", they can use the "filter" facet in addition to setting filterable="true" attribute. When doing this, the application developer should also set the alternate filter's label attribute with a helpful label for accessibility mode compatability. For example, for a filter facet set to an inputDate component representing an employee's join date, you could set the inputDate label="Filter: Join Date". Requirements for filtering based on dates can be met through this facet. A property "filterCriteria" will be available on the table "varStatus" attribute when the filter facet is processed. This property will return a map of filter-property/filterCriteria (name/value pairs). Components inside the filter facet can be bound to this attribute to access the filter criteria.

setFilter

public final void setFilter(javax.faces.component.UIComponent filterFacet)

the node to use to render this column's filter. In most cases application developers will be able to use the filterable="true" and "sortProperty" attributes along with "filterModel" to automatically get the filter support through "inputText" components. However if an application developer wants to support a component other than "inputText", they can use the "filter" facet in addition to setting filterable="true" attribute. When doing this, the application developer should also set the alternate filter's label attribute with a helpful label for accessibility mode compatability. For example, for a filter facet set to an inputDate component representing an employee's join date, you could set the inputDate label="Filter: Join Date". Requirements for filtering based on dates can be met through this facet. A property "filterCriteria" will be available on the table "varStatus" attribute when the filter facet is processed. This property will return a map of filter-property/filterCriteria (name/value pairs). Components inside the filter facet can be bound to this attribute to access the filter criteria.

getInlineStyle

public final java.lang.String getInlineStyle()

Gets the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. Be aware that because of browser CSS precedence rules, CSS rendered on a DOM element takes precedence over external stylesheets like the skin file. Therefore skins will not be able to override what you set on this attribute. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.

Returns:

the new inlineStyle value

setInlineStyle

public final void setInlineStyle(java.lang.String inlineStyle)

Sets the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. Be aware that because of browser CSS precedence rules, CSS rendered on a DOM element takes precedence over external stylesheets like the skin file. Therefore skins will not be able to override what you set on this attribute. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.

Parameters:

inlineStyle - the new inlineStyle value

getStyleClass

public final java.lang.String getStyleClass()

Gets a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.

Returns:

the new styleClass value

setStyleClass

public final void setStyleClass(java.lang.String styleClass)

Sets a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.

Parameters:

styleClass - the new styleClass value

getShortDesc

public final java.lang.String getShortDesc()

Gets This will display a small popup on the screen. Use the helpTopicId instead of this field.

Returns:

the new shortDesc value

setShortDesc

public final void setShortDesc(java.lang.String shortDesc)

Sets This will display a small popup on the screen. Use the helpTopicId instead of this field.

Parameters:

shortDesc - the new shortDesc value

getCustomizationId

@Deprecated
public final java.lang.String getCustomizationId()

Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.

Gets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.

Returns:

the new customizationId value

setCustomizationId

@Deprecated
public final void setCustomizationId(java.lang.String customizationId)

Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.

Sets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.

Parameters:

customizationId - the new customizationId value

isClientComponent

public final boolean isClientComponent()

Gets whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary.

Returns:

the new clientComponent value

setClientComponent

public final void setClientComponent(boolean clientComponent)

Sets whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary.

Parameters:

clientComponent - the new clientComponent value

getClientAttributes

public final java.util.Set getClientAttributes()

Gets a set of client attribute names.

Returns:

the new clientAttributes value

setClientAttributes

public final void setClientAttributes(java.util.Set clientAttributes)

Sets a set of client attribute names.

Parameters:

clientAttributes - the new clientAttributes value

getPartialTriggers

public final java.lang.String[] getPartialTriggers()

Gets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.

Returns:

the new partialTriggers value

setPartialTriggers

public final void setPartialTriggers(java.lang.String[] partialTriggers)

Sets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.

Parameters:

partialTriggers - the new partialTriggers value

getClientListeners

public final ClientListenerSet getClientListeners()

Gets a set of client listeners.

Returns:

the new clientListeners value

setClientListeners

public final void setClientListeners(ClientListenerSet clientListeners)

Sets a set of client listeners.

Parameters:

clientListeners - the new clientListeners value

getPersist

public final java.lang.String[] getPersist()

Gets a list of attributes whose changes are to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. The token 'ALL' can be used in the list here to indicate that all attribute changes that the component implicitly persists should be included.

Returns:

the new persist value

setPersist

public final void setPersist(java.lang.String[] persist)

Sets a list of attributes whose changes are to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. The token 'ALL' can be used in the list here to indicate that all attribute changes that the component implicitly persists should be included.

Parameters:

persist - the new persist value

getDontPersist

public final java.lang.String[] getDontPersist()

Gets a list of attributes whose changes are NOT to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. The token 'ALL' can be used in the list here to indicate that all attribute changes that the component implicitly persists should be excluded. If there is a conflict of values, "dontPersist" always precedes "persist".

Returns:

the new dontPersist value

setDontPersist

public final void setDontPersist(java.lang.String[] dontPersist)

Sets a list of attributes whose changes are NOT to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. The token 'ALL' can be used in the list here to indicate that all attribute changes that the component implicitly persists should be excluded. If there is a conflict of values, "dontPersist" always precedes "persist".

Parameters:

dontPersist - the new dontPersist value

getAlign

public final java.lang.String getAlign()

Gets The alignment for this column. "start", "end" and "center" are used for left-justified, right-justified, and center-justified respectively in LTR display. "left" or "right" can be used when left-justified or right-justified cells are needed irrespective of the LTR or RTL display. The default value is null, which implies that it is skin dependent and may vary for the row header column vs data column.

Returns:

the new align value

setAlign

public final void setAlign(java.lang.String align)

Sets The alignment for this column. "start", "end" and "center" are used for left-justified, right-justified, and center-justified respectively in LTR display. "left" or "right" can be used when left-justified or right-justified cells are needed irrespective of the LTR or RTL display. The default value is null, which implies that it is skin dependent and may vary for the row header column vs data column.

Parameters:

align - the new align value

getFilterFeatures

public final java.util.Set getFilterFeatures()

Gets The filter features for this column. A set of flags which specify how this column should be filtered in query-by-example (QBE). Currently the only values supported are: "caseSensitive" and "caseInsensitive". If not specified, the case sensitivity is model-dependent. The features are hints for a collection model, which supports filtering, to perform special filtering operations (such as case-sensitive/insensitive filtering)

Returns:

the new filterFeatures value

setFilterFeatures

public final void setFilterFeatures(java.util.Set filterFeatures)

Sets The filter features for this column. A set of flags which specify how this column should be filtered in query-by-example (QBE). Currently the only values supported are: "caseSensitive" and "caseInsensitive". If not specified, the case sensitivity is model-dependent. The features are hints for a collection model, which supports filtering, to perform special filtering operations (such as case-sensitive/insensitive filtering)

Parameters:

filterFeatures - the new filterFeatures value

getHeaderClass

public final java.lang.String getHeaderClass()

Gets a CSS style class to use for the column header. The headerClass, footerClass and the styleClass attributes on the column should be used with caution. Changing the horizontal padding/borders of the header, footer and data cells will mess up alignment of the table cells.

Returns:

the new headerClass value

setHeaderClass

public final void setHeaderClass(java.lang.String headerClass)

Sets a CSS style class to use for the column header. The headerClass, footerClass and the styleClass attributes on the column should be used with caution. Changing the horizontal padding/borders of the header, footer and data cells will mess up alignment of the table cells.

Parameters:

headerClass - the new headerClass value

getFooterClass

public final java.lang.String getFooterClass()

Gets a CSS style class to use for the column footer. The headerClass, footerClass and the styleClass attributes on the column should be used with caution. Changing the horizontal padding/borders of the header, footer and data cells will mess up alignment of the table cells.

Returns:

the new footerClass value

setFooterClass

public final void setFooterClass(java.lang.String footerClass)

Sets a CSS style class to use for the column footer. The headerClass, footerClass and the styleClass attributes on the column should be used with caution. Changing the horizontal padding/borders of the header, footer and data cells will mess up alignment of the table cells.

Parameters:

footerClass - the new footerClass value

getWidth

public final java.lang.String getWidth()

Gets The width of the column. The default width for a column is 100px. There is no auto sizing for columns. Set the width attribute to ensure the column is wide enough to accommodate the width of the contents. When the "multiple" option is used in the table that contains the column, the width can be set to a percentage. Non-group column widths as percentages will be honored. When widths using percentages exist and the table columnStretching is set to "multiple", the percentages are used to determine a normalized ratio. For example, if two columns have their widths set to "100%", they will each be normalized to take up .5 times the stretchable space. Stretchable space is defined as the space after px widths are taken into account. Minimum widths are honored by the stretching.

Returns:

the new width value

setWidth

public final void setWidth(java.lang.String width)

Sets The width of the column. The default width for a column is 100px. There is no auto sizing for columns. Set the width attribute to ensure the column is wide enough to accommodate the width of the contents. When the "multiple" option is used in the table that contains the column, the width can be set to a percentage. Non-group column widths as percentages will be honored. When widths using percentages exist and the table columnStretching is set to "multiple", the percentages are used to determine a normalized ratio. For example, if two columns have their widths set to "100%", they will each be normalized to take up .5 times the stretchable space. Stretchable space is defined as the space after px widths are taken into account. Minimum widths are honored by the stretching.

Parameters:

width - the new width value

getMinimumWidth

public final java.lang.String getMinimumWidth()

Gets The minimum number of pixels that the column can become. When a user attempts to resize the column, this minimum width will be enforced. Also, when a column is flexible, it will also never be stretched to be a size smaller than this minimum width. If a pixel width is defined and if the minimum width is larger, the minimum width will become the smaller of the two values. By default, the minimum width is 12 pixels.

Returns:

the new minimumWidth value

setMinimumWidth

public final void setMinimumWidth(java.lang.String minimumWidth)

Sets The minimum number of pixels that the column can become. When a user attempts to resize the column, this minimum width will be enforced. Also, when a column is flexible, it will also never be stretched to be a size smaller than this minimum width. If a pixel width is defined and if the minimum width is larger, the minimum width will become the smaller of the two values. By default, the minimum width is 12 pixels.

Parameters:

minimumWidth - the new minimumWidth value

getHeaderText

public final java.lang.String getHeaderText()

Gets text to display in the header of the column. This is a convenience that generates output equivalent to adding a "header" facet containing an outputText. If a "header" facet is added, headerText will not be rendered in column header.

Returns:

the new headerText value

setHeaderText

public final void setHeaderText(java.lang.String headerText)

Sets text to display in the header of the column. This is a convenience that generates output equivalent to adding a "header" facet containing an outputText. If a "header" facet is added, headerText will not be rendered in column header.

Parameters:

headerText - the new headerText value

isNoWrap

public final boolean isNoWrap()

Gets Specifies whether whitespace wrapping should be allowed in this column.

Returns:

the new noWrap value

setNoWrap

public final void setNoWrap(boolean noWrap)

Sets Specifies whether whitespace wrapping should be allowed in this column.

Parameters:

noWrap - the new noWrap value

isHeaderNoWrap

public final boolean isHeaderNoWrap()

Gets whether or not the column header should be allowed to wrap

Returns:

the new headerNoWrap value

setHeaderNoWrap

public final void setHeaderNoWrap(boolean headerNoWrap)

Sets whether or not the column header should be allowed to wrap

Parameters:

headerNoWrap - the new headerNoWrap value

isSortable

public final boolean isSortable()

Gets whether or not the column is sortable. A sortable column has a clickable header that (when clicked) sorts the table by that column's property. Note that in order for a column to be sortable, this attribute must be set to "true" and the underlying model must support sorting by this column's property.

This column's "sortProperty" attribute must be set if sorting is desired.

Returns:

the new sortable value

setSortable

public final void setSortable(boolean sortable)

Sets whether or not the column is sortable. A sortable column has a clickable header that (when clicked) sorts the table by that column's property. Note that in order for a column to be sortable, this attribute must be set to "true" and the underlying model must support sorting by this column's property.

This column's "sortProperty" attribute must be set if sorting is desired.

Parameters:

sortable - the new sortable value

isFilterable

public final boolean isFilterable()

Gets whether or not the column is filterable. A filterable column will have a filter field on the top of the column header. Note that in order for a column to be filterable, this attribute must be set to "true" and the filterModel attribute will be set on the table. Only Leaf columns are filterable and the filter component is displayed only if the column header is present. The column header is present if the "headerText" attribute or "header" facet is set on the column.

This column's "sortProperty" attribute will be used as a key for the filterProperty in the filterModel. This implies that "sortProperty" *must* be set on the column for it to be filterable.

Also look at "filter" facet for providing a component other than the default inputText for filtering.

Returns:

the new filterable value

setFilterable

public final void setFilterable(boolean filterable)

Sets whether or not the column is filterable. A filterable column will have a filter field on the top of the column header. Note that in order for a column to be filterable, this attribute must be set to "true" and the filterModel attribute will be set on the table. Only Leaf columns are filterable and the filter component is displayed only if the column header is present. The column header is present if the "headerText" attribute or "header" facet is set on the column.

This column's "sortProperty" attribute will be used as a key for the filterProperty in the filterModel. This implies that "sortProperty" *must* be set on the column for it to be filterable.

Also look at "filter" facet for providing a component other than the default inputText for filtering.

Parameters:

filterable - the new filterable value

isSeparateRows

public final boolean isSeparateRows()

Gets This property is currently not supported in the rich client.

Returns:

the new separateRows value

setSeparateRows

public final void setSeparateRows(boolean separateRows)

Sets This property is currently not supported in the rich client.

Parameters:

separateRows - the new separateRows value

getRowHeader

public final java.lang.String getRowHeader()

Gets Whether or not this column is considered a row header column for the table. Valid values are "true", "false", and "unstyled". The default value is "false" and results in no special handling. A column that is marked as rowHeader "true" is moved to the starting position (displayIndex = 0) and is automatically frozen. A value of "unstyled" indicates that the column is a row header for screen reader mode purposes, but there are no visual changes done to the column in rich mode. A value of "unstyled" is typically used when you want to indicate a row header for accessibility requirements, but don't want any visual changes made to your column or table in regular rich mode.

In screen reader mode, when the rowHeader is set to "true" or "unstyled" the column is marked as a row header and moved to the starting position. It is required for accessibility that at least one column to be marked as a row header and that the rowHeader provides unique textual information.

Also note that for a table with row selection enabled, at least one column in the table will need to be set as a row header with rowHeader=true. This is needed to allow keyboard row selection.

Returns:

the new rowHeader value

setRowHeader

public final void setRowHeader(java.lang.String rowHeader)

Sets Whether or not this column is considered a row header column for the table. Valid values are "true", "false", and "unstyled". The default value is "false" and results in no special handling. A column that is marked as rowHeader "true" is moved to the starting position (displayIndex = 0) and is automatically frozen. A value of "unstyled" indicates that the column is a row header for screen reader mode purposes, but there are no visual changes done to the column in rich mode. A value of "unstyled" is typically used when you want to indicate a row header for accessibility requirements, but don't want any visual changes made to your column or table in regular rich mode.

In screen reader mode, when the rowHeader is set to "true" or "unstyled" the column is marked as a row header and moved to the starting position. It is required for accessibility that at least one column to be marked as a row header and that the rowHeader provides unique textual information.

Also note that for a table with row selection enabled, at least one column in the table will need to be set as a row header with rowHeader=true. This is needed to allow keyboard row selection.

Parameters:

rowHeader - the new rowHeader value

isSelected

public final boolean isSelected()

Gets Specifies whether the column is selected.

Returns:

the new selected value

setSelected

public final void setSelected(boolean selected)

Sets Specifies whether the column is selected.

Parameters:

selected - the new selected value

getDisplayIndex

public final int getDisplayIndex()

Gets The display order index of the column. Columns can be re-arranged and they are displayed in the table based on the displayIndex. Columns are sorted based on the displayIndex property, columns without displayIndex are displayed at the end, in the order in which they appear. The displayIndex attribute is honored only for top level columns, since it is not possible to rearrange a child column outside of the parent column.

Returns:

the new displayIndex value

setDisplayIndex

public final void setDisplayIndex(int displayIndex)

Sets The display order index of the column. Columns can be re-arranged and they are displayed in the table based on the displayIndex. Columns are sorted based on the displayIndex property, columns without displayIndex are displayed at the end, in the order in which they appear. The displayIndex attribute is honored only for top level columns, since it is not possible to rearrange a child column outside of the parent column.

Parameters:

displayIndex - the new displayIndex value

isFrozen

public final boolean isFrozen()

Gets Specifies whether the column is frozen. In the table columns until the frozen column are locked with the header and not scrolled with the rest of the columns. Frozen attribute is honored only on the top level column,since it is not possible to freeze a child column by itself without its parent being frozen. If the table has a detailStamp for its rows, column freezing is turned off.

Returns:

the new frozen value

setFrozen

public final void setFrozen(boolean frozen)

Sets Specifies whether the column is frozen. In the table columns until the frozen column are locked with the header and not scrolled with the rest of the columns. Frozen attribute is honored only on the top level column,since it is not possible to freeze a child column by itself without its parent being frozen. If the table has a detailStamp for its rows, column freezing is turned off.

Parameters:

frozen - the new frozen value

getHelpTopicId

public final java.lang.String getHelpTopicId()

Gets Id used to look up a topic in a helpProvider.

Returns:

the new helpTopicId value

setHelpTopicId

public final void setHelpTopicId(java.lang.String helpTopicId)

Sets Id used to look up a topic in a helpProvider.

Parameters:

helpTopicId - the new helpTopicId value

isShowRequired

public final boolean isShowRequired()

Gets Indicates whether the columns displays a visual indication of required user input.

Returns:

the new showRequired value

setShowRequired

public final void setShowRequired(boolean showRequired)

Sets Indicates whether the columns displays a visual indication of required user input.

Parameters:

showRequired - the new showRequired value

isVisible

public final boolean isVisible()

Gets the visibility of the column. If it is "false", the column will not be displayed in the table on the client. Unlike "rendered", this does affect the lifecycle on the server - the column may have its bindings executed, etc. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client.

Returns:

the new visible value

setVisible

public final void setVisible(boolean visible)

Sets the visibility of the column. If it is "false", the column will not be displayed in the table on the client. Unlike "rendered", this does affect the lifecycle on the server - the column may have its bindings executed, etc. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client.

Parameters:

visible - the new visible value

getDefaultEventName

public java.lang.String getDefaultEventName()

Specified by:

getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getDefaultEventName in class org.apache.myfaces.trinidad.component.UIXComponentBase

getEventNames

public java.util.Collection<java.lang.String> getEventNames()

Specified by:

getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

getClientBehaviors

public java.util.Map<java.lang.String,java.util.List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()

Specified by:

getClientBehaviors in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getClientBehaviors in class org.apache.myfaces.trinidad.component.UIXComponentBase

addClientBehavior

public void addClientBehavior(java.lang.String eventName,
                              javax.faces.component.behavior.ClientBehavior behavior)

Specified by:

addClientBehavior in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

addClientBehavior in class org.apache.myfaces.trinidad.component.UIXComponentBase

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class org.apache.myfaces.trinidad.component.UIXColumn

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()

Overrides:

getBeanType in class org.apache.myfaces.trinidad.component.UIXColumn

Skip navigation links