org.rcfaces.core.component
Class ComponentsListComponent

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.ComponentsListComponent

All Implemented Interfaces:

NamingContainer, StateHolder, IAlertLoadingMessageCapability, IBorderCapability, IBorderTypeCapability, IClientDataCapability, IErrorEventCapability, IFocusBlurEventCapability, IForegroundBackgroundColorCapability, IHeightCapability, IHelpCapability, IHiddenModeCapability, IImmediateCapability, IInitEventCapability, IKeyDownEventCapability, IKeyEventCapability, IKeyPressEventCapability, IKeyUpEventCapability, ILayoutPositionCapability, ILookAndFeelCapability, IMarginCapability, IMenuCapability, IMouseEventCapability, IPartialRenderingCapability, IPositionCapability, IPropertyChangeEventCapability, IResetEventCapability, IScrollableCapability, IServerDataCapability, IShowValueCapability, ISizeCapability, ISortEventCapability, ISortManagerCapability, IStyleClassCapability, ITabIndexCapability, IToolTipCapability, IUnlockedClientAttributesCapability, IUserEventCapability, IVisibilityCapability, IWAIRoleCapability, IWheelSelectionCapability, IWidthCapability, org.rcfaces.core.internal.capability.IComponentLifeCycle, org.rcfaces.core.internal.capability.IRCFacesComponent, org.rcfaces.core.internal.manager.IClientDataManager, org.rcfaces.core.internal.manager.IContainerManager, org.rcfaces.core.internal.manager.IServerDataManager, org.rcfaces.core.internal.manager.ITransientAttributesManager

public class ComponentsListComponent
extends AbstractDataComponent
implements IMenuCapability, IBorderCapability, IBorderTypeCapability, IScrollableCapability, IShowValueCapability

The componentslist component Shows the components for each data with pagination.

The componentslist Component has the following capabilities :

• IMenuCapability
• IBorderCapability
• IBorderTypeCapability
• IScrollableCapability
• IShowValueCapability

The default componentsList renderer is link to the f_componentslist javascript class. f_componentslist extends f_component, fa_pagedComponent

Table of component style classes:

Style Name	Description
f_componentslist	Defines styles for the wrapper DIV element. Contains a Table
f_componentslist_cell	Defines styles for the wrapper TD element for the row.

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.IBorderTypeCapability

NONE_BORDER_TYPE_NAME

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

ComponentsListComponent()

ComponentsListComponent(String componentId)

Method Summary

String	getBorderType() Returns a string that indicates the type of border the component should show.
String	getBorderType(FacesContext facesContext) See getBorderType() for more details
protected Set	getCameliaFields()
int	getColumnNumber() Returns an int value holding the width of the component in characters : x characters translates into y pixels width.
int	getColumnNumber(FacesContext facesContext) Returns an int value holding the width of the component in characters : x characters translates into y pixels width.
String	getColumnStyleClass() Returns a space-separated list of CSS style class(es) to be applied when this column is rendered.
String	getColumnStyleClass(FacesContext facesContext) Returns a space-separated list of CSS style class(es) to be applied when this column is rendered.
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.
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() Returns a space-separated list of CSS style class(es) to be applied when the row is rendered.
String	getRowStyleClass(FacesContext facesContext) Returns a space-separated list of CSS style class(es) to be applied when the row is rendered.
Object	getShowValue()
Object	getShowValue(FacesContext facesContext) See getShowValue() for more details
int	getVerticalScrollPosition() Returns an integer value specifying the position of the vertical scroolbar (Browser dependant).
int	getVerticalScrollPosition(FacesContext facesContext) See getVerticalScrollPosition() for more details
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	isBorderTypeSetted() Returns true if the attribute "borderType" is set.
boolean	isColumnNumberSetted() Returns true if the attribute "columnNumber" is set.
boolean	isColumnStyleClassSetted() Returns true if the attribute "columnStyleClass" is set.
boolean	isHorizontalScrollPositionSetted() Returns true if the attribute "horizontalScrollPosition" 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	isShowValueSetted() Returns true if the attribute "showValue" is set.
boolean	isVerticalScrollPositionSetted() Returns true if the attribute "verticalScrollPosition" is set.
IMenuIterator	listMenus() Returns a list of all the menus associated to the component.
void	setBorder(boolean border) Sets a boolean value that indicates if the component should show a border or not.
void	setBorderType(String borderType) Sets a string that indicates the type of border the component should show.
void	setColumnNumber(int columnNumber) Sets an int value holding the width of the component in characters : x characters translates into y pixels width.
void	setColumnStyleClass(String columnStyleClass) Sets a space-separated list of CSS style class(es) to be applied when this column is rendered.
void	setHorizontalScrollPosition(int horizontalScrollPosition) Sets an integer value specifying the position of the horizontal scroolbar (browser dependant).
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) Sets a space-separated list of CSS style class(es) to be applied when the row is rendered.
void	setShowValue(Object showValue) Set the value of the item will be shown.
void	setVerticalScrollPosition(int verticalScrollPosition) Sets an integer value specifying the position of the vertical scroolbar (Browser dependant).

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.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

ComponentsListComponent

public ComponentsListComponent()

ComponentsListComponent

public ComponentsListComponent(String componentId)

Method Detail

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

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

getBorderType

public String getBorderType()

Description copied from interface: IBorderTypeCapability

Returns a string that indicates the type of border the component should show.

Specified by:

getBorderType in interface IBorderTypeCapability

Returns:

none|solid|relief|flat|rounded

getBorderType

public String getBorderType(FacesContext facesContext)

See getBorderType() for more details

isBorderTypeSetted

public final boolean isBorderTypeSetted()

Returns true if the attribute "borderType" is set.

Returns:

true if the attribute is set.

setBorderType

public void setBorderType(String borderType)

Description copied from interface: IBorderTypeCapability

Sets a string that indicates the type of border the component should show.

Specified by:

setBorderType in interface IBorderTypeCapability

Parameters:

borderType - none|solid|relief|flat|rounded

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

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

getRowCountVar

public String getRowCountVar()

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

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.

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.

getColumnNumber

public int getColumnNumber()

Returns an int value holding the width of the component in characters : x characters translates into y pixels width.

Returns:

width in characters

getColumnNumber

public int getColumnNumber(FacesContext facesContext)

Returns an int value holding the width of the component in characters : x characters translates into y pixels width.

Returns:

width in characters

setColumnNumber

public void setColumnNumber(int columnNumber)

Sets an int value holding the width of the component in characters : x characters translates into y pixels width.

Parameters:

columnNumber - width in characters

isColumnNumberSetted

public boolean isColumnNumberSetted()

Returns true if the attribute "columnNumber" is set.

Returns:

true if the attribute is set.

getRowStyleClass

public String getRowStyleClass()

Returns a space-separated list of CSS style class(es) to be applied when the row is rendered. This value will be passed through as the "class" attribute on generated markup.

Returns:

list of CSS style classes

getRowStyleClass

public String getRowStyleClass(FacesContext facesContext)

Returns a space-separated list of CSS style class(es) to be applied when the row is rendered. This value will be passed through as the "class" attribute on generated markup.

Returns:

list of CSS style classes

setRowStyleClass

public void setRowStyleClass(String rowStyleClass)

Sets a space-separated list of CSS style class(es) to be applied when the row is rendered. This value will be passed through as the "class" attribute on generated markup.

Parameters:

rowStyleClass - list of CSS style classes

isRowStyleClassSetted

public boolean isRowStyleClassSetted()

Returns true if the attribute "rowStyleClass" is set.

Returns:

true if the attribute is set.

getColumnStyleClass

public String getColumnStyleClass()

Returns a space-separated list of CSS style class(es) to be applied when this column is rendered. This value will be passed through as the "class" attribute on generated markup.

Returns:

list of CSS style classes

getColumnStyleClass

public String getColumnStyleClass(FacesContext facesContext)

Returns a space-separated list of CSS style class(es) to be applied when this column is rendered. This value will be passed through as the "class" attribute on generated markup.

Returns:

list of CSS style classes

setColumnStyleClass

public void setColumnStyleClass(String columnStyleClass)

Sets a space-separated list of CSS style class(es) to be applied when this column is rendered. This value will be passed through as the "class" attribute on generated markup.

Parameters:

columnStyleClass - list of CSS style classes

isColumnStyleClassSetted

public boolean isColumnStyleClassSetted()

Returns true if the attribute "columnStyleClass" is set.

Returns:

true if the attribute is set.

getCameliaFields

protected Set getCameliaFields()

Overrides:

getCameliaFields in class AbstractDataComponent