org.rcfaces.core.component
Class ComponentsGridComponent

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          org.rcfaces.core.internal.component.UIData0
              org.rcfaces.core.internal.component.UIData2
                  org.rcfaces.core.internal.component.CameliaDataComponent
                      org.rcfaces.core.component.AbstractDataComponent
                          org.rcfaces.core.component.ComponentsGridComponent

All Implemented Interfaces:

NamingContainer, StateHolder, IAdditionalInformationCardinalityCapability, IAdditionalInformationEventCapability, IAdditionalInformationProvider, IAdditionalInformationValuesCapability, IAlertLoadingMessageCapability, IBorderCapability, ICardinality, IClientAdditionalInformationFullStateCapability, IClientDataCapability, IClientFullStateCapability, IClientSelectionFullStateCapability, IDoubleClickEventCapability, IEmptyDataMessageCapability, IErrorEventCapability, IFocusBlurEventCapability, IForegroundBackgroundColorCapability, IHeaderVisibilityCapability, IHeightCapability, IHelpCapability, IHiddenModeCapability, IImmediateCapability, IInitEventCapability, IKeyDownEventCapability, IKeyEventCapability, IKeyPressEventCapability, IKeyUpEventCapability, ILayoutPositionCapability, ILoadEventCapability, ILookAndFeelCapability, IMarginCapability, IMenuCapability, IMouseEventCapability, IOrderedChildrenCapability, IPagedCapability, IPartialRenderingCapability, IPositionCapability, IPreferencesCapability, IPropertyChangeEventCapability, IRequiredCapability, IResetEventCapability, IRowStyleClassCapability, IScrollableCapability, ISelectableCapability, ISelectedValuesCapability, ISelectionCardinalityCapability, ISelectionEventCapability, IServerDataCapability, IShowValueCapability, ISizeCapability, ISortedChildrenCapability, ISortEventCapability, ISortManagerCapability, IStyleClassCapability, ITabIndexCapability, IToolTipCapability, IUnlockedClientAttributesCapability, IUserEventCapability, IVisibilityCapability, IWAIRoleCapability, IWheelSelectionCapability, IWidthCapability, org.rcfaces.core.internal.capability.IAdditionalInformationComponent, org.rcfaces.core.internal.capability.IAdditionalInformationRangeComponent, org.rcfaces.core.internal.capability.IComponentLifeCycle, org.rcfaces.core.internal.capability.IGridComponent, org.rcfaces.core.internal.capability.IPreferencesSettings, org.rcfaces.core.internal.capability.IRCFacesComponent, org.rcfaces.core.internal.capability.ISelectionComponent, org.rcfaces.core.internal.capability.ISelectionRangeComponent, org.rcfaces.core.internal.capability.ISortedComponentsCapability, org.rcfaces.core.internal.manager.IClientDataManager, org.rcfaces.core.internal.manager.IContainerManager, org.rcfaces.core.internal.manager.IServerDataManager, org.rcfaces.core.internal.manager.ITransientAttributesManager, org.rcfaces.core.internal.tools.CollectionTools.IComponentValueTypeCapability, ISelectionProvider

public class ComponentsGridComponent
extends AbstractDataComponent
implements ISelectionEventCapability, ISelectableCapability, ISelectionCardinalityCapability, ISelectedValuesCapability, IClientSelectionFullStateCapability, IAdditionalInformationEventCapability, IAdditionalInformationValuesCapability, IClientAdditionalInformationFullStateCapability, IAdditionalInformationCardinalityCapability, IDoubleClickEventCapability, ILoadEventCapability, IRequiredCapability, IBorderCapability, IRowStyleClassCapability, IShowValueCapability, IEmptyDataMessageCapability, IMenuCapability, IScrollableCapability, org.rcfaces.core.internal.capability.IPreferencesSettings, IPagedCapability, IHeaderVisibilityCapability, org.rcfaces.core.internal.capability.IGridComponent, IOrderedChildrenCapability, ISortedChildrenCapability, org.rcfaces.core.internal.tools.CollectionTools.IComponentValueTypeCapability, org.rcfaces.core.internal.capability.ISelectionRangeComponent, org.rcfaces.core.internal.capability.ISortedComponentsCapability, org.rcfaces.core.internal.capability.IAdditionalInformationRangeComponent

The componentGrid Component is a grid component. It can be compared to the grid found in the list part of the modern file explorer. It allows sorts, resizing, contextual menus ...

The componentGrid Component is an evolution of dataGrid component. This component is a component container, it allows to:

• ISelectionEventCapability
• ISelectableCapability
• ISelectionCardinalityCapability
• ISelectedValuesCapability
• IClientSelectionFullStateCapability
• IAdditionalInformationEventCapability
• IAdditionalInformationValuesCapability
• IClientAdditionalInformationFullStateCapability
• IAdditionalInformationCardinalityCapability
• IDoubleClickEventCapability
• ILoadEventCapability
• IRequiredCapability
• IBorderCapability
• IRowStyleClassCapability
• IShowValueCapability
• IEmptyDataMessageCapability
• IMenuCapability
• IScrollableCapability
• IPreferencesSettings
• IPagedCapability
• IHeaderVisibilityCapability
• IGridComponent
• IOrderedChildrenCapability
• ISortedChildrenCapability
• IComponentValueTypeCapability
• ISelectionRangeComponent
• ISortedComponentsCapability
• IAdditionalInformationRangeComponent

The default componentsGrid renderer is link to the f_componentsGrid javascript class. f_componentsGrid extends f_grid

Table of component style classes:

Style Name	Description
f_componentsGrid	Defines styles for the wrapper DIV element. Contains f_grid styles.

Nested Class Summary

Nested classes/interfaces inherited from class org.rcfaces.core.internal.component.UIData2

org.rcfaces.core.internal.component.UIData2.SavedState2

Field Summary

protected static Set	CAMELIA_ATTRIBUTES
static String	COMPONENT_TYPE

Fields inherited from class org.rcfaces.core.internal.component.CameliaDataComponent

engine

Fields inherited from class org.rcfaces.core.internal.component.UIData0

COMPONENT_FAMILY

Fields inherited from class javax.faces.component.UIComponent

bindings

Fields inherited from interface org.rcfaces.core.component.capability.ISelectionCardinalityCapability

DEFAULT_CARDINALITY

Fields inherited from interface org.rcfaces.core.component.capability.IClientFullStateCapability

DEFAULT_CLIENT_FULL_STATE, FALSE_CLIENT_FULL_STATE, NONE_CLIENT_FULL_STATE, ONEWAY_CLIENT_FULL_STATE, TRUE_CLIENT_FULL_STATE, TWOWAYS_CLIENT_FULL_STATE

Fields inherited from interface org.rcfaces.core.component.capability.IAdditionalInformationCardinalityCapability

DEFAULT_CARDINALITY

Fields inherited from interface org.rcfaces.core.component.capability.ICardinality

ONE_CARDINALITY, ONEMANY_CARDINALITY, OPTIONAL_CARDINALITY, ZEROMANY_CARDINALITY

Fields inherited from interface org.rcfaces.core.component.capability.ISortEventCapability

SORT_ALPHA, SORT_ALPHA_IGNORE_CASE, SORT_DATE, SORT_INTEGER, SORT_NUMBER, SORT_SERVER, SORT_TIME

Fields inherited from interface org.rcfaces.core.component.capability.IHiddenModeCapability

CLIENT_HIDDEN_MODE, DEFAULT_HIDDEN_MODE, IGNORE_HIDDEN_MODE, PHANTOM_HIDDEN_MODE, SERVER_HIDDEN_MODE

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

ComponentsGridComponent()

ComponentsGridComponent(String componentId)

Method Summary

void	addAdditionalInformationListener(IAdditionalInformationListener listener) Adds a listener to the component for the additional event
void	addDoubleClickListener(IDoubleClickListener listener) Adds a listener to the component for the doubleClick event
void	addLoadListener(ILoadListener listener) Adds a listener to the component for the load event
void	addSelectionListener(ISelectionListener listener) Adds a listener to the component for the selection event
void	deselect(int index)
void	deselect(int[] indices)
void	deselect(int start, int end)
void	deselect(Object rowValue)
void	deselectAll()
int	getAdditionalInformationCardinality() Returns an int value indicating the cardinality (number of additional-informations allowed) for this component.
int	getAdditionalInformationCardinality(FacesContext facesContext) See getAdditionalInformationCardinality() for more details
Object	getAdditionalInformationValues()
Object	getAdditionalInformationValues(FacesContext facesContext)
int	getAdditionalInformationValuesCount()
Class	getAdditionalInformationValuesType(FacesContext facesContext) Return the type of the property represented by the ValueExpression, relative to the specified FacesContext.
protected Set	getCameliaFields()
int	getClientAdditionalInformationFullState() Returns an integer value indicating whether the client should know about the component's full state even if only a part of the data is present (AJAX).
int	getClientAdditionalInformationFullState(FacesContext facesContext) See getClientAdditionalInformationFullState() for more details
int	getClientSelectionFullState() Returns a boolean value indicating whether the client should know about the component's full state even if only a part of the data is present (AJAX).
int	getClientSelectionFullState(FacesContext facesContext) See getClientSelectionFullState() for more details
org.rcfaces.core.internal.tools.CollectionTools.IComponentValueType	getComponentValueType()
String	getEmptyDataMessage() Returns a string containing the message shown when there is no result.
String	getEmptyDataMessage(FacesContext facesContext) See getEmptyDataMessage() for more details
Object	getFirstAdditionalInformationValue()
Object	getFirstSelectedValue()
ComponentsColumnComponent	getFirstSortedColumn()
int	getHorizontalScrollPosition() Returns an integer value specifying the position of the horizontal scroolbar (browser dependant).
int	getHorizontalScrollPosition(FacesContext facesContext) See getHorizontalScrollPosition() for more details
IMenuComponent	getMenu() Returns the top-most menu associated to the component.
IMenuComponent	getMenu(String menuId) Returns the menu identified by its id from the menus associated to the component.
UIComponent[]	getOrderedChildren() Returns a list of the columns' id which represents their order from left to right.
IComponentPreferences	getPreferences() Returns an object that holds the preferences for the component.
IComponentPreferences	getPreferences(FacesContext facesContext) See getPreferences() for more details
String	getRowCountVar() Returns a string value specifying the name of the variable receiving the number of rows.
String	getRowCountVar(FacesContext facesContext) Returns a string value specifying the name of the variable receiving the number of rows.
String	getRowIndexVar() Returns a string value specifying the name of the variable receiving the index of the current row.
String	getRowIndexVar(FacesContext facesContext) Returns a string value specifying the name of the variable receiving the index of the current row.
String	getRowStyleClass()
String	getRowStyleClass(FacesContext facesContext) See getRowStyleClass() for more details
String	getRowValue()
String	getRowValue(FacesContext facesContext)
Converter	getRowValueConverter()
Converter	getRowValueConverter(FacesContext facesContext)
Object	getSelectedValues()
Object	getSelectedValues(FacesContext facesContext)
int	getSelectedValuesCount()
Class	getSelectedValuesType(FacesContext facesContext) Return the type of the property represented by the ValueExpression, relative to the specified FacesContext.
int	getSelectionCardinality() Returns an int value specifying the type of multiple selection authorized. cf.
int	getSelectionCardinality(FacesContext facesContext) See getSelectionCardinality() for more details
Object	getShowValue()
Object	getShowValue(FacesContext facesContext) See getShowValue() for more details
UIComponent[]	getSortedChildren() Returns a string value giving the ordered list of the sorted components.
ComponentsColumnComponent[]	getSortedColumns()
int	getVerticalScrollPosition() Returns an integer value specifying the position of the vertical scroolbar (Browser dependant).
int	getVerticalScrollPosition(FacesContext facesContext) See getVerticalScrollPosition() for more details
void	hideAdditionalInformation(int index)
void	hideAdditionalInformation(int[] indexes)
void	hideAdditionalInformation(Object rowValue)
void	hideAllAdditionalInformations()
boolean	isAdditionalInformationCardinalitySetted() Returns true if the attribute "additionalInformationCardinality" is set.
boolean	isAdditionalInformationValuesSetted() Returns true if the attribute "additionalInformationValues" is set.
boolean	isBorder() Returns a boolean value that indicates if the component should show a border or not.
boolean	isBorder(FacesContext facesContext) See isBorder() for more details
boolean	isBorderSetted() Returns true if the attribute "border" is set.
boolean	isCellTextWrap()
boolean	isCellTextWrap(FacesContext facesContext)
boolean	isCellTextWrapSetted() Returns true if the attribute "cellTextWrap" is set.
boolean	isClientAdditionalInformationFullStateSetted() Returns true if the attribute "clientAdditionalInformationFullState" is set.
boolean	isClientSelectionFullStateSetted() Returns true if the attribute "clientSelectionFullState" is set.
boolean	isEmptyDataMessageSetted() Returns true if the attribute "emptyDataMessage" is set.
boolean	isHeaderVisible() Returns a boolean value indicating wether the header should be visible.
boolean	isHeaderVisible(FacesContext facesContext) See isHeaderVisible() for more details
boolean	isHeaderVisibleSetted() Returns true if the attribute "headerVisible" is set.
boolean	isHorizontalScrollPositionSetted() Returns true if the attribute "horizontalScrollPosition" is set.
boolean	isPaged() Returns a boolean value specifying wether the results should be displayed by page (thus letting the user choose what page to display via the pager).
boolean	isPaged(FacesContext facesContext) See isPaged() for more details
boolean	isPagedSetted()
boolean	isPreferencesSetted() Returns true if the attribute "preferences" is set.
boolean	isRequired() Returns a boolean value indicating that the user is required to provide a submitted value for this input component.
boolean	isRequired(FacesContext facesContext) See isRequired() for more details
boolean	isRequiredSetted() Returns true if the attribute "required" is set.
boolean	isRowCountVarSetted() Returns true if the attribute "rowCountVar" is set.
boolean	isRowIndexVarSetted() Returns true if the attribute "rowIndexVar" is set.
boolean	isRowStyleClassSetted() Returns true if the attribute "rowStyleClass" is set.
boolean	isRowValueConverterSetted() Returns true if the attribute "rowValueConverter" is set.
boolean	isRowValueSetted() Returns true if the attribute "rowValue" is set.
boolean	isSelectable() Returns a boolean value indicating wether the component can receive a user's selection
boolean	isSelectable(FacesContext facesContext) See isSelectable() for more details
boolean	isSelectableSetted() Returns true if the attribute "selectable" is set.
boolean	isSelectedValuesSetted() Returns true if the attribute "selectedValues" is set.
boolean	isSelectionCardinalitySetted() Returns true if the attribute "selectionCardinality" is set.
boolean	isShowValueSetted() Returns true if the attribute "showValue" is set.
boolean	isVerticalScrollPositionSetted() Returns true if the attribute "verticalScrollPosition" is set.
FacesListener[]	listAdditionalInformationListeners() Returns a list of additional listener for the component
IAdditionalInformationIterator	listAdditionalInformations()
Object[]	listAdditionalInformationValues()
IColumnIterator	listColumns()
FacesListener[]	listDoubleClickListeners() Returns a list of doubleClick listener for the component
FacesListener[]	listLoadListeners() Returns a list of load listener for the component
IMenuIterator	listMenus() Returns a list of all the menus associated to the component.
Object[]	listSelectedValues()
FacesListener[]	listSelectionListeners() Returns a list of selection listener for the component
ISortedComponent[]	listSortedComponents()
ISortedComponent[]	listSortedComponents(FacesContext context)
void	removeAdditionalInformationListener(IAdditionalInformationListener listener) Removes a listener from the component for the additional event
void	removeDoubleClickListener(IDoubleClickListener listener) Removes a listener from the component for the doubleClick event
void	removeLoadListener(ILoadListener listener) Removes a listener from the component for the load event
void	removeSelectionListener(ISelectionListener listener) Removes a listener from the component for the selection event
void	select(int index)
void	select(int[] indices)
void	select(int start, int end)
void	select(Object rowValue)
void	selectAll()
void	setAdditionalInformationCardinality(int additionalInformationCardinality) Sets an int value indicating the cardinality (number of additional-informations allowed) for this component.
void	setAdditionalInformationCardinality(String cardinality)
void	setAdditionalInformationValues(Object additionalInformationValues)
void	setBorder(boolean border) Sets a boolean value that indicates if the component should show a border or not.
void	setCellTextWrap(boolean cellTextWrap)
void	setClientAdditionalInformationFullState(int clientAdditionalInformationFullState) Sets an integer value indicating whether the client should know about the component's full state even if only a part of the data is present (AJAX).
void	setClientAdditionalInformationFullState(String state)
void	setClientSelectionFullState(int clientSelectionFullState) Sets a boolean value indicating whether the client should know about the component's full state even if only a part of the data is present (AJAX).
void	setClientSelectionFullState(String state)
void	setEmptyDataMessage(String emptyDataMessage) Sets the string conatining the message shown when there is no result.
void	setHeaderVisible(boolean headerVisible) Sets a boolean value indicating wether the header should be visible.
void	setHorizontalScrollPosition(int horizontalScrollPosition) Sets an integer value specifying the position of the horizontal scroolbar (browser dependant).
void	setOrderedChildren(UIComponent[] components) Sets a list of the columns' id which represents their order from left to right.
void	setPaged(boolean paged) Sets a boolean value specifying wether the results should be displayed by page (thus letting the user choose what page to display via the pager).
void	setPreferences(IComponentPreferences preferences) Sets an object that holds the preferences for the component.
void	setRequired(boolean required) Sets a boolean value indicating that the user is required to provide a submitted value for this input component.
void	setRowCountVar(String rowCountVar) Sets a string value specifying the name of the variable receiving the number of rows.
void	setRowIndexVar(String rowIndexVar) Sets a string value specifying the name of the variable receiving the index of the current row.
void	setRowStyleClass(String rowStyleClass)
void	setRowValue(String rowValue)
void	setRowValueConverter(Converter rowValueConverter)
void	setRowValueConverter(String converterId)
void	setRowValueConverter(String converterId, FacesContext facesContext)
void	setSelectable(boolean selectable) Sets a boolean value indicating wether the component can receive a user's selection
void	setSelectedValues(Object selectedValues)
void	setSelectionCardinality(int selectionCardinality) Sets an int value specifying the type of multiple selection authorized.
void	setSelectionCardinality(String cardinality)
void	setShowValue(Object showValue) Set the value of the item will be shown.
void	setSortedChildren(UIComponent[] components) Set the ordered list of the sorted components
void	setSortedColumn(ComponentsColumnComponent componentsColumn)
void	setSortedColumns(ComponentsColumnComponent[] componentsColumns)
void	setVerticalScrollPosition(int verticalScrollPosition) Sets an integer value specifying the position of the vertical scroolbar (Browser dependant).
void	showAdditionalInformation(int index)
void	showAdditionalInformation(int[] indexes)
void	showAdditionalInformation(Object rowValue)
void	showAllAdditionalInformations()

Methods inherited from class org.rcfaces.core.component.AbstractDataComponent

addBlurListener, addErrorListener, addFocusListener, addInitListener, addKeyDownListener, addKeyPressListener, addKeyUpListener, addMouseOutListener, addMouseOverListener, addPropertyChangeListener, addResetListener, addSortListener, addUserEventListener, getAlertLoadingMessage, getAlertLoadingMessage, getAriaLabel, getAriaLabel, getAriaLevel, getAriaLevel, getBackgroundColor, getBackgroundColor, getBottom, getBottom, getClientData, getClientData, getClientDataCount, getClientDataMap, getClientDataMap, getForegroundColor, getForegroundColor, getHeight, getHeight, getHelpMessage, getHelpMessage, getHelpURL, getHelpURL, getHiddenMode, getHiddenMode, getLeft, getLeft, getLookId, getLookId, getMarginBottom, getMarginBottom, getMarginLeft, getMarginLeft, getMarginRight, getMarginRight, getMarginTop, getMarginTop, getRight, getRight, getServerData, getServerData, getServerDataCount, getServerDataMap, getServerDataMap, getSortManager, getSortManager, getStyleClass, getStyleClass, getTabIndex, getTabIndex, getToolTipText, getToolTipText, getTop, getTop, getUnlockedClientAttributeNames, getUnlockedClientAttributeNames, getVisibleState, getVisibleState, getWaiRole, getWaiRole, getWidth, getWidth, getX, getX, getY, getY, isAlertLoadingMessageSetted, isAriaLabelSetted, isAriaLevelSetted, isBackgroundColorSetted, isBottomSetted, isForegroundColorSetted, isHeightSetted, isHelpMessageSetted, isHelpURLSetted, isHiddenModeSetted, isImmediate, isImmediate, isImmediateSetted, isLeftSetted, isLookIdSetted, isMarginBottomSetted, isMarginLeftSetted, isMarginRightSetted, isMarginTopSetted, isPartialRendering, isPartialRendering, isPartialRenderingSetted, isRightSetted, isSortManagerSetted, isStyleClassSetted, isTabIndexSetted, isToolTipTextSetted, isTopSetted, isUnlockedClientAttributeNamesSetted, isVisible, isVisible, isVisibleSetted, isWaiRoleSetted, isWheelSelection, isWheelSelection, isWheelSelectionSetted, isWidthSetted, isXSetted, isYSetted, listBlurListeners, listClientDataKeys, listClientDataKeys, listErrorListeners, listFocusListeners, listInitListeners, listKeyDownListeners, listKeyPressListeners, listKeyUpListeners, listMouseOutListeners, listMouseOverListeners, listPropertyChangeListeners, listResetListeners, listServerDataKeys, listServerDataKeys, listSortListeners, listUserEventListeners, removeBlurListener, removeClientData, removeErrorListener, removeFocusListener, removeInitListener, removeKeyDownListener, removeKeyPressListener, removeKeyUpListener, removeMouseOutListener, removeMouseOverListener, removePropertyChangeListener, removeResetListener, removeServerData, removeSortListener, removeUserEventListener, setAlertLoadingMessage, setAriaLabel, setAriaLevel, setBackgroundColor, setBottom, setClientData, setClientData, setForegroundColor, setHeight, setHelpMessage, setHelpURL, setHiddenMode, setHiddenMode, setImmediate, setLeft, setLookId, setMarginBottom, setMarginLeft, setMarginRight, setMargins, setMarginTop, setPartialRendering, setRight, setServerData, setServerData, setSortManager, setStyleClass, setTabIndex, setToolTipText, setTop, setUnlockedClientAttributeNames, setValue, setVisible, setWaiRole, setWheelSelection, setWidth, setX, setY

Methods inherited from class org.rcfaces.core.internal.component.CameliaDataComponent

clearListeners, confirmListenerAppend, constructPhase, constructTemplate, decodePhase, encodeBegin, encodeChildren, encodeEnd, getAsyncRenderer, getCameliaValueAlias, getChildren, getChildrenListState, getDataModelValue, getFamily, getRendererType, getTransientAttribute, getValueExpression, hasDefaultProperties, initializeComponent, initializePhase, isClientRendered, isRendered, isTemplateComponent, processDecodes, processEngineUpdates, processEngineValidators, processUpdates, processValidators, queueEvent, renderPhase, restoreState, saveState, setDefaultProperties, setRendered, setTransientAttribute, setValueExpression, toString, updatePhase, validationPhase, verifyAsyncDecode

Methods inherited from class org.rcfaces.core.internal.component.UIData2

addDecodedIndexes, decodeAdditionalInformation, getFirst, getRowCount, getRowIndex, getRows, isRowAvailable, isSaveCompleteState, iterate, renderColumn, restoreDescendantState, saveDescendantState, setFirst, setRowIndex, setRows, setSaveCompleteState

Methods inherited from class org.rcfaces.core.internal.component.UIData0

broadcast, getClientId, getDataModel, getFooter, getHeader, getRowData, getValue, getVar, invokeOnComponent, setDataModel, setFooter, setHeader, setValue, setValueBinding, setVar

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, decode, findComponent, getAttributes, getChildCount, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendersChildren, getValueBinding, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getContainerClientId

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.rcfaces.core.internal.capability.IGridComponent

getDataModelValue, getFirst, getRowCount, getRowData, getRows, isRowAvailable, setFirst, setRowIndex

Methods inherited from interface org.rcfaces.core.internal.manager.IContainerManager

getChildCount

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

CAMELIA_ATTRIBUTES

protected static final Set CAMELIA_ATTRIBUTES

Constructor Detail

ComponentsGridComponent

public ComponentsGridComponent()

ComponentsGridComponent

public ComponentsGridComponent(String componentId)

Method Detail

getSortedChildren

public UIComponent[] getSortedChildren()

Description copied from interface: ISortedChildrenCapability

Returns a string value giving the ordered list of the sorted components.

Specified by:

getSortedChildren in interface ISortedChildrenCapability

Returns:

ordered list of the sorted components

setSortedChildren

public void setSortedChildren(UIComponent[] components)

Description copied from interface: ISortedChildrenCapability

Set the ordered list of the sorted components

Specified by:

setSortedChildren in interface ISortedChildrenCapability

setOrderedChildren

public void setOrderedChildren(UIComponent[] components)

Description copied from interface: IOrderedChildrenCapability

Sets a list of the columns' id which represents their order from left to right.

Specified by:

setOrderedChildren in interface IOrderedChildrenCapability

Parameters:

components - ordered list of columns' id

getOrderedChildren

public UIComponent[] getOrderedChildren()

Description copied from interface: IOrderedChildrenCapability

Returns a list of the columns' id which represents their order from left to right.

Specified by:

getOrderedChildren in interface IOrderedChildrenCapability

Returns:

ordered list of columns' id

getComponentValueType

public org.rcfaces.core.internal.tools.CollectionTools.IComponentValueType getComponentValueType()

Specified by:

getComponentValueType in interface org.rcfaces.core.internal.tools.CollectionTools.IComponentValueTypeCapability

listColumns

public IColumnIterator listColumns()

Specified by:

listColumns in interface org.rcfaces.core.internal.capability.IGridComponent

listAdditionalInformations

public IAdditionalInformationIterator listAdditionalInformations()

Specified by:

listAdditionalInformations in interface org.rcfaces.core.internal.capability.IAdditionalInformationComponent

setRowValueConverter

public void setRowValueConverter(String converterId)

setRowValueConverter

public void setRowValueConverter(String converterId,
                                 FacesContext facesContext)

setSelectionCardinality

public void setSelectionCardinality(String cardinality)

setClientSelectionFullState

public void setClientSelectionFullState(String state)

getSelectedValuesCount

public int getSelectedValuesCount()

Specified by:

getSelectedValuesCount in interface ISelectionProvider

getFirstSelectedValue

public Object getFirstSelectedValue()

Specified by:

getFirstSelectedValue in interface ISelectionProvider

listSelectedValues

public Object[] listSelectedValues()

Specified by:

listSelectedValues in interface ISelectionProvider

getSelectedValues

public Object getSelectedValues(FacesContext facesContext)

setSelectedValues

public void setSelectedValues(Object selectedValues)

Specified by:

setSelectedValues in interface ISelectionProvider

setAdditionalInformationCardinality

public void setAdditionalInformationCardinality(String cardinality)

setClientAdditionalInformationFullState

public void setClientAdditionalInformationFullState(String state)

getAdditionalInformationValuesCount

public int getAdditionalInformationValuesCount()

Specified by:

getAdditionalInformationValuesCount in interface IAdditionalInformationProvider

getFirstAdditionalInformationValue

public Object getFirstAdditionalInformationValue()

Specified by:

getFirstAdditionalInformationValue in interface IAdditionalInformationProvider

getAdditionalInformationValues

public Object getAdditionalInformationValues(FacesContext facesContext)

listAdditionalInformationValues

public Object[] listAdditionalInformationValues()

Specified by:

listAdditionalInformationValues in interface IAdditionalInformationProvider

getSortedColumns

public ComponentsColumnComponent[] getSortedColumns()

getFirstSortedColumn

public ComponentsColumnComponent getFirstSortedColumn()

setSortedColumn

public void setSortedColumn(ComponentsColumnComponent componentsColumn)

setSortedColumns

public void setSortedColumns(ComponentsColumnComponent[] componentsColumns)

listSortedComponents

public ISortedComponent[] listSortedComponents()

listSortedComponents

public ISortedComponent[] listSortedComponents(FacesContext context)

Specified by:

listSortedComponents in interface org.rcfaces.core.internal.capability.ISortedComponentsCapability

select

public void select(Object rowValue)

Specified by:

select in interface org.rcfaces.core.internal.capability.ISelectionComponent

select

public void select(int index)

Specified by:

select in interface org.rcfaces.core.internal.capability.ISelectionRangeComponent

select

public void select(int[] indices)

Specified by:

select in interface org.rcfaces.core.internal.capability.ISelectionRangeComponent

select

public void select(int start,
                   int end)

Specified by:

select in interface org.rcfaces.core.internal.capability.ISelectionRangeComponent

selectAll

public void selectAll()

Specified by:

selectAll in interface org.rcfaces.core.internal.capability.ISelectionComponent

deselect

public void deselect(Object rowValue)

Specified by:

deselect in interface org.rcfaces.core.internal.capability.ISelectionComponent

deselect

public void deselect(int index)

Specified by:

deselect in interface org.rcfaces.core.internal.capability.ISelectionRangeComponent

deselect

public void deselect(int[] indices)

Specified by:

deselect in interface org.rcfaces.core.internal.capability.ISelectionRangeComponent

deselect

public void deselect(int start,
                     int end)

Specified by:

deselect in interface org.rcfaces.core.internal.capability.ISelectionRangeComponent

deselectAll

public void deselectAll()

Specified by:

deselectAll in interface org.rcfaces.core.internal.capability.ISelectionComponent

showAdditionalInformation

public void showAdditionalInformation(Object rowValue)

Specified by:

showAdditionalInformation in interface org.rcfaces.core.internal.capability.IAdditionalInformationComponent

showAdditionalInformation

public void showAdditionalInformation(int index)

Specified by:

showAdditionalInformation in interface org.rcfaces.core.internal.capability.IAdditionalInformationRangeComponent

showAdditionalInformation

public void showAdditionalInformation(int[] indexes)

Specified by:

showAdditionalInformation in interface org.rcfaces.core.internal.capability.IAdditionalInformationRangeComponent

showAllAdditionalInformations

public void showAllAdditionalInformations()

Specified by:

showAllAdditionalInformations in interface org.rcfaces.core.internal.capability.IAdditionalInformationComponent

hideAdditionalInformation

public void hideAdditionalInformation(Object rowValue)

Specified by:

hideAdditionalInformation in interface org.rcfaces.core.internal.capability.IAdditionalInformationComponent

hideAdditionalInformation

public void hideAdditionalInformation(int index)

Specified by:

hideAdditionalInformation in interface org.rcfaces.core.internal.capability.IAdditionalInformationRangeComponent

hideAdditionalInformation

public void hideAdditionalInformation(int[] indexes)

Specified by:

hideAdditionalInformation in interface org.rcfaces.core.internal.capability.IAdditionalInformationRangeComponent

hideAllAdditionalInformations

public void hideAllAdditionalInformations()

Specified by:

hideAllAdditionalInformations in interface org.rcfaces.core.internal.capability.IAdditionalInformationComponent

addSelectionListener

public final void addSelectionListener(ISelectionListener listener)

Description copied from interface: ISelectionEventCapability

Adds a listener to the component for the selection event

Specified by:

addSelectionListener in interface ISelectionEventCapability

Parameters:

listener - the selection listener to add

removeSelectionListener

public final void removeSelectionListener(ISelectionListener listener)

Description copied from interface: ISelectionEventCapability

Removes a listener from the component for the selection event

Specified by:

removeSelectionListener in interface ISelectionEventCapability

Parameters:

listener - the selection listener to remove

listSelectionListeners

public final FacesListener[] listSelectionListeners()

Description copied from interface: ISelectionEventCapability

Returns a list of selection listener for the component

Specified by:

listSelectionListeners in interface ISelectionEventCapability

Returns:

selection listeners' list

isSelectable

public boolean isSelectable()

Description copied from interface: ISelectableCapability

Returns a boolean value indicating wether the component can receive a user's selection

Specified by:

isSelectable in interface ISelectableCapability

Returns:

selectable boolean property

isSelectable

public boolean isSelectable(FacesContext facesContext)

See isSelectable() for more details

isSelectableSetted

public final boolean isSelectableSetted()

Returns true if the attribute "selectable" is set.

Returns:

true if the attribute is set.

setSelectable

public void setSelectable(boolean selectable)

Description copied from interface: ISelectableCapability

Sets a boolean value indicating wether the component can receive a user's selection

Specified by:

setSelectable in interface ISelectableCapability

Parameters:

selectable - selectable boolean property

getSelectionCardinality

public int getSelectionCardinality()

Description copied from interface: ISelectionCardinalityCapability

Returns an int value specifying the type of multiple selection authorized. cf. ICardinality for constant values

Specified by:

getSelectionCardinality in interface ISelectionCardinalityCapability

Returns:

1: none or one selection|2: any number of selections or none|3: one and only one selection|4: one or more selection

getSelectionCardinality

public int getSelectionCardinality(FacesContext facesContext)

See getSelectionCardinality() for more details

isSelectionCardinalitySetted

public final boolean isSelectionCardinalitySetted()

Returns true if the attribute "selectionCardinality" is set.

Returns:

true if the attribute is set.

setSelectionCardinality

public void setSelectionCardinality(int selectionCardinality)

Description copied from interface: ISelectionCardinalityCapability

Sets an int value specifying the type of multiple selection authorized. cf. ICardinality for constant values

Specified by:

setSelectionCardinality in interface ISelectionCardinalityCapability

Parameters:

selectionCardinality - 1: none or one selection|2: any number of selections or none|3: one and only one selection|4: one or more selection

getSelectedValues

public Object getSelectedValues()

Specified by:

getSelectedValues in interface ISelectionProvider

isSelectedValuesSetted

public final boolean isSelectedValuesSetted()

Returns true if the attribute "selectedValues" is set.

Returns:

true if the attribute is set.

getSelectedValuesType

public Class getSelectedValuesType(FacesContext facesContext)

Return the type of the property represented by the ValueExpression, relative to the specified FacesContext.

Specified by:

getSelectedValuesType in interface ISelectedValuesCapability

getClientSelectionFullState

public int getClientSelectionFullState()

Description copied from interface: IClientSelectionFullStateCapability

Returns a boolean value indicating whether the client should know about the component's full state even if only a part of the data is present (AJAX).

Specified by:

getClientSelectionFullState in interface IClientSelectionFullStateCapability

Returns:

boolean

getClientSelectionFullState

public int getClientSelectionFullState(FacesContext facesContext)

See getClientSelectionFullState() for more details

isClientSelectionFullStateSetted

public final boolean isClientSelectionFullStateSetted()

Returns true if the attribute "clientSelectionFullState" is set.

Returns:

true if the attribute is set.

setClientSelectionFullState

public void setClientSelectionFullState(int clientSelectionFullState)

Description copied from interface: IClientSelectionFullStateCapability

Sets a boolean value indicating whether the client should know about the component's full state even if only a part of the data is present (AJAX).

Specified by:

setClientSelectionFullState in interface IClientSelectionFullStateCapability

Parameters:

clientSelectionFullState - boolean

addAdditionalInformationListener

public final void addAdditionalInformationListener(IAdditionalInformationListener listener)

Description copied from interface: IAdditionalInformationEventCapability

Adds a listener to the component for the additional event

Specified by:

addAdditionalInformationListener in interface IAdditionalInformationEventCapability

Parameters:

listener - the selection listener to add

removeAdditionalInformationListener

public final void removeAdditionalInformationListener(IAdditionalInformationListener listener)

Description copied from interface: IAdditionalInformationEventCapability

Removes a listener from the component for the additional event

Specified by:

removeAdditionalInformationListener in interface IAdditionalInformationEventCapability

Parameters:

listener - the selection listener to remove

listAdditionalInformationListeners

public final FacesListener[] listAdditionalInformationListeners()

Description copied from interface: IAdditionalInformationEventCapability

Returns a list of additional listener for the component

Specified by:

listAdditionalInformationListeners in interface IAdditionalInformationEventCapability

Returns:

selection listeners' list

getAdditionalInformationValues

public Object getAdditionalInformationValues()

Specified by:

getAdditionalInformationValues in interface IAdditionalInformationProvider

isAdditionalInformationValuesSetted

public final boolean isAdditionalInformationValuesSetted()

Returns true if the attribute "additionalInformationValues" is set.

Returns:

true if the attribute is set.

setAdditionalInformationValues

public void setAdditionalInformationValues(Object additionalInformationValues)

Specified by:

setAdditionalInformationValues in interface IAdditionalInformationProvider

getAdditionalInformationValuesType

public Class getAdditionalInformationValuesType(FacesContext facesContext)

Return the type of the property represented by the ValueExpression, relative to the specified FacesContext.

Specified by:

getAdditionalInformationValuesType in interface IAdditionalInformationValuesCapability

getClientAdditionalInformationFullState

public int getClientAdditionalInformationFullState()

Description copied from interface: IClientAdditionalInformationFullStateCapability

Returns an integer value indicating whether the client should know about the component's full state even if only a part of the data is present (AJAX).

Specified by:

getClientAdditionalInformationFullState in interface IClientAdditionalInformationFullStateCapability

Returns:

An integer value indicating whether the client should know about the component's full state.

See Also:

IClientFullStateCapability.NONE_CLIENT_FULL_STATE, IClientFullStateCapability.ONEWAY_CLIENT_FULL_STATE, IClientFullStateCapability.TWOWAYS_CLIENT_FULL_STATE

getClientAdditionalInformationFullState

public int getClientAdditionalInformationFullState(FacesContext facesContext)

See getClientAdditionalInformationFullState() for more details

isClientAdditionalInformationFullStateSetted

public final boolean isClientAdditionalInformationFullStateSetted()

Returns true if the attribute "clientAdditionalInformationFullState" is set.

Returns:

true if the attribute is set.

setClientAdditionalInformationFullState

public void setClientAdditionalInformationFullState(int clientAdditionalInformationFullState)

Description copied from interface: IClientAdditionalInformationFullStateCapability

Sets an integer value indicating whether the client should know about the component's full state even if only a part of the data is present (AJAX).

Specified by:

setClientAdditionalInformationFullState in interface IClientAdditionalInformationFullStateCapability

See Also:

IClientFullStateCapability.NONE_CLIENT_FULL_STATE, IClientFullStateCapability.ONEWAY_CLIENT_FULL_STATE, IClientFullStateCapability.TWOWAYS_CLIENT_FULL_STATE

getAdditionalInformationCardinality

public int getAdditionalInformationCardinality()

Description copied from interface: IAdditionalInformationCardinalityCapability

Returns an int value indicating the cardinality (number of additional-informations allowed) for this component.

Specified by:

getAdditionalInformationCardinality in interface IAdditionalInformationCardinalityCapability

Returns:

1:?,optional|2:*,zeroMany|3:1,one+|4:+,oneMany

getAdditionalInformationCardinality

public int getAdditionalInformationCardinality(FacesContext facesContext)

See getAdditionalInformationCardinality() for more details

isAdditionalInformationCardinalitySetted

public final boolean isAdditionalInformationCardinalitySetted()

Returns true if the attribute "additionalInformationCardinality" is set.

Returns:

true if the attribute is set.

setAdditionalInformationCardinality

public void setAdditionalInformationCardinality(int additionalInformationCardinality)

Description copied from interface: IAdditionalInformationCardinalityCapability

Sets an int value indicating the cardinality (number of additional-informations allowed) for this component.

Specified by:

setAdditionalInformationCardinality in interface IAdditionalInformationCardinalityCapability

Parameters:

additionalInformationCardinality - 1:?,optional|2:*,zeroMany|3:1,one+|4:+,oneMany default=zeroMany

addDoubleClickListener

public final void addDoubleClickListener(IDoubleClickListener listener)

Description copied from interface: IDoubleClickEventCapability

Adds a listener to the component for the doubleClick event

Specified by:

addDoubleClickListener in interface IDoubleClickEventCapability

Parameters:

listener - the doubleClick listener to add

removeDoubleClickListener

public final void removeDoubleClickListener(IDoubleClickListener listener)

Description copied from interface: IDoubleClickEventCapability

Removes a listener from the component for the doubleClick event

Specified by:

removeDoubleClickListener in interface IDoubleClickEventCapability

Parameters:

listener - the doubleClick listener to remove

listDoubleClickListeners

public final FacesListener[] listDoubleClickListeners()

Description copied from interface: IDoubleClickEventCapability

Returns a list of doubleClick listener for the component

Specified by:

listDoubleClickListeners in interface IDoubleClickEventCapability

Returns:

doubleClick listeners' list

addLoadListener

public final void addLoadListener(ILoadListener listener)

Description copied from interface: ILoadEventCapability

Adds a listener to the component for the load event

Specified by:

addLoadListener in interface ILoadEventCapability

Parameters:

listener - the load listener to add

removeLoadListener

public final void removeLoadListener(ILoadListener listener)

Description copied from interface: ILoadEventCapability

Removes a listener from the component for the load event

Specified by:

removeLoadListener in interface ILoadEventCapability

Parameters:

listener - the load listener to remove

listLoadListeners

public final FacesListener[] listLoadListeners()

Description copied from interface: ILoadEventCapability

Returns a list of load listener for the component

Specified by:

listLoadListeners in interface ILoadEventCapability

Returns:

load listeners' list

isRequired

public boolean isRequired()

Description copied from interface: IRequiredCapability

Returns a boolean value indicating that the user is required to provide a submitted value for this input component.

Specified by:

isRequired in interface IRequiredCapability

Returns:

required boolean property

isRequired

public boolean isRequired(FacesContext facesContext)

See isRequired() for more details

isRequiredSetted

public final boolean isRequiredSetted()

Returns true if the attribute "required" is set.

Returns:

true if the attribute is set.

setRequired

public void setRequired(boolean required)

Description copied from interface: IRequiredCapability

Sets a boolean value indicating that the user is required to provide a submitted value for this input component.

Specified by:

setRequired in interface IRequiredCapability

Parameters:

required - required boolean property

isBorder

public boolean isBorder()

Description copied from interface: IBorderCapability

Returns a boolean value that indicates if the component should show a border or not.

Specified by:

isBorder in interface IBorderCapability

Returns:

border

isBorder

public boolean isBorder(FacesContext facesContext)

See isBorder() for more details

isBorderSetted

public final boolean isBorderSetted()

Returns true if the attribute "border" is set.

Returns:

true if the attribute is set.

setBorder

public void setBorder(boolean border)

Description copied from interface: IBorderCapability

Sets a boolean value that indicates if the component should show a border or not.

Specified by:

setBorder in interface IBorderCapability

Parameters:

border - boolean

getRowStyleClass

public String getRowStyleClass()

Specified by:

getRowStyleClass in interface IRowStyleClassCapability

getRowStyleClass

public String getRowStyleClass(FacesContext facesContext)

See getRowStyleClass() for more details

isRowStyleClassSetted

public final boolean isRowStyleClassSetted()

Returns true if the attribute "rowStyleClass" is set.

Returns:

true if the attribute is set.

setRowStyleClass

public void setRowStyleClass(String rowStyleClass)

Specified by:

setRowStyleClass in interface IRowStyleClassCapability

getShowValue

public Object getShowValue()

Specified by:

getShowValue in interface IShowValueCapability

Returns:

The value of the item will be shown.

getShowValue

public Object getShowValue(FacesContext facesContext)

See getShowValue() for more details

isShowValueSetted

public final boolean isShowValueSetted()

Returns true if the attribute "showValue" is set.

Returns:

true if the attribute is set.

setShowValue

public void setShowValue(Object showValue)

Description copied from interface: IShowValueCapability

Set the value of the item will be shown.

Specified by:

setShowValue in interface IShowValueCapability

Parameters:

showValue - The value of the item

getEmptyDataMessage

public String getEmptyDataMessage()

Description copied from interface: IEmptyDataMessageCapability

Returns a string containing the message shown when there is no result.

Specified by:

getEmptyDataMessage in interface IEmptyDataMessageCapability

Returns:

message

getEmptyDataMessage

public String getEmptyDataMessage(FacesContext facesContext)

See getEmptyDataMessage() for more details

isEmptyDataMessageSetted

public final boolean isEmptyDataMessageSetted()

Returns true if the attribute "emptyDataMessage" is set.

Returns:

true if the attribute is set.

setEmptyDataMessage

public void setEmptyDataMessage(String emptyDataMessage)

Description copied from interface: IEmptyDataMessageCapability

Sets the string conatining the message shown when there is no result.

Specified by:

setEmptyDataMessage in interface IEmptyDataMessageCapability

Parameters:

emptyDataMessage - the message

getMenu

public IMenuComponent getMenu()

Description copied from interface: IMenuCapability

Returns the top-most menu associated to the component.

Specified by:

getMenu in interface IMenuCapability

Returns:

top-most menu component

getMenu

public IMenuComponent getMenu(String menuId)

Description copied from interface: IMenuCapability

Returns the menu identified by its id from the menus associated to the component.

Specified by:

getMenu in interface IMenuCapability

Parameters:

menuId - Id for a particular menu

Returns:

menu component

listMenus

public IMenuIterator listMenus()

Description copied from interface: IMenuCapability

Returns a list of all the menus associated to the component.

Specified by:

listMenus in interface IMenuCapability

Returns:

Menu iterator

getHorizontalScrollPosition

public int getHorizontalScrollPosition()

Description copied from interface: IScrollableCapability

Returns an integer value specifying the position of the horizontal scroolbar (browser dependant).

Specified by:

getHorizontalScrollPosition in interface IScrollableCapability

Returns:

horizontal scroll position

getHorizontalScrollPosition

public int getHorizontalScrollPosition(FacesContext facesContext)

See getHorizontalScrollPosition() for more details

isHorizontalScrollPositionSetted

public final boolean isHorizontalScrollPositionSetted()

Returns true if the attribute "horizontalScrollPosition" is set.

Returns:

true if the attribute is set.

setHorizontalScrollPosition

public void setHorizontalScrollPosition(int horizontalScrollPosition)

Description copied from interface: IScrollableCapability

Sets an integer value specifying the position of the horizontal scroolbar (browser dependant).

Specified by:

setHorizontalScrollPosition in interface IScrollableCapability

Parameters:

horizontalScrollPosition - horizontal scroll position

getVerticalScrollPosition

public int getVerticalScrollPosition()

Description copied from interface: IScrollableCapability

Returns an integer value specifying the position of the vertical scroolbar (Browser dependant).

Specified by:

getVerticalScrollPosition in interface IScrollableCapability

Returns:

vertical scroll position

getVerticalScrollPosition

public int getVerticalScrollPosition(FacesContext facesContext)

See getVerticalScrollPosition() for more details

isVerticalScrollPositionSetted

public final boolean isVerticalScrollPositionSetted()

Returns true if the attribute "verticalScrollPosition" is set.

Returns:

true if the attribute is set.

setVerticalScrollPosition

public void setVerticalScrollPosition(int verticalScrollPosition)

Description copied from interface: IScrollableCapability

Sets an integer value specifying the position of the vertical scroolbar (Browser dependant).

Specified by:

setVerticalScrollPosition in interface IScrollableCapability

Parameters:

verticalScrollPosition - vertical scroll position

getPreferences

public IComponentPreferences getPreferences()

Description copied from interface: IPreferencesCapability

Returns an object that holds the preferences for the component.

Specified by:

getPreferences in interface IPreferencesCapability

Returns:

ComponentPreference object

getPreferences

public IComponentPreferences getPreferences(FacesContext facesContext)

See getPreferences() for more details

isPreferencesSetted

public final boolean isPreferencesSetted()

Returns true if the attribute "preferences" is set.

Specified by:

isPreferencesSetted in interface org.rcfaces.core.internal.capability.IPreferencesSettings

Returns:

true if the attribute is set.

setPreferences

public void setPreferences(IComponentPreferences preferences)

Description copied from interface: IPreferencesCapability

Sets an object that holds the preferences for the component.

Specified by:

setPreferences in interface IPreferencesCapability

Parameters:

preferences - ComponentPreference object

isPaged

public boolean isPaged()

Description copied from interface: IPagedCapability

Returns a boolean value specifying wether the results should be displayed by page (thus letting the user choose what page to display via the pager). It is ignored if the attribute "rows" is undefined. The default value is true. If "rows" is defined and "paged"'s value is set to false, pages are downloaded automatically when the last displayed row is selected.

Specified by:

isPaged in interface IPagedCapability

Returns:

true if display by page

isPaged

public boolean isPaged(FacesContext facesContext)

See isPaged() for more details

isPagedSetted

public boolean isPagedSetted()

Specified by:

isPagedSetted in interface IPagedCapability

setPaged

public void setPaged(boolean paged)

Description copied from interface: IPagedCapability

Sets a boolean value specifying wether the results should be displayed by page (thus letting the user choose what page to display via the pager). It is ignored if the attribute "rows" is undefined. The default value is true. If "rows" is defined and "paged"'s value is set to false, pages are downloaded automatically when the last displayed row is selected.

Specified by:

setPaged in interface IPagedCapability

Parameters:

paged - true if display by page

isHeaderVisible

public boolean isHeaderVisible()

Description copied from interface: IHeaderVisibilityCapability

Returns a boolean value indicating wether the header should be visible.

Specified by:

isHeaderVisible in interface IHeaderVisibilityCapability

Returns:

true if the header is visible

isHeaderVisible

public boolean isHeaderVisible(FacesContext facesContext)

See isHeaderVisible() for more details

isHeaderVisibleSetted

public final boolean isHeaderVisibleSetted()

Returns true if the attribute "headerVisible" is set.

Returns:

true if the attribute is set.

setHeaderVisible

public void setHeaderVisible(boolean headerVisible)

Description copied from interface: IHeaderVisibilityCapability

Sets a boolean value indicating wether the header should be visible.

Specified by:

setHeaderVisible in interface IHeaderVisibilityCapability

Parameters:

headerVisible - true if the header should be visible

getRowCountVar

public String getRowCountVar()

Returns a string value specifying the name of the variable receiving the number of rows.

Specified by:

getRowCountVar in interface org.rcfaces.core.internal.capability.IGridComponent

Returns:

variable name

getRowCountVar

public String getRowCountVar(FacesContext facesContext)

Returns a string value specifying the name of the variable receiving the number of rows.

Returns:

variable name

setRowCountVar

public void setRowCountVar(String rowCountVar)

Sets a string value specifying the name of the variable receiving the number of rows.

Parameters:

rowCountVar - variable name

isRowCountVarSetted

public boolean isRowCountVarSetted()

Returns true if the attribute "rowCountVar" is set.

Returns:

true if the attribute is set.

getRowIndexVar

public String getRowIndexVar()

Returns a string value specifying the name of the variable receiving the index of the current row.

Specified by:

getRowIndexVar in interface org.rcfaces.core.internal.capability.IGridComponent

Returns:

variable name

getRowIndexVar

public String getRowIndexVar(FacesContext facesContext)

Returns a string value specifying the name of the variable receiving the index of the current row.

Returns:

variable name

setRowIndexVar

public void setRowIndexVar(String rowIndexVar)

Sets a string value specifying the name of the variable receiving the index of the current row.

Parameters:

rowIndexVar - variable name

isRowIndexVarSetted

public boolean isRowIndexVarSetted()

Returns true if the attribute "rowIndexVar" is set.

Returns:

true if the attribute is set.

getRowValue

public String getRowValue()

getRowValue

public String getRowValue(FacesContext facesContext)

setRowValue

public void setRowValue(String rowValue)

isRowValueSetted

public boolean isRowValueSetted()

Returns true if the attribute "rowValue" is set.

Returns:

true if the attribute is set.

getRowValueConverter

public Converter getRowValueConverter()

getRowValueConverter

public Converter getRowValueConverter(FacesContext facesContext)

setRowValueConverter

public void setRowValueConverter(Converter rowValueConverter)

isRowValueConverterSetted

public boolean isRowValueConverterSetted()

Returns true if the attribute "rowValueConverter" is set.

Returns:

true if the attribute is set.

isCellTextWrap

public boolean isCellTextWrap()

isCellTextWrap

public boolean isCellTextWrap(FacesContext facesContext)

setCellTextWrap

public void setCellTextWrap(boolean cellTextWrap)

isCellTextWrapSetted

public boolean isCellTextWrapSetted()

Returns true if the attribute "cellTextWrap" is set.

Returns:

true if the attribute is set.

getCameliaFields

protected Set getCameliaFields()

Overrides:

getCameliaFields in class AbstractDataComponent