org.rcfaces.core.component
Class PagerComponent

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by org.rcfaces.core.internal.component.CameliaBaseComponent
              extended by org.rcfaces.core.component.AbstractBasicComponent
                  extended by org.rcfaces.core.component.PagerComponent
All Implemented Interfaces:
StateHolder, IClientDataCapability, IErrorEventCapability, IForCapability, IForegroundBackgroundColorCapability, IHeightCapability, IHelpCapability, IHiddenModeCapability, ILayoutPositionCapability, ILookAndFeelCapability, IMarginCapability, IPagerMessageCapability, IPartialRenderingCapability, IPositionCapability, IPropertyChangeEventCapability, IServerDataCapability, ISizeCapability, IStyleClassCapability, IToolTipCapability, IUnlockedClientAttributesCapability, IUserEventCapability, IVisibilityCapability, IWAIRoleCapability, 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 PagerComponent
extends AbstractBasicComponent
implements IForCapability, IPagerMessageCapability

The pager Component is linked to the dataGrid Component. It shows informations about the result set (ex: number of available pages) and can give direct access to a specific page ("a la Google").

The pager Component has the following capabilities :

The default pager renderer is linked to the f_pager javascript class. f_pager extends f_component, fa_pager

Table of component style classes:

Style Name Description
f_pager Defines styles for the wrapper DIV element
f_pager_button_first Defines styles for the wrapper SPAN element
f_pager_button_next Defines styles for the wrapper SPAN element
f_pager_button_last Defines styles for the wrapper SPAN element
f_pager_button_prev Defines styles for the wrapper SPAN element


Field Summary
protected static Set CAMELIA_ATTRIBUTES
           
static String COMPONENT_TYPE
           
 
Fields inherited from class org.rcfaces.core.internal.component.CameliaBaseComponent
engine
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
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
 
Constructor Summary
PagerComponent()
           
PagerComponent(String componentId)
           
 
Method Summary
protected  Set getCameliaFields()
           
 String getFor()
          Returns a component's id that express the link between the two components.
 String getFor(FacesContext facesContext)
          See getFor() for more details
 String getManyResultsMessage()
           
 String getManyResultsMessage(FacesContext facesContext)
          See getManyResultsMessage() for more details
 String getMessage()
           
 String getMessage(FacesContext facesContext)
          See getMessage() for more details
 String getNoPagedMessage()
          Returns a string specifying the message to display when there is no row to display.
 String getNoPagedMessage(FacesContext facesContext)
          Returns a string specifying the message to display when there is no row to display.
 String getOneResultMessage()
           
 String getOneResultMessage(FacesContext facesContext)
          See getOneResultMessage() for more details
 String getZeroResultMessage()
           
 String getZeroResultMessage(FacesContext facesContext)
          See getZeroResultMessage() for more details
 boolean isForSetted()
          Returns true if the attribute "for" is set.
 boolean isManyResultsMessageSetted()
          Returns true if the attribute "manyResultsMessage" is set.
 boolean isMessageSetted()
          Returns true if the attribute "message" is set.
 boolean isNoPagedMessageSetted()
          Returns true if the attribute "noPagedMessage" is set.
 boolean isOneResultMessageSetted()
          Returns true if the attribute "oneResultMessage" is set.
 boolean isZeroResultMessageSetted()
          Returns true if the attribute "zeroResultMessage" is set.
 void setFor(String forValue)
          Sets a component's id that express the link between the two components.
 void setManyResultsMessage(String manyResultsMessage)
           
 void setMessage(String message)
           
 void setNoPagedMessage(String noPagedMessage)
          Steps a string specifying the message to display when there is no row to display.
 void setOneResultMessage(String oneResultMessage)
           
 void setZeroResultMessage(String zeroResultMessage)
           
 
Methods inherited from class org.rcfaces.core.component.AbstractBasicComponent
addErrorListener, addPropertyChangeListener, addUserEventListener, 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, getStyleClass, getStyleClass, getToolTipText, getToolTipText, getTop, getTop, getUnlockedClientAttributeNames, getUnlockedClientAttributeNames, getVisibleState, getVisibleState, getWaiRole, getWaiRole, getWidth, getWidth, getX, getX, getY, getY, isAriaLabelSetted, isAriaLevelSetted, isBackgroundColorSetted, isBottomSetted, isForegroundColorSetted, isHeightSetted, isHelpMessageSetted, isHelpURLSetted, isHiddenModeSetted, isLeftSetted, isLookIdSetted, isMarginBottomSetted, isMarginLeftSetted, isMarginRightSetted, isMarginTopSetted, isPartialRendering, isPartialRendering, isPartialRenderingSetted, isRightSetted, isStyleClassSetted, isToolTipTextSetted, isTopSetted, isUnlockedClientAttributeNamesSetted, isVisible, isVisible, isVisibleSetted, isWaiRoleSetted, isWidthSetted, isXSetted, isYSetted, listClientDataKeys, listClientDataKeys, listErrorListeners, listPropertyChangeListeners, listServerDataKeys, listServerDataKeys, listUserEventListeners, removeClientData, removeErrorListener, removePropertyChangeListener, removeServerData, removeUserEventListener, setAriaLabel, setAriaLevel, setBackgroundColor, setBottom, setClientData, setClientData, setForegroundColor, setHeight, setHelpMessage, setHelpURL, setHiddenMode, setHiddenMode, setLeft, setLookId, setMarginBottom, setMarginLeft, setMarginRight, setMargins, setMarginTop, setPartialRendering, setRight, setServerData, setServerData, setStyleClass, setToolTipText, setTop, setUnlockedClientAttributeNames, setVisible, setWaiRole, setWidth, setX, setY
 
Methods inherited from class org.rcfaces.core.internal.component.CameliaBaseComponent
clearListeners, confirmListenerAppend, constructPhase, constructTemplate, decodePhase, encodeBegin, encodeChildren, encodeEnd, getAsyncRenderer, getCameliaValueAlias, getChildren, getChildrenListState, 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 javax.faces.component.UIComponentBase
addFacesListener, broadcast, decode, findComponent, getAttributes, getChildCount, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendersChildren, getValueBinding, invokeOnComponent, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
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

PagerComponent

public PagerComponent()

PagerComponent

public PagerComponent(String componentId)
Method Detail

getFor

public String getFor()
Description copied from interface: IForCapability
Returns a component's id that express the link between the two components.

Specified by:
getFor in interface IForCapability
Returns:
id for a linked component

getFor

public String getFor(FacesContext facesContext)
See getFor() for more details


isForSetted

public final boolean isForSetted()
Returns true if the attribute "for" is set.

Returns:
true if the attribute is set.

setFor

public void setFor(String forValue)
Description copied from interface: IForCapability
Sets a component's id that express the link between the two components.

Specified by:
setFor in interface IForCapability
Parameters:
forValue - id for a linked component

getManyResultsMessage

public String getManyResultsMessage()
Specified by:
getManyResultsMessage in interface IPagerMessageCapability

getManyResultsMessage

public String getManyResultsMessage(FacesContext facesContext)
See getManyResultsMessage() for more details


isManyResultsMessageSetted

public final boolean isManyResultsMessageSetted()
Returns true if the attribute "manyResultsMessage" is set.

Returns:
true if the attribute is set.

setManyResultsMessage

public void setManyResultsMessage(String manyResultsMessage)
Specified by:
setManyResultsMessage in interface IPagerMessageCapability

getMessage

public String getMessage()
Specified by:
getMessage in interface IPagerMessageCapability

getMessage

public String getMessage(FacesContext facesContext)
See getMessage() for more details


isMessageSetted

public final boolean isMessageSetted()
Returns true if the attribute "message" is set.

Returns:
true if the attribute is set.

setMessage

public void setMessage(String message)
Specified by:
setMessage in interface IPagerMessageCapability

getOneResultMessage

public String getOneResultMessage()
Specified by:
getOneResultMessage in interface IPagerMessageCapability

getOneResultMessage

public String getOneResultMessage(FacesContext facesContext)
See getOneResultMessage() for more details


isOneResultMessageSetted

public final boolean isOneResultMessageSetted()
Returns true if the attribute "oneResultMessage" is set.

Returns:
true if the attribute is set.

setOneResultMessage

public void setOneResultMessage(String oneResultMessage)
Specified by:
setOneResultMessage in interface IPagerMessageCapability

getZeroResultMessage

public String getZeroResultMessage()
Specified by:
getZeroResultMessage in interface IPagerMessageCapability

getZeroResultMessage

public String getZeroResultMessage(FacesContext facesContext)
See getZeroResultMessage() for more details


isZeroResultMessageSetted

public final boolean isZeroResultMessageSetted()
Returns true if the attribute "zeroResultMessage" is set.

Returns:
true if the attribute is set.

setZeroResultMessage

public void setZeroResultMessage(String zeroResultMessage)
Specified by:
setZeroResultMessage in interface IPagerMessageCapability

getNoPagedMessage

public String getNoPagedMessage()
Returns a string specifying the message to display when there is no row to display.

Returns:
message

getNoPagedMessage

public String getNoPagedMessage(FacesContext facesContext)
Returns a string specifying the message to display when there is no row to display.

Returns:
message

setNoPagedMessage

public void setNoPagedMessage(String noPagedMessage)
Steps a string specifying the message to display when there is no row to display.

Parameters:
noPagedMessage - message

isNoPagedMessageSetted

public boolean isNoPagedMessageSetted()
Returns true if the attribute "noPagedMessage" is set.

Returns:
true if the attribute is set.

getCameliaFields

protected Set getCameliaFields()
Overrides:
getCameliaFields in class AbstractBasicComponent


Copyright © 2006-2011 Vedana. All Rights Reserved.