|
ICEfaces ACE Components 3.3.0 Java API Documentation |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIColumn
org.icefaces.ace.component.column.ColumnBase
public class ColumnBase
Component that represents a column in an ace:dataTable.
For more information, see the Column Wiki Documentation.
Nested Class Summary | |
---|---|
protected static class |
ColumnBase.PropertyKeys
|
Field Summary | |
---|---|
static java.lang.String |
COMPONENT_TYPE
|
static java.lang.String |
RENDERER_TYPE
|
Fields inherited from class javax.faces.component.UIColumn |
---|
COMPONENT_FAMILY |
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 | |
---|---|
ColumnBase()
|
Method Summary | |
---|---|
int |
getColspan()
Return the value of the colspan property. |
java.lang.String |
getFamily()
|
java.lang.Object |
getFilterBy()
Return the value of the filterBy property. |
java.lang.String |
getFilterMatchMode()
Return the value of the filterMatchMode property. |
java.lang.Object |
getFilterOptions()
Return the value of the filterOptions property. |
java.lang.String |
getFilterStyle()
Return the value of the filterStyle property. |
java.lang.String |
getFilterStyleClass()
Return the value of the filterStyleClass property. |
java.lang.String |
getFilterValue()
Return the value of the filterValue property. |
java.lang.String |
getFooterText()
Return the value of the footerText property. |
java.lang.Object |
getGroupBy()
Return the value of the groupBy property. |
java.lang.String |
getHeaderText()
Return the value of the headerText property. |
java.lang.Integer |
getPinningOrder()
Return the value of the pinningOrder property. |
int |
getRowspan()
Return the value of the rowspan property. |
java.lang.Object |
getSelectBy()
Return the value of the selectBy property. |
java.lang.Object |
getSortBy()
Return the value of the sortBy property. |
java.util.Comparator |
getSortFunction()
Return the value of the sortFunction property. |
java.lang.Integer |
getSortPriority()
Return the value of the sortPriority property. |
java.lang.String |
getStyle()
Return the value of the style property. |
java.lang.String |
getStyleClass()
Return the value of the styleClass property. |
boolean |
isConfigurable()
Return the value of the configurable property. |
boolean |
isReorderable()
Return the value of the reorderable property. |
java.lang.Boolean |
isSortAscending()
Return the value of the sortAscending property. |
boolean |
isStacked()
Return the value of the stacked property. |
void |
setColspan(int colspan)
Set the value of the colspan property. |
void |
setConfigurable(boolean configurable)
Set the value of the configurable property. |
void |
setFilterBy(java.lang.Object filterBy)
Set the value of the filterBy property. |
void |
setFilterMatchMode(java.lang.String filterMatchMode)
Set the value of the filterMatchMode property. |
void |
setFilterOptions(java.lang.Object filterOptions)
Set the value of the filterOptions property. |
void |
setFilterStyle(java.lang.String filterStyle)
Set the value of the filterStyle property. |
void |
setFilterStyleClass(java.lang.String filterStyleClass)
Set the value of the filterStyleClass property. |
void |
setFilterValue(java.lang.String filterValue)
Set the value of the filterValue property. |
void |
setFooterText(java.lang.String footerText)
Set the value of the footerText property. |
void |
setGroupBy(java.lang.Object groupBy)
Set the value of the groupBy property. |
void |
setHeaderText(java.lang.String headerText)
Set the value of the headerText property. |
void |
setPinningOrder(java.lang.Integer pinningOrder)
Set the value of the pinningOrder property. |
void |
setReorderable(boolean reorderable)
Set the value of the reorderable property. |
void |
setRowspan(int rowspan)
Set the value of the rowspan property. |
void |
setSelectBy(java.lang.Object selectBy)
Set the value of the selectBy property. |
void |
setSortAscending(java.lang.Boolean sortAscending)
Set the value of the sortAscending property. |
void |
setSortBy(java.lang.Object sortBy)
Set the value of the sortBy property. |
void |
setSortFunction(java.util.Comparator sortFunction)
Set the value of the sortFunction property. |
void |
setSortPriority(java.lang.Integer sortPriority)
Set the value of the sortPriority property. |
void |
setStacked(boolean stacked)
Set the value of the stacked property. |
void |
setStyle(java.lang.String style)
Set the value of the style property. |
void |
setStyleClass(java.lang.String styleClass)
Set the value of the styleClass property. |
Methods inherited from class javax.faces.component.UIColumn |
---|
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, 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, 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 |
---|
public static final java.lang.String COMPONENT_TYPE
public static final java.lang.String RENDERER_TYPE
Constructor Detail |
---|
public ColumnBase()
Method Detail |
---|
public java.lang.String getFamily()
getFamily
in class javax.faces.component.UIColumn
public void setColspan(int colspan)
Set the value of the colspan
property.
Contents: Defines the number of columns the rendered cell spans. Only significant to Column components within a column group.
setColspan
in interface IColumn
public int getColspan()
Return the value of the colspan
property.
Contents: Defines the number of columns the rendered cell spans. Only significant to Column components within a column group. Default = '1'.
getColspan
in interface IColumn
public void setConfigurable(boolean configurable)
Set the value of the configurable
property.
Contents: When disabled, this column is excluded from the list of columns available for configuration on a TableConfigPanel component.
setConfigurable
in interface IColumn
public boolean isConfigurable()
Return the value of the configurable
property.
Contents: When disabled, this column is excluded from the list of columns available for configuration on a TableConfigPanel component. Default = 'true'.
isConfigurable
in interface IColumn
public void setFilterBy(java.lang.Object filterBy)
Set the value of the filterBy
property.
Contents: Defines a ValueExpression of the value of this row to use when filtering this column. Setting this attribute, or the "value" attribute for a column enables filtering.
setFilterBy
in interface IColumn
public java.lang.Object getFilterBy()
Return the value of the filterBy
property.
Contents: Defines a ValueExpression of the value of this row to use when filtering this column. Setting this attribute, or the "value" attribute for a column enables filtering.
getFilterBy
in interface IColumn
public void setFilterMatchMode(java.lang.String filterMatchMode)
Set the value of the filterMatchMode
property.
Contents: Defines the method of filter comparison used, default is "startsWith". Types available include: "contains", "exact", "startsWith" and "endsWith".
setFilterMatchMode
in interface IColumn
public java.lang.String getFilterMatchMode()
Return the value of the filterMatchMode
property.
Contents: Defines the method of filter comparison used, default is "startsWith". Types available include: "contains", "exact", "startsWith" and "endsWith". Default = 'startsWith'.
getFilterMatchMode
in interface IColumn
public void setFilterOptions(java.lang.Object filterOptions)
Set the value of the filterOptions
property.
Contents: Defines a collection of SelectItem objects for use as filter choices.
setFilterOptions
in interface IColumn
public java.lang.Object getFilterOptions()
Return the value of the filterOptions
property.
Contents: Defines a collection of SelectItem objects for use as filter choices.
getFilterOptions
in interface IColumn
public void setFilterStyle(java.lang.String filterStyle)
Set the value of the filterStyle
property.
Contents: Defines additional CSS rules to be applied to the filter text input.
setFilterStyle
in interface IColumn
public java.lang.String getFilterStyle()
Return the value of the filterStyle
property.
Contents: Defines additional CSS rules to be applied to the filter text input.
getFilterStyle
in interface IColumn
public void setFilterStyleClass(java.lang.String filterStyleClass)
Set the value of the filterStyleClass
property.
Contents: Defines supplementary CSS classes to add to those already applied on this component.
setFilterStyleClass
in interface IColumn
public java.lang.String getFilterStyleClass()
Return the value of the filterStyleClass
property.
Contents: Defines supplementary CSS classes to add to those already applied on this component.
getFilterStyleClass
in interface IColumn
public void setFilterValue(java.lang.String filterValue)
Set the value of the filterValue
property.
Contents: Defines the string input filtering this column, coming from the client, or from the application via a value binding.
setFilterValue
in interface IColumn
public java.lang.String getFilterValue()
Return the value of the filterValue
property.
Contents: Defines the string input filtering this column, coming from the client, or from the application via a value binding.
getFilterValue
in interface IColumn
public void setFooterText(java.lang.String footerText)
Set the value of the footerText
property.
Contents: Defines a plain text footer with less effort than adding a facet.
setFooterText
in interface IColumn
public java.lang.String getFooterText()
Return the value of the footerText
property.
Contents: Defines a plain text footer with less effort than adding a facet.
getFooterText
in interface IColumn
public void setGroupBy(java.lang.Object groupBy)
Set the value of the groupBy
property.
Contents: Defines a value expression representing the value of this column per row when determining if the values of this column in sibling rows are equal. If they are equal, span the rows witha single column cell.
setGroupBy
in interface IColumn
public java.lang.Object getGroupBy()
Return the value of the groupBy
property.
Contents: Defines a value expression representing the value of this column per row when determining if the values of this column in sibling rows are equal. If they are equal, span the rows witha single column cell.
getGroupBy
in interface IColumn
public void setHeaderText(java.lang.String headerText)
Set the value of the headerText
property.
Contents: Defines a plain text header with less effort than adding a facet.
setHeaderText
in interface IColumn
public java.lang.String getHeaderText()
Return the value of the headerText
property.
Contents: Defines a plain text header with less effort than adding a facet.
getHeaderText
in interface IColumn
public void setPinningOrder(java.lang.Integer pinningOrder)
Set the value of the pinningOrder
property.
Contents: Define the position of this column in the pinned column region when column pinning and scrolling are enabled at the table level. Having a value in this field indicates a column is pinned. 1 indexed.
setPinningOrder
in interface IColumn
public java.lang.Integer getPinningOrder()
Return the value of the pinningOrder
property.
Contents: Define the position of this column in the pinned column region when column pinning and scrolling are enabled at the table level. Having a value in this field indicates a column is pinned. 1 indexed.
getPinningOrder
in interface IColumn
public void setReorderable(boolean reorderable)
Set the value of the reorderable
property.
Contents: Enables per-column control of column ordering when the attribute ("reorderableColumns") is true at the table level.
setReorderable
in interface IColumn
public boolean isReorderable()
Return the value of the reorderable
property.
Contents: Enables per-column control of column ordering when the attribute ("reorderableColumns") is true at the table level. Default = 'true'.
isReorderable
in interface IColumn
public void setRowspan(int rowspan)
Set the value of the rowspan
property.
Contents: Defines the number of rows the rendered cell spans. Only significant to Column components within a column group.
setRowspan
in interface IColumn
public int getRowspan()
Return the value of the rowspan
property.
Contents: Defines the number of rows the rendered cell spans. Only significant to Column components within a column group. Default = '1'.
getRowspan
in interface IColumn
public void setSelectBy(java.lang.Object selectBy)
Set the value of the selectBy
property.
Contents: Defines a value expression representing the value of this column per row when using cell selection. Defining this attribute, or the "value" attribute, enables cell selection for this column when also enabled at the table level.
setSelectBy
in interface IColumn
public java.lang.Object getSelectBy()
Return the value of the selectBy
property.
Contents: Defines a value expression representing the value of this column per row when using cell selection. Defining this attribute, or the "value" attribute, enables cell selection for this column when also enabled at the table level.
getSelectBy
in interface IColumn
public void setSortAscending(java.lang.Boolean sortAscending)
Set the value of the sortAscending
property.
Contents: Defines the direction of column values during sorting. The column directions incoming from the client during a sort request overwrite any set by the application. Processing the sorted columns is done by the component whenever a client edits a sort control or the application calls table.applySorting().
setSortAscending
in interface IColumn
public java.lang.Boolean isSortAscending()
Return the value of the sortAscending
property.
Contents: Defines the direction of column values during sorting. The column directions incoming from the client during a sort request overwrite any set by the application. Processing the sorted columns is done by the component whenever a client edits a sort control or the application calls table.applySorting(). Default = 'false'.
isSortAscending
in interface IColumn
public void setSortBy(java.lang.Object sortBy)
Set the value of the sortBy
property.
Contents: Defines a value expression representing the value of this column per row when sorting. Setting this attribute, or the "value" attribute for a column enables sorting.
setSortBy
in interface IColumn
public java.lang.Object getSortBy()
Return the value of the sortBy
property.
Contents: Defines a value expression representing the value of this column per row when sorting. Setting this attribute, or the "value" attribute for a column enables sorting.
getSortBy
in interface IColumn
public void setSortFunction(java.util.Comparator sortFunction)
Set the value of the sortFunction
property.
Contents: Defines an alternate method of sorting. Sort this column using a Comparator
setSortFunction
in interface IColumn
public java.util.Comparator getSortFunction()
Return the value of the sortFunction
property.
Contents: Defines an alternate method of sorting. Sort this column using a Comparator
getSortFunction
in interface IColumn
public void setSortPriority(java.lang.Integer sortPriority)
Set the value of the sortPriority
property.
Contents: Defines the priority of a column during sorting. The column priorities incoming from the client during a sort request overwrite any set by the application. Processing the sorted columns is done by the component whenever a client edits a sort control or the application calls table.applySorting().
setSortPriority
in interface IColumn
public java.lang.Integer getSortPriority()
Return the value of the sortPriority
property.
Contents: Defines the priority of a column during sorting. The column priorities incoming from the client during a sort request overwrite any set by the application. Processing the sorted columns is done by the component whenever a client edits a sort control or the application calls table.applySorting().
getSortPriority
in interface IColumn
public void setStacked(boolean stacked)
Set the value of the stacked
property.
Contents: When enabled, this column is rendered underneath the previous column.
setStacked
in interface IColumn
public boolean isStacked()
Return the value of the stacked
property.
Contents: When enabled, this column is rendered underneath the previous column.
isStacked
in interface IColumn
public void setStyle(java.lang.String style)
Set the value of the style
property.
Contents: Custom inline CSS styles to use for this component. These styles are generally applied to the root DOM element of the component. This is intended for per-component basic style customizations. Note that due to browser CSS precedence rules, CSS rendered on a DOM element will take precedence over the external stylesheets used to provide the ThemeRoller theme on this component. If the CSS properties applied with this attribute do not affect the DOM element you want to style, you may need to create a custom theme styleClass for the theme CSS class that targets the particular DOM elements you wish to customize.
setStyle
in interface IColumn
public java.lang.String getStyle()
Return the value of the style
property.
Contents: Custom inline CSS styles to use for this component. These styles are generally applied to the root DOM element of the component. This is intended for per-component basic style customizations. Note that due to browser CSS precedence rules, CSS rendered on a DOM element will take precedence over the external stylesheets used to provide the ThemeRoller theme on this component. If the CSS properties applied with this attribute do not affect the DOM element you want to style, you may need to create a custom theme styleClass for the theme CSS class that targets the particular DOM elements you wish to customize.
getStyle
in interface IColumn
public void setStyleClass(java.lang.String styleClass)
Set the value of the styleClass
property.
Contents: Custom CSS style class(es) to use for this component. These style classes can be defined in your page or in a theme CSS file.
setStyleClass
in interface IColumn
public java.lang.String getStyleClass()
Return the value of the styleClass
property.
Contents: Custom CSS style class(es) to use for this component. These style classes can be defined in your page or in a theme CSS file.
getStyleClass
in interface IColumn
|
ICEfaces ACE Components 3.3.0 Java API Documentation |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |