com.liferay.faces.alloy.component.datatable

Class DataTableBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIData

javax.faces.component.html.HtmlDataTable

com.liferay.faces.alloy.component.datatable.DataTableBase

All Implemented Interfaces:

com.liferay.faces.util.component.ClientComponent, com.liferay.faces.util.component.Styleable, EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.component.UniqueIdVendor, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

Direct Known Subclasses:

DataTable

@Generated(value="com.liferay.alloy.tools.builder.FacesBuilder")
public abstract class DataTableBase
extends javax.faces.component.html.HtmlDataTable
implements com.liferay.faces.util.component.Styleable, com.liferay.faces.util.component.ClientComponent

Author:

Bruno Basto, Kyle Stiemann

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DataTableBase.DataTablePropertyKeys

Nested classes/interfaces inherited from class javax.faces.component.html.HtmlDataTable

javax.faces.component.html.HtmlDataTable.PropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_TYPE
static String	RENDERER_TYPE

Fields inherited from class javax.faces.component.UIData

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

Fields inherited from interface com.liferay.faces.util.component.Styleable

STYLE, STYLE_CLASS

Fields inherited from interface com.liferay.faces.util.component.ClientComponent

CLIENT_KEY

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor and Description
DataTableBase()

Method Summary

Methods

Modifier and Type	Method and Description
String	getClientKey() clientKey attribute description: The key name that can be used to reference the component on the client.
String	getSelectedRowIndexes() selectedRowIndexes attribute description: Comma-delimited list of row indexes that indicate which rows are selected.
String	getSelectionMode() selectionMode attribute description: Indicates the type of row selection.
String	getStyleClass() styleClass attribute description: List of CSS class names (separated by spaces) that are to be rendered within the class attribute.
boolean	isMultiColumnSort() multiColumnSort attribute description: When true, multiple columns can be selected by the user when the meta key is held down during a left click on a sortable column header.
void	setClientKey(String clientKey) clientKey attribute description: The key name that can be used to reference the component on the client.
void	setMultiColumnSort(boolean multiColumnSort) multiColumnSort attribute description: When true, multiple columns can be selected by the user when the meta key is held down during a left click on a sortable column header.
void	setSelectedRowIndexes(String selectedRowIndexes) selectedRowIndexes attribute description: Comma-delimited list of row indexes that indicate which rows are selected.
void	setSelectionMode(String selectionMode) selectionMode attribute description: Indicates the type of row selection.

Methods inherited from class javax.faces.component.html.HtmlDataTable

getBgcolor, getBodyrows, getBorder, getCaptionClass, getCaptionStyle, getCellpadding, getCellspacing, getColumnClasses, getDefaultEventName, getDir, getEventNames, getFooterClass, getFrame, getHeaderClass, getLang, getOnclick, getOndblclick, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getRole, getRowClasses, getRules, getStyle, getSummary, getTitle, getWidth, setBgcolor, setBodyrows, setBorder, setCaptionClass, setCaptionStyle, setCellpadding, setCellspacing, setColumnClasses, setDir, setFooterClass, setFrame, setHeaderClass, setLang, setOnclick, setOndblclick, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setRole, setRowClasses, setRules, setStyle, setStyleClass, setSummary, setTitle, setWidth

Methods inherited from class javax.faces.component.UIData

broadcast, createUniqueId, encodeBegin, getClientId, getDataModel, getFamily, getFirst, getFooter, getHeader, getRowCount, getRowData, getRowIndex, getRows, getValue, getVar, invokeOnComponent, isRowAvailable, isRowStatePreserved, markInitialState, processDecodes, processUpdates, processValidators, queueEvent, restoreState, saveState, setDataModel, setFirst, setFooter, setHeader, setRowIndex, setRows, setRowStatePreserved, setValue, setValueBinding, setValueExpression, setVar, visitTree

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, clearInitialState, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, 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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.liferay.faces.util.component.Styleable

getStyle, setStyle, setStyleClass

Methods inherited from interface com.liferay.faces.util.component.ClientComponent

getClientId

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

addClientBehavior, getClientBehaviors

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

RENDERER_TYPE

public static final String RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

DataTableBase

public DataTableBase()

Method Detail

getClientKey

public String getClientKey()

clientKey attribute description:

The key name that can be used to reference the component on the client.

Specified by:

getClientKey in interface com.liferay.faces.util.component.ClientComponent

setClientKey

public void setClientKey(String clientKey)

clientKey attribute description:

The key name that can be used to reference the component on the client.

Specified by:

setClientKey in interface com.liferay.faces.util.component.ClientComponent

isMultiColumnSort

public boolean isMultiColumnSort()

multiColumnSort attribute description:

When true, multiple columns can be selected by the user when the meta key is held down during a left click on a sortable column header.

setMultiColumnSort

public void setMultiColumnSort(boolean multiColumnSort)

multiColumnSort attribute description:

When true, multiple columns can be selected by the user when the meta key is held down during a left click on a sortable column header.

getSelectedRowIndexes

public String getSelectedRowIndexes()

selectedRowIndexes attribute description:

Comma-delimited list of row indexes that indicate which rows are selected.

setSelectedRowIndexes

public void setSelectedRowIndexes(String selectedRowIndexes)

selectedRowIndexes attribute description:

Comma-delimited list of row indexes that indicate which rows are selected.

getSelectionMode

public String getSelectionMode()

selectionMode attribute description:

Indicates the type of row selection. Valid values are "checkbox", "radio".

setSelectionMode

public void setSelectionMode(String selectionMode)

selectionMode attribute description:

Indicates the type of row selection. Valid values are "checkbox", "radio".

getStyleClass

public String getStyleClass()

styleClass attribute description:

List of CSS class names (separated by spaces) that are to be rendered within the class attribute.

Specified by:

getStyleClass in interface com.liferay.faces.util.component.Styleable

Overrides:

getStyleClass in class javax.faces.component.html.HtmlDataTable