OrderingListTag (RichFaces JSF components library 3.3.3.Final API)
Keywords: org.richfaces.taglib.OrderingListTag class

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.richfaces.taglib
Class OrderingListTag

    java.lang.Object
      javax.faces.webapp.UIComponentTagBase
          javax.faces.webapp.UIComponentClassicTagBase
              javax.faces.webapp.UIComponentELTag
                  org.richfaces.webapp.taglib.UIComponentELTagBase
                      org.ajax4jsf.webapp.taglib.UIComponentTagBase
                          org.ajax4jsf.webapp.taglib.HtmlComponentTagBase
                              org.richfaces.taglib.OrderingListTag

All Implemented Interfaces:
  javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspIdConsumer, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

    public class OrderingListTag

extends org.ajax4jsf.webapp.taglib.HtmlComponentTagBase

Field Summary

Fields inherited from class javax.faces.webapp.UIComponentClassicTagBase
`bodyContent, pageContext, UNIQUE_ID_PREFIX`

Fields inherited from interface javax.servlet.jsp.tagext.Tag
`EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE`

Fields inherited from interface javax.servlet.jsp.tagext.BodyTag
`EVAL_BODY_BUFFERED, EVAL_BODY_TAG`

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag
`EVAL_BODY_AGAIN`

Constructor Summary
`OrderingListTag()`

Method Summary
`java.lang.String` | `getComponentType()`
`java.lang.String` | `getRendererType()`
`void` | `release()`
`void` | `setActiveItem(javax.el.ValueExpression __activeItem)` Stores active item Setter for activeItem
`void` | `setAjaxKeys(javax.el.ValueExpression __ajaxKeys)` Defines row keys that are updated after an Ajax request Setter for ajaxKeys
`void` | `setBottomControlLabel(javax.el.ValueExpression __bottomControlLabel)` Defines a label for a 'Bottom' control Setter for bottomControlLabel
`void` | `setBottomTitle(javax.el.ValueExpression __bottomTitle)` HTML: alt for last button Setter for bottomTitle
`void` | `setCaptionLabel(javax.el.ValueExpression __captionLabel)` Defines caption representation text Setter for captionLabel
`void` | `setColumnClasses(javax.el.ValueExpression __columnClasses)` Assigns one or more space-separated CSS class names to the columns.
`void` | `setComponentState(javax.el.ValueExpression __componentState)` It defines EL-binding for a component state for saving or redefinition Setter for componentState
`void` | `setControlsHorizontalAlign(javax.el.ValueExpression __controlsHorizontalAlign)` Controls horizontal rendering.
`void` | `setControlsType(javax.el.ValueExpression __controlsType)` Defines type of a control: button or none.
`void` | `setControlsVerticalAlign(javax.el.ValueExpression __controlsVerticalAlign)` Controls vertical rendering.
`void` | `setConverter(javax.el.ValueExpression __converter)` Id of Converter to be used or reference to a Converter Setter for converter
`void` | `setConverterMessage(javax.el.ValueExpression __converterMessage)` A ValueExpression enabled attribute that, if present, will be used as the text of the converter message, replacing any message that comes from the converter Setter for converterMessage
`void` | `setDownControlLabel(javax.el.ValueExpression __downControlLabel)` Defines a label for a 'Down' control Setter for downControlLabel
`void` | `setDownTitle(javax.el.ValueExpression __downTitle)` HTML: alt for bottom button Setter for downTitle
`void` | `setFastOrderControlsVisible(javax.el.ValueExpression __fastOrderControlsVisible)` If "false", 'Top' and 'Bottom' controls aren't displayed.
`void` | `setImmediate(javax.el.ValueExpression __immediate)` A flag indicating that this component value must be converted and validated immediately (that is, during Apply Request Values phase), rather than waiting until a Process Validations phase Setter for immediate
`void` | `setLabel(javax.el.ValueExpression __label)` A localized user presentable name for this component.
`void` | `setListHeight(javax.el.ValueExpression __listHeight)` Defines height of a list.
`void` | `setListWidth(javax.el.ValueExpression __listWidth)` Defines width of a list.
`void` | `setOnbottomclick(javax.el.ValueExpression __onbottomclick)` The client-side script method to be called when the 'Bottom' button is clicked Setter for onbottomclick
`void` | `setOndownclick(javax.el.ValueExpression __ondownclick)` The client-side script method to be called when the 'Down' button is clicked Setter for ondownclick
`void` | `setOnheaderclick(javax.el.ValueExpression __onheaderclick)` The client-side script method to be called when the list header is clicked Setter for onheaderclick
`void` | `setOnorderchange(javax.el.ValueExpression __onorderchange)` The client-side script method to be called before the list order is changed Setter for onorderchange
`void` | `setOnorderchanged(javax.el.ValueExpression __onorderchanged)` The client-side script method to be called when the list order is changed Setter for onorderchanged
`void` | `setOntopclick(javax.el.ValueExpression __ontopclick)` The client-side script method to be called when the 'Top' button is clicked Setter for ontopclick
`void` | `setOnupclick(javax.el.ValueExpression __onupclick)` The client-side script method to be called when the 'Up' button is clicked Setter for onupclick
`void` | `setOrderControlsVisible(javax.el.ValueExpression __orderControlsVisible)` If "false", 'Up' and 'Down' controls aren't displayed.
`protected void` | `setProperties(javax.faces.component.UIComponent component)`
`void` | `setRequired(javax.el.ValueExpression __required)` If "true", this component is checked for non-empty input Setter for required
`void` | `setRequiredMessage(javax.el.ValueExpression __requiredMessage)` A ValueExpression enabled attribute which defines text of validation message to show, if a required field is missing Setter for requiredMessage
`void` | `setRowClasses(javax.el.ValueExpression __rowClasses)` Assigns one or more space-separated CSS class names to the rows.
`void` | `setRowKeyConverter(javax.el.ValueExpression __rowKeyConverter)` Converter for a row key object Setter for rowKeyConverter
`void` | `setRowKeyVar(java.lang.String __rowKeyVar)` The attribute provides access to a row key in a Request scope Setter for rowKeyVar
`void` | `setRows(javax.el.ValueExpression __rows)` A number of rows to display, or zero for all remaining rows in the list Setter for rows
`void` | `setSelection(javax.el.ValueExpression __selection)` Collection which stores a set of selected items Setter for selection
`void` | `setShowButtonLabels(javax.el.ValueExpression __showButtonLabels)` If "true", shows a label for a button.
`void` | `setTopControlLabel(javax.el.ValueExpression __topControlLabel)` Defines a label for a 'Top' control Setter for topControlLabel
`void` | `setTopTitle(javax.el.ValueExpression __topTitle)` HTML: alt for first button Setter for topTitle
`void` | `setUpControlLabel(javax.el.ValueExpression __upControlLabel)` Defines a label for a 'Up' control Setter for upControlLabel
`void` | `setUpTitle(javax.el.ValueExpression __upTitle)` HTML: alt for top button Setter for upTitle
`void` | `setValidator(javax.el.MethodExpression __validator)` MethodBinding pointing at a method that is called during Process Validations phase of the request processing lifecycle, to validate the current value of this component Setter for validator
`void` | `setValidatorMessage(javax.el.ValueExpression __validatorMessage)` A ValueExpression enabled attribute that, if present, will be used as the text of the validator message, replacing any message that comes from the validator Setter for validatorMessage
`void` | `setValue(javax.el.ValueExpression __value)` Defines a List or Array of items to be shown in a list Setter for value
`void` | `setValueChangeListener(javax.el.MethodExpression __valueChangeListener)` Listener for value changes Setter for valueChangeListener
`void` | `setVar(java.lang.String __var)` Defines a list on the page Setter for var

Methods inherited from class org.ajax4jsf.webapp.taglib.HtmlComponentTagBase
`setDir, setLang, setOnclick, setOndblclick, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setStyle, setStyleClass, setTitle`

Methods inherited from class org.ajax4jsf.webapp.taglib.UIComponentTagBase
`getExpressionFactory, isValueReference, setActionListenerProperty, setActionProperty, setBooleanProperty, setBooleanProperty, setDoubleProperty, setDoubleProperty, setFloatProperty, setFloatProperty, setIntegerProperty, setIntegerProperty, setLongProperty, setLongProperty, setProperty, setProperty, setStringProperty, setStringProperty, setValueChangedListenerProperty, setValueProperty, setValueProperty`

Methods inherited from class org.richfaces.webapp.taglib.UIComponentELTagBase
`setActionListenerProperty, setActionProperty, setConverterProperty, setRowKeyConverterProperty, setValidatorProperty, setValueChangeListenerProperty`

Methods inherited from class javax.faces.webapp.UIComponentELTag
`createComponent, getELContext, hasBinding, setBinding, setRendered`

Methods inherited from class javax.faces.webapp.UIComponentClassicTagBase
`addChild, addFacet, addVerbatimAfterComponent, addVerbatimBeforeComponent, createVerbatimComponent, createVerbatimComponentFromBodyContent, doAfterBody, doEndTag, doInitBody, doStartTag, encodeBegin, encodeChildren, encodeEnd, findComponent, getBodyContent, getComponentInstance, getCreated, getCreatedComponents, getDoAfterBodyValue, getDoEndValue, getDoStartValue, getFacesContext, getFacesJspId, getFacetName, getId, getIndexOfNextChildTag, getJspId, getParent, getParentUIComponentClassicTagBase, getPreviousOut, setBodyContent, setId, setJspId, setPageContext, setParent, setupResponseWriter`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface javax.servlet.jsp.tagext.Tag
`doEndTag, doStartTag, getParent, setPageContext, setParent`

Constructor Detail

### OrderingListTag

    public OrderingListTag()

Method Detail

### setActiveItem

    public void setActiveItem(javax.el.ValueExpression __activeItem)

  Stores active item Setter for activeItem

  Parameters:
    `activeItem` - - new value

### setAjaxKeys

    public void setAjaxKeys(javax.el.ValueExpression __ajaxKeys)

  Defines row keys that are updated after an Ajax request Setter for ajaxKeys

  Parameters:
    `ajaxKeys` - - new value

### setBottomControlLabel

    public void setBottomControlLabel(javax.el.ValueExpression __bottomControlLabel)

  Defines a label for a 'Bottom' control Setter for bottomControlLabel

  Parameters:
    `bottomControlLabel` - - new value

### setBottomTitle

    public void setBottomTitle(javax.el.ValueExpression __bottomTitle)

  HTML: alt for last button Setter for bottomTitle

  Parameters:
    `bottomTitle` - - new value

### setCaptionLabel

    public void setCaptionLabel(javax.el.ValueExpression __captionLabel)

  Defines caption representation text Setter for captionLabel

  Parameters:
    `captionLabel` - - new value

### setColumnClasses

    public void setColumnClasses(javax.el.ValueExpression __columnClasses)

  Assigns one or more space-separated CSS class names to the columns. If the CSS class names are comma-separated, each class will be assigned to a particular column in the order they follow in the attribute. If you have less class names than columns, the class will be applied to every n-fold column where n is the order in which the class is listed in the attribute. If there are more class names than columns, the overflow ones are ignored. Setter for columnClasses

  Parameters:
    `columnClasses` - - new value

### setComponentState

    public void setComponentState(javax.el.ValueExpression __componentState)

  It defines EL-binding for a component state for saving or redefinition Setter for componentState

  Parameters:
    `componentState` - - new value

### setControlsHorizontalAlign

    public void setControlsHorizontalAlign(javax.el.ValueExpression __controlsHorizontalAlign)

  Controls horizontal rendering. Possible values: "left" - controls should be rendered to the left side of a list. "right"- controls should be rendered to the right side of a list. Default value is "right". Setter for controlsHorizontalAlign

  Parameters:
    `controlsHorizontalAlign` - - new value

### setControlsType

    public void setControlsType(javax.el.ValueExpression __controlsType)

  Defines type of a control: button or none. Default value is "button". Setter for controlsType

  Parameters:
    `controlsType` - - new value

### setControlsVerticalAlign

    public void setControlsVerticalAlign(javax.el.ValueExpression __controlsVerticalAlign)

  Controls vertical rendering. Possible values: "top" - controls should be rendered aligned to top side of a list. "bottom" - controls should be rendered aligned to bottom side of a list. "middle" - controls should be rendered centered relatively to a list. Default value is "middle" Setter for controlsVerticalAlign

  Parameters:
    `controlsVerticalAlign` - - new value

### setConverter

    public void setConverter(javax.el.ValueExpression __converter)

  Id of Converter to be used or reference to a Converter Setter for converter

  Parameters:
    `converter` - - new value

### setConverterMessage

    public void setConverterMessage(javax.el.ValueExpression __converterMessage)

  A ValueExpression enabled attribute that, if present, will be used as the text of the converter message, replacing any message that comes from the converter Setter for converterMessage

  Parameters:
    `converterMessage` - - new value

### setDownControlLabel

    public void setDownControlLabel(javax.el.ValueExpression __downControlLabel)

  Defines a label for a 'Down' control Setter for downControlLabel

  Parameters:
    `downControlLabel` - - new value

### setDownTitle

    public void setDownTitle(javax.el.ValueExpression __downTitle)

  HTML: alt for bottom button Setter for downTitle

  Parameters:
    `downTitle` - - new value

### setFastOrderControlsVisible

    public void setFastOrderControlsVisible(javax.el.ValueExpression __fastOrderControlsVisible)

  If "false", 'Top' and 'Bottom' controls aren't displayed. Default value is "true". Setter for fastOrderControlsVisible

  Parameters:
    `fastOrderControlsVisible` - - new value

### setImmediate

    public void setImmediate(javax.el.ValueExpression __immediate)

  A flag indicating that this component value must be converted and validated immediately (that is, during Apply Request Values phase), rather than waiting until a Process Validations phase Setter for immediate

  Parameters:
    `immediate` - - new value

### setLabel

    public void setLabel(javax.el.ValueExpression __label)

  A localized user presentable name for this component. Setter for label

  Parameters:
    `label` - - new value

### setListHeight

    public void setListHeight(javax.el.ValueExpression __listHeight)

  Defines height of a list. Default value is "140". Setter for listHeight

  Parameters:
    `listHeight` - - new value

### setListWidth

    public void setListWidth(javax.el.ValueExpression __listWidth)

  Defines width of a list. Default value is "140". Setter for listWidth

  Parameters:
    `listWidth` - - new value

### setOnbottomclick

    public void setOnbottomclick(javax.el.ValueExpression __onbottomclick)

  The client-side script method to be called when the 'Bottom' button is clicked Setter for onbottomclick

  Parameters:
    `onbottomclick` - - new value

### setOndownclick

    public void setOndownclick(javax.el.ValueExpression __ondownclick)

  The client-side script method to be called when the 'Down' button is clicked Setter for ondownclick

  Parameters:
    `ondownclick` - - new value

### setOnheaderclick

    public void setOnheaderclick(javax.el.ValueExpression __onheaderclick)

  The client-side script method to be called when the list header is clicked Setter for onheaderclick

  Parameters:
    `onheaderclick` - - new value

### setOnorderchange

    public void setOnorderchange(javax.el.ValueExpression __onorderchange)

  The client-side script method to be called before the list order is changed Setter for onorderchange

  Parameters:
    `onorderchange` - - new value

### setOnorderchanged

    public void setOnorderchanged(javax.el.ValueExpression __onorderchanged)

  The client-side script method to be called when the list order is changed Setter for onorderchanged

  Parameters:
    `onorderchanged` - - new value

### setOntopclick

    public void setOntopclick(javax.el.ValueExpression __ontopclick)

  The client-side script method to be called when the 'Top' button is clicked Setter for ontopclick

  Parameters:
    `ontopclick` - - new value

### setOnupclick

    public void setOnupclick(javax.el.ValueExpression __onupclick)

  The client-side script method to be called when the 'Up' button is clicked Setter for onupclick

  Parameters:
    `onupclick` - - new value

### setOrderControlsVisible

    public void setOrderControlsVisible(javax.el.ValueExpression __orderControlsVisible)

  If "false", 'Up' and 'Down' controls aren't displayed. Default value is "true". Setter for orderControlsVisible

  Parameters:
    `orderControlsVisible` - - new value

### setRequired

    public void setRequired(javax.el.ValueExpression __required)

  If "true", this component is checked for non-empty input Setter for required

  Parameters:
    `required` - - new value

### setRequiredMessage

    public void setRequiredMessage(javax.el.ValueExpression __requiredMessage)

  A ValueExpression enabled attribute which defines text of validation message to show, if a required field is missing Setter for requiredMessage

  Parameters:
    `requiredMessage` - - new value

### setRowClasses

    public void setRowClasses(javax.el.ValueExpression __rowClasses)

  Assigns one or more space-separated CSS class names to the rows. If the CSS class names are comma-separated, each class will be assigned to a particular row in the order they follow in the attribute. If you have less class names than rows, the class will be applied to every n-fold row where n is the order in which the class is listed in the attribute. If there are more class names than rows, the overflow ones are ignored. Setter for rowClasses

  Parameters:
    `rowClasses` - - new value

### setRowKeyConverter

    public void setRowKeyConverter(javax.el.ValueExpression __rowKeyConverter)

  Converter for a row key object Setter for rowKeyConverter

  Parameters:
    `rowKeyConverter` - - new value

### setRowKeyVar

    public void setRowKeyVar(java.lang.String __rowKeyVar)

  The attribute provides access to a row key in a Request scope Setter for rowKeyVar

  Parameters:
    `rowKeyVar` - - new value

### setRows

    public void setRows(javax.el.ValueExpression __rows)

  A number of rows to display, or zero for all remaining rows in the list Setter for rows

  Parameters:
    `rows` - - new value

### setSelection

    public void setSelection(javax.el.ValueExpression __selection)

  Collection which stores a set of selected items Setter for selection

  Parameters:
    `selection` - - new value

### setShowButtonLabels

    public void setShowButtonLabels(javax.el.ValueExpression __showButtonLabels)

  If "true", shows a label for a button. Default value is "true" Setter for showButtonLabels

  Parameters:
    `showButtonLabels` - - new value

### setTopControlLabel

    public void setTopControlLabel(javax.el.ValueExpression __topControlLabel)

  Defines a label for a 'Top' control Setter for topControlLabel

  Parameters:
    `topControlLabel` - - new value

### setTopTitle

    public void setTopTitle(javax.el.ValueExpression __topTitle)

  HTML: alt for first button Setter for topTitle

  Parameters:
    `topTitle` - - new value

### setUpControlLabel

    public void setUpControlLabel(javax.el.ValueExpression __upControlLabel)

  Defines a label for a 'Up' control Setter for upControlLabel

  Parameters:
    `upControlLabel` - - new value

### setUpTitle

    public void setUpTitle(javax.el.ValueExpression __upTitle)

  HTML: alt for top button Setter for upTitle

  Parameters:
    `upTitle` - - new value

### setValidator

    public void setValidator(javax.el.MethodExpression __validator)

  MethodBinding pointing at a method that is called during Process Validations phase of the request processing lifecycle, to validate the current value of this component Setter for validator

  Parameters:
    `validator` - - new value

### setValidatorMessage

    public void setValidatorMessage(javax.el.ValueExpression __validatorMessage)

  A ValueExpression enabled attribute that, if present, will be used as the text of the validator message, replacing any message that comes from the validator Setter for validatorMessage

  Parameters:
    `validatorMessage` - - new value

### setValue

    public void setValue(javax.el.ValueExpression __value)

  Defines a List or Array of items to be shown in a list Setter for value

  Parameters:
    `value` - - new value

### setValueChangeListener

    public void setValueChangeListener(javax.el.MethodExpression __valueChangeListener)

  Listener for value changes Setter for valueChangeListener

  Parameters:
    `valueChangeListener` - - new value

### setVar

    public void setVar(java.lang.String __var)

  Defines a list on the page Setter for var

  Parameters:
    `var` - - new value

### release

    public void release()

  Specified by:
    `release` in interface `javax.servlet.jsp.tagext.Tag`
  Overrides:
    `release` in class `org.ajax4jsf.webapp.taglib.HtmlComponentTagBase`

### setProperties

    protected void setProperties(javax.faces.component.UIComponent component)

  Overrides:
    `setProperties` in class `org.ajax4jsf.webapp.taglib.HtmlComponentTagBase`

### getComponentType

    public java.lang.String getComponentType()

  Specified by:
    `getComponentType` in class `javax.faces.webapp.UIComponentTagBase`

### getRendererType

    public java.lang.String getRendererType()

  Specified by:
    `getRendererType` in class `javax.faces.webapp.UIComponentTagBase`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2010. All Rights Reserved.