org.apache.myfaces.custom.datascroller
Class HtmlDataScroller

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIPanel
              extended by org.apache.myfaces.custom.datascroller.AbstractHtmlDataScroller
                  extended by org.apache.myfaces.custom.datascroller.HtmlDataScroller
All Implemented Interfaces:
EventListener, javax.faces.component.ActionSource, javax.faces.component.ActionSource2, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, DisplayValueOnlyAware, ForceIdAware, StyleAware, UniversalProperties, UserRoleAware, DisplayValueOnlyCapable

public class HtmlDataScroller
extends AbstractHtmlDataScroller


Nested Class Summary
protected static class HtmlDataScroller.PropertyKeys
           
 
Field Summary
static String COMPONENT_FAMILY
           
static String COMPONENT_TYPE
           
static String DEFAULT_RENDERER_TYPE
           
 
Fields inherited from class org.apache.myfaces.custom.datascroller.AbstractHtmlDataScroller
FACET_FAST_FORWARD, FACET_FAST_REWIND, FACET_FIRST, FACET_LAST, FACET_NEXT, FACET_PREVIOUS
 
Fields inherited from class javax.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY
 
Fields inherited from interface org.apache.myfaces.component.UserRoleAware
ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR
 
Fields inherited from interface org.apache.myfaces.shared_tomahawk.component.DisplayValueOnlyCapable
DISPLAY_VALUE_ONLY_ATTR, DISPLAY_VALUE_ONLY_STYLE_ATTR, DISPLAY_VALUE_ONLY_STYLE_CLASS_ATTR
 
Constructor Summary
HtmlDataScroller()
           
 
Method Summary
 void addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
           
 int getColspan()
          standard html colspan attribute for table cell
 String getDefaultEventName()
           
 String getDir()
          HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
 String getDisplayedRowsCountVar()
          A parameter name, under which the actual displayed rows count is set in request scope similar to the var parameter.
 Boolean getDisplayValueOnly()
          If true, renders only the value of the component, but no input widget.
 String getDisplayValueOnlyStyle()
          Style used when displayValueOnly is true.
 String getDisplayValueOnlyStyleClass()
          Style class used when displayValueOnly is true.
 String getEnabledOnUserRole()
          If user is in given role, this component will be rendered normally.
 Collection<String> getEventNames()
           
 String getFamily()
           
 String getFastfStyleClass()
          style-class for data-scroller fast-forward-element
 String getFastrStyleClass()
          style-class for data-scroller fast-rewind-element
 int getFastStep()
          step (pages) used for fastforward and fastrewind
 String getFirstRowIndexVar()
          A parameter name, under which the actual first displayed row index is set in request scope similar to the var parameter.
 String getFirstStyleClass()
          style-class for data-scroller first-element
 String getFor()
          The JSF id of a UIData component that this scroller will affect.
 String getLang()
          HTML: The base language of this document.
 String getLastRowIndexVar()
          A parameter name, under which the actual last displayed row index is set in request scope similar to the var parameter.
 String getLastStyleClass()
          style-class for data-scroller last-element
 String getLayout()
          The layout this scroller should render with.
 String getNextStyleClass()
          style-class for dataScroller next-element
 String getOnclick()
          HTML: Script to be invoked when the element is clicked.
 String getOndblclick()
          HTML: Script to be invoked when the element is double-clicked.
 String getPageCountVar()
          A parameter name, under which the actual page count is set in request scope similar to the var parameter.
 String getPageIndexVar()
          A parameter name, under which the actual page index is set in request scope similar to the var parameter.
 String getPaginatorActiveColumnClass()
          styleClass for paginator's column with pageIndex = currentPageIndex
 String getPaginatorActiveColumnStyle()
          style for paginator's column with pageIndex = currentPageIndex
 String getPaginatorColumnClass()
          styleClass for paginator's column
 String getPaginatorColumnStyle()
          style for paginator's column
 int getPaginatorMaxPages()
          The maximum amount of pages to be displayed in the paginator.
 String getPaginatorTableClass()
          styleclass for pagingator
 String getPaginatorTableStyle()
          style for pagingator
 String getPreviousStyleClass()
          style-class for data-scroller previous-element
 String getRowsCountVar()
          A parameter name, under which the actual rows count is set in request scope similar to the var parameter.
 String getStyle()
          HTML: CSS styling instructions.
 String getStyleClass()
          The CSS class for this element.
 String getTitle()
          HTML: An advisory title for this element.
 String getVisibleOnUserRole()
          If user is in given role, this component will be rendered normally.
 boolean isDisableFacetLinksIfFirstPage()
          If the dataScroller is on the first page (index is at 1), links for first, prev and fastprev are disabled.
 boolean isDisableFacetLinksIfLastPage()
          If the dataScroller is on the last page (index is at pagecount), links for last, next and fastnext are disabled.
 boolean isForceId()
          If true, this component will force the use of the specified id when rendering.
 boolean isForceIdIndex()
          If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.)
 boolean isImmediate()
          True means that the default ActionListener should be executed immediately (i.e.
 boolean isPaginator()
          If set true, then the paginator gets rendered
 boolean isPaginatorRenderLinkForActive()
          'true' - render a link for the paginator's column with pageIndex = currentPageIndex.
 boolean isRenderFacetLinksIfFirstPage()
          If the dataScroller is on the first page (index is at 1), links for first, prev and fastprev are rendered.
 boolean isRenderFacetLinksIfLastPage()
          If the dataScroller is on the last page (index is at pagecount), links for last, next and fastnext are rendered.
 boolean isRenderFacetsIfSinglePage()
          If set to false, the facets aren't renderd if all the lines are contained on a single page.
 void setColspan(int colspan)
           
 void setDir(String dir)
           
 void setDisableFacetLinksIfFirstPage(boolean disableFacetLinksIfFirstPage)
           
 void setDisableFacetLinksIfLastPage(boolean disableFacetLinksIfLastPage)
           
 void setDisplayedRowsCountVar(String displayedRowsCountVar)
           
 void setDisplayValueOnly(Boolean displayValueOnly)
           
 void setDisplayValueOnlyStyle(String displayValueOnlyStyle)
           
 void setDisplayValueOnlyStyleClass(String displayValueOnlyStyleClass)
           
 void setEnabledOnUserRole(String enabledOnUserRole)
           
 void setFastfStyleClass(String fastfStyleClass)
           
 void setFastrStyleClass(String fastrStyleClass)
           
 void setFastStep(int fastStep)
           
 void setFirstRowIndexVar(String firstRowIndexVar)
           
 void setFirstStyleClass(String firstStyleClass)
           
 void setFor(String forParam)
           
 void setForceId(boolean forceId)
           
 void setForceIdIndex(boolean forceIdIndex)
           
 void setImmediate(boolean immediate)
           
 void setLang(String lang)
           
 void setLastRowIndexVar(String lastRowIndexVar)
           
 void setLastStyleClass(String lastStyleClass)
           
 void setLayout(String layout)
           
 void setNextStyleClass(String nextStyleClass)
           
 void setOnclick(String onclick)
           
 void setOndblclick(String ondblclick)
           
 void setPageCountVar(String pageCountVar)
           
 void setPageIndexVar(String pageIndexVar)
           
 void setPaginator(boolean paginator)
           
 void setPaginatorActiveColumnClass(String paginatorActiveColumnClass)
           
 void setPaginatorActiveColumnStyle(String paginatorActiveColumnStyle)
           
 void setPaginatorColumnClass(String paginatorColumnClass)
           
 void setPaginatorColumnStyle(String paginatorColumnStyle)
           
 void setPaginatorMaxPages(int paginatorMaxPages)
           
 void setPaginatorRenderLinkForActive(boolean paginatorRenderLinkForActive)
           
 void setPaginatorTableClass(String paginatorTableClass)
           
 void setPaginatorTableStyle(String paginatorTableStyle)
           
 void setPreviousStyleClass(String previousStyleClass)
           
 void setRenderFacetLinksIfFirstPage(boolean renderFacetLinksIfFirstPage)
           
 void setRenderFacetLinksIfLastPage(boolean renderFacetLinksIfLastPage)
           
 void setRenderFacetsIfSinglePage(boolean renderFacetsIfSinglePage)
           
 void setRowsCountVar(String rowsCountVar)
           
 void setStyle(String style)
           
 void setStyleClass(String styleClass)
           
 void setTitle(String title)
           
 void setValueBinding(String name, javax.faces.el.ValueBinding binding)
           
 void setValueExpression(String name, javax.el.ValueExpression expression)
           
 void setVisibleOnUserRole(String visibleOnUserRole)
           
 
Methods inherited from class org.apache.myfaces.custom.datascroller.AbstractHtmlDataScroller
addActionListener, broadcast, broadcastToActionListener, findUIData, getAction, getActionExpression, getActionListener, getActionListeners, getClientId, getFastForward, getFastRewind, getFirst, getFirstRow, getLast, getNext, getPageCount, getPageIndex, getPrevious, getRendersChildren, getRowCount, getRows, getUIData, isDisplayValueOnly, isListLayout, isRendered, isSetDisplayValueOnly, isSingleElementLayout, queueEvent, removeActionListener, restoreState, saveState, setAction, setActionExpression, setActionListener, setDisplayValueOnly, setFastForward, setFastRewind, setFirst, setFirst, setLast, setNext, setPrevious
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getValueBinding, initialStateMarked, invokeOnComponent, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, visitTree
 
Methods inherited from class javax.faces.component.UIComponent
getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, subscribeToEvent, unsubscribeFromEvent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder
getClientBehaviors
 

Field Detail

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY
See Also:
Constant Field Values

COMPONENT_TYPE

public static final String COMPONENT_TYPE
See Also:
Constant Field Values

DEFAULT_RENDERER_TYPE

public static final String DEFAULT_RENDERER_TYPE
See Also:
Constant Field Values
Constructor Detail

HtmlDataScroller

public HtmlDataScroller()
Method Detail

getFamily

public String getFamily()
Overrides:
getFamily in class javax.faces.component.UIPanel

getEventNames

public Collection<String> getEventNames()
Specified by:
getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder
Overrides:
getEventNames in class javax.faces.component.UIComponentBase

addClientBehavior

public void addClientBehavior(String eventName,
                              javax.faces.component.behavior.ClientBehavior behavior)
Specified by:
addClientBehavior in interface javax.faces.component.behavior.ClientBehaviorHolder
Overrides:
addClientBehavior in class javax.faces.component.UIComponentBase

getDefaultEventName

public String getDefaultEventName()
Specified by:
getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder
Overrides:
getDefaultEventName in class javax.faces.component.UIComponentBase

getLayout

public String getLayout()
Description copied from class: AbstractHtmlDataScroller
The layout this scroller should render with. Default is 'table', 'list' is implemented as well. Additionally you can use 'singleList' - then the data-scroller will render a list, but not the paginator - same with the value 'singleTable'.

Specified by:
getLayout in class AbstractHtmlDataScroller

setLayout

public void setLayout(String layout)

getColspan

public int getColspan()
Description copied from class: AbstractHtmlDataScroller
standard html colspan attribute for table cell

Specified by:
getColspan in class AbstractHtmlDataScroller

setColspan

public void setColspan(int colspan)

getOnclick

public String getOnclick()
Description copied from class: AbstractHtmlDataScroller
HTML: Script to be invoked when the element is clicked.

Specified by:
getOnclick in class AbstractHtmlDataScroller

setOnclick

public void setOnclick(String onclick)

getOndblclick

public String getOndblclick()
Description copied from class: AbstractHtmlDataScroller
HTML: Script to be invoked when the element is double-clicked.

Specified by:
getOndblclick in class AbstractHtmlDataScroller

setOndblclick

public void setOndblclick(String ondblclick)

getFor

public String getFor()
Description copied from class: AbstractHtmlDataScroller
The JSF id of a UIData component that this scroller will affect. If this attribute is not present then the datascroller must be a child of a UIData component.

Specified by:
getFor in class AbstractHtmlDataScroller

setFor

public void setFor(String forParam)

getFastStep

public int getFastStep()
Description copied from class: AbstractHtmlDataScroller
step (pages) used for fastforward and fastrewind

Specified by:
getFastStep in class AbstractHtmlDataScroller

setFastStep

public void setFastStep(int fastStep)

getPageIndexVar

public String getPageIndexVar()
Description copied from class: AbstractHtmlDataScroller
A parameter name, under which the actual page index is set in request scope similar to the var parameter.

Specified by:
getPageIndexVar in class AbstractHtmlDataScroller

setPageIndexVar

public void setPageIndexVar(String pageIndexVar)

getPageCountVar

public String getPageCountVar()
Description copied from class: AbstractHtmlDataScroller
A parameter name, under which the actual page count is set in request scope similar to the var parameter.

Specified by:
getPageCountVar in class AbstractHtmlDataScroller

setPageCountVar

public void setPageCountVar(String pageCountVar)

getRowsCountVar

public String getRowsCountVar()
Description copied from class: AbstractHtmlDataScroller
A parameter name, under which the actual rows count is set in request scope similar to the var parameter.

Specified by:
getRowsCountVar in class AbstractHtmlDataScroller

setRowsCountVar

public void setRowsCountVar(String rowsCountVar)

getDisplayedRowsCountVar

public String getDisplayedRowsCountVar()
Description copied from class: AbstractHtmlDataScroller
A parameter name, under which the actual displayed rows count is set in request scope similar to the var parameter.

Specified by:
getDisplayedRowsCountVar in class AbstractHtmlDataScroller

setDisplayedRowsCountVar

public void setDisplayedRowsCountVar(String displayedRowsCountVar)

getFirstRowIndexVar

public String getFirstRowIndexVar()
Description copied from class: AbstractHtmlDataScroller
A parameter name, under which the actual first displayed row index is set in request scope similar to the var parameter.

Specified by:
getFirstRowIndexVar in class AbstractHtmlDataScroller

setFirstRowIndexVar

public void setFirstRowIndexVar(String firstRowIndexVar)

getLastRowIndexVar

public String getLastRowIndexVar()
Description copied from class: AbstractHtmlDataScroller
A parameter name, under which the actual last displayed row index is set in request scope similar to the var parameter.

Specified by:
getLastRowIndexVar in class AbstractHtmlDataScroller

setLastRowIndexVar

public void setLastRowIndexVar(String lastRowIndexVar)

isPaginator

public boolean isPaginator()
Description copied from class: AbstractHtmlDataScroller
If set true, then the paginator gets rendered

Specified by:
isPaginator in class AbstractHtmlDataScroller

setPaginator

public void setPaginator(boolean paginator)

getPaginatorMaxPages

public int getPaginatorMaxPages()
Description copied from class: AbstractHtmlDataScroller
The maximum amount of pages to be displayed in the paginator.

Specified by:
getPaginatorMaxPages in class AbstractHtmlDataScroller

setPaginatorMaxPages

public void setPaginatorMaxPages(int paginatorMaxPages)

getPaginatorTableClass

public String getPaginatorTableClass()
Description copied from class: AbstractHtmlDataScroller
styleclass for pagingator

Specified by:
getPaginatorTableClass in class AbstractHtmlDataScroller

setPaginatorTableClass

public void setPaginatorTableClass(String paginatorTableClass)

getPaginatorTableStyle

public String getPaginatorTableStyle()
Description copied from class: AbstractHtmlDataScroller
style for pagingator

Specified by:
getPaginatorTableStyle in class AbstractHtmlDataScroller

setPaginatorTableStyle

public void setPaginatorTableStyle(String paginatorTableStyle)

getPaginatorColumnClass

public String getPaginatorColumnClass()
Description copied from class: AbstractHtmlDataScroller
styleClass for paginator's column

Specified by:
getPaginatorColumnClass in class AbstractHtmlDataScroller

setPaginatorColumnClass

public void setPaginatorColumnClass(String paginatorColumnClass)

getPaginatorColumnStyle

public String getPaginatorColumnStyle()
Description copied from class: AbstractHtmlDataScroller
style for paginator's column

Specified by:
getPaginatorColumnStyle in class AbstractHtmlDataScroller

setPaginatorColumnStyle

public void setPaginatorColumnStyle(String paginatorColumnStyle)

getPaginatorActiveColumnClass

public String getPaginatorActiveColumnClass()
Description copied from class: AbstractHtmlDataScroller
styleClass for paginator's column with pageIndex = currentPageIndex

Specified by:
getPaginatorActiveColumnClass in class AbstractHtmlDataScroller

setPaginatorActiveColumnClass

public void setPaginatorActiveColumnClass(String paginatorActiveColumnClass)

isPaginatorRenderLinkForActive

public boolean isPaginatorRenderLinkForActive()
Description copied from class: AbstractHtmlDataScroller
'true' - render a link for the paginator's column with pageIndex = currentPageIndex. Default-value is 'true'.

Specified by:
isPaginatorRenderLinkForActive in class AbstractHtmlDataScroller

setPaginatorRenderLinkForActive

public void setPaginatorRenderLinkForActive(boolean paginatorRenderLinkForActive)

getFirstStyleClass

public String getFirstStyleClass()
Description copied from class: AbstractHtmlDataScroller
style-class for data-scroller first-element

Specified by:
getFirstStyleClass in class AbstractHtmlDataScroller

setFirstStyleClass

public void setFirstStyleClass(String firstStyleClass)

getLastStyleClass

public String getLastStyleClass()
Description copied from class: AbstractHtmlDataScroller
style-class for data-scroller last-element

Specified by:
getLastStyleClass in class AbstractHtmlDataScroller

setLastStyleClass

public void setLastStyleClass(String lastStyleClass)

getPreviousStyleClass

public String getPreviousStyleClass()
Description copied from class: AbstractHtmlDataScroller
style-class for data-scroller previous-element

Specified by:
getPreviousStyleClass in class AbstractHtmlDataScroller

setPreviousStyleClass

public void setPreviousStyleClass(String previousStyleClass)

getNextStyleClass

public String getNextStyleClass()
Description copied from class: AbstractHtmlDataScroller
style-class for dataScroller next-element

Specified by:
getNextStyleClass in class AbstractHtmlDataScroller

setNextStyleClass

public void setNextStyleClass(String nextStyleClass)

getFastfStyleClass

public String getFastfStyleClass()
Description copied from class: AbstractHtmlDataScroller
style-class for data-scroller fast-forward-element

Specified by:
getFastfStyleClass in class AbstractHtmlDataScroller

setFastfStyleClass

public void setFastfStyleClass(String fastfStyleClass)

getFastrStyleClass

public String getFastrStyleClass()
Description copied from class: AbstractHtmlDataScroller
style-class for data-scroller fast-rewind-element

Specified by:
getFastrStyleClass in class AbstractHtmlDataScroller

setFastrStyleClass

public void setFastrStyleClass(String fastrStyleClass)

getPaginatorActiveColumnStyle

public String getPaginatorActiveColumnStyle()
Description copied from class: AbstractHtmlDataScroller
style for paginator's column with pageIndex = currentPageIndex

Specified by:
getPaginatorActiveColumnStyle in class AbstractHtmlDataScroller

setPaginatorActiveColumnStyle

public void setPaginatorActiveColumnStyle(String paginatorActiveColumnStyle)

isRenderFacetsIfSinglePage

public boolean isRenderFacetsIfSinglePage()
Description copied from class: AbstractHtmlDataScroller
If set to false, the facets aren't renderd if all the lines are contained on a single page. Default is true.

Specified by:
isRenderFacetsIfSinglePage in class AbstractHtmlDataScroller

setRenderFacetsIfSinglePage

public void setRenderFacetsIfSinglePage(boolean renderFacetsIfSinglePage)

isImmediate

public boolean isImmediate()
Description copied from class: AbstractHtmlDataScroller
True means that the default ActionListener should be executed immediately (i.e. during Apply Request Values phase of the request processing lifecycle), rather than waiting until the Invoke Application phase.

Specified by:
isImmediate in interface javax.faces.component.ActionSource
Specified by:
isImmediate in class AbstractHtmlDataScroller

setImmediate

public void setImmediate(boolean immediate)

isDisableFacetLinksIfFirstPage

public boolean isDisableFacetLinksIfFirstPage()
Description copied from class: AbstractHtmlDataScroller
If the dataScroller is on the first page (index is at 1), links for first, prev and fastprev are disabled. Default is false.

Specified by:
isDisableFacetLinksIfFirstPage in class AbstractHtmlDataScroller

setDisableFacetLinksIfFirstPage

public void setDisableFacetLinksIfFirstPage(boolean disableFacetLinksIfFirstPage)

isDisableFacetLinksIfLastPage

public boolean isDisableFacetLinksIfLastPage()
Description copied from class: AbstractHtmlDataScroller
If the dataScroller is on the last page (index is at pagecount), links for last, next and fastnext are disabled. Default is false.

Specified by:
isDisableFacetLinksIfLastPage in class AbstractHtmlDataScroller

setDisableFacetLinksIfLastPage

public void setDisableFacetLinksIfLastPage(boolean disableFacetLinksIfLastPage)

isRenderFacetLinksIfFirstPage

public boolean isRenderFacetLinksIfFirstPage()
Description copied from class: AbstractHtmlDataScroller
If the dataScroller is on the first page (index is at 1), links for first, prev and fastprev are rendered. Default is true.

Specified by:
isRenderFacetLinksIfFirstPage in class AbstractHtmlDataScroller

setRenderFacetLinksIfFirstPage

public void setRenderFacetLinksIfFirstPage(boolean renderFacetLinksIfFirstPage)

isRenderFacetLinksIfLastPage

public boolean isRenderFacetLinksIfLastPage()
Description copied from class: AbstractHtmlDataScroller
If the dataScroller is on the last page (index is at pagecount), links for last, next and fastnext are rendered. Default is true.

Specified by:
isRenderFacetLinksIfLastPage in class AbstractHtmlDataScroller

setRenderFacetLinksIfLastPage

public void setRenderFacetLinksIfLastPage(boolean renderFacetLinksIfLastPage)

getDisplayValueOnly

public Boolean getDisplayValueOnly()
Description copied from interface: DisplayValueOnlyAware
If true, renders only the value of the component, but no input widget. Default is false.


setDisplayValueOnly

public void setDisplayValueOnly(Boolean displayValueOnly)

getDisplayValueOnlyStyle

public String getDisplayValueOnlyStyle()
Description copied from interface: DisplayValueOnlyAware
Style used when displayValueOnly is true.


setDisplayValueOnlyStyle

public void setDisplayValueOnlyStyle(String displayValueOnlyStyle)

getDisplayValueOnlyStyleClass

public String getDisplayValueOnlyStyleClass()
Description copied from interface: DisplayValueOnlyAware
Style class used when displayValueOnly is true.


setDisplayValueOnlyStyleClass

public void setDisplayValueOnlyStyleClass(String displayValueOnlyStyleClass)

getEnabledOnUserRole

public String getEnabledOnUserRole()
Description copied from interface: UserRoleAware
If user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered.

Returns:

setEnabledOnUserRole

public void setEnabledOnUserRole(String enabledOnUserRole)

getVisibleOnUserRole

public String getVisibleOnUserRole()
Description copied from interface: UserRoleAware
If user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped.

Returns:

setVisibleOnUserRole

public void setVisibleOnUserRole(String visibleOnUserRole)

isForceId

public boolean isForceId()
Description copied from interface: ForceIdAware
If true, this component will force the use of the specified id when rendering.

Returns:

setForceId

public void setForceId(boolean forceId)

isForceIdIndex

public boolean isForceIdIndex()
Description copied from interface: ForceIdAware
If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.)

Returns:

setForceIdIndex

public void setForceIdIndex(boolean forceIdIndex)

getDir

public String getDir()
Description copied from interface: UniversalProperties
HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).


setDir

public void setDir(String dir)

getLang

public String getLang()
Description copied from interface: UniversalProperties
HTML: The base language of this document.


setLang

public void setLang(String lang)

getTitle

public String getTitle()
Description copied from interface: UniversalProperties
HTML: An advisory title for this element. Often used by the user agent as a tooltip.


setTitle

public void setTitle(String title)

getStyle

public String getStyle()
Description copied from interface: StyleAware
HTML: CSS styling instructions.


setStyle

public void setStyle(String style)

getStyleClass

public String getStyleClass()
Description copied from interface: StyleAware
The CSS class for this element. Corresponds to the HTML 'class' attribute.


setStyleClass

public void setStyleClass(String styleClass)

setValueBinding

public void setValueBinding(String name,
                            javax.faces.el.ValueBinding binding)
Overrides:
setValueBinding in class javax.faces.component.UIComponentBase

setValueExpression

public void setValueExpression(String name,
                               javax.el.ValueExpression expression)
Overrides:
setValueExpression in class javax.faces.component.UIComponent


Copyright © 2012 The Apache Software Foundation. All Rights Reserved.