oracle.adf.view.faces.component
Class UIXSelectRange

java.lang.Object
  |
  +--javax.faces.component.UIComponent
        |
        +--oracle.adf.view.faces.component.UIXComponent
              |
              +--oracle.adf.view.faces.component.UIXComponentBase
                    |
                    +--oracle.adf.view.faces.component.SelectRangeBase
                          |
                          +--oracle.adf.view.faces.component.UIXSelectRange

All Implemented Interfaces:

javax.faces.component.StateHolder

Direct Known Subclasses:

CoreSelectRangeChoiceBar

public class UIXSelectRange

extends SelectRangeBase

UIXSelectRange is a base abstraction for components that select a range, e.g, 5 - 10 of 50.

Example:

Events:

Type	Phases	Description
oracle.adf.view.faces.event.GotoEvent	Any Phase Invoke Application	Event delivered when the user selects a new range.

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static PropertyKey	FIRST_KEY
static PropertyKey	GOTO_LISTENER_KEY
static PropertyKey	IMMEDIATE_KEY
static java.lang.String	RANGE_LABEL_FACET
static PropertyKey	ROWS_KEY
static FacesBean.Type	TYPE
static PropertyKey	VALUE_KEY
static PropertyKey	VAR_KEY

Fields inherited from class oracle.adf.view.faces.component.UIXComponentBase

ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Constructor Summary

UIXSelectRange()
Construct an instance of the UIXSelectRange.

Method Summary

protected FacesBean.Type	getBeanType()
java.lang.String	getFamily()
int	getFirst() Gets the index of the first row in the current range of rows.
javax.faces.el.MethodBinding	getGotoListener() Gets a method reference to a goto listener that will be called when a new range is selected.
javax.faces.component.UIComponent	getRangeLabel() use to customize the label of each range selection.
int	getRows() Gets the maximum number of rows to display in a single range of rows.
java.lang.Object	getValue() Gets the data model being used by this component.
java.lang.String	getVar() Gets the name of the EL variable that provides access to the "start" and "end" variables that point to the start and end row in the each range from the data model.
boolean	isImmediate() Gets whether or not data validation - client-side or server-side - should take place when events are generated by this component.
void	setFirst(int first) Sets the index of the first row in the current range of rows.
void	setGotoListener(javax.faces.el.MethodBinding gotoListener) Sets a method reference to a goto listener that will be called when a new range is selected.
void	setImmediate(boolean immediate) Sets whether or not data validation - client-side or server-side - should take place when events are generated by this component.
void	setRangeLabel(javax.faces.component.UIComponent rangeLabelFacet) use to customize the label of each range selection.
void	setRows(int rows) Sets the maximum number of rows to display in a single range of rows.
void	setValue(java.lang.Object value) Sets the data model being used by this component.
void	setVar(java.lang.String var) Sets the name of the EL variable that provides access to the "start" and "end" variables that point to the start and end row in the each range from the data model.

Methods inherited from class oracle.adf.view.faces.component.SelectRangeBase

addGotoListener, broadcast, encodeBegin, getGotoListeners, getRowCount, getRowData, isRowAvailable, queueEvent, removeGotoListener, setRowIndex

Methods inherited from class oracle.adf.view.faces.component.UIXComponentBase

addFacesListener, createFacesBean, decode, encodeChildren, encodeEnd, findComponent, getAttribute, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getIntProperty, getLocalClientId, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreState, saveState, setAttribute, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, toString

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final FacesBean.Type TYPE

FIRST_KEY

public static final PropertyKey FIRST_KEY

ROWS_KEY

public static final PropertyKey ROWS_KEY

VALUE_KEY

public static final PropertyKey VALUE_KEY

VAR_KEY

public static final PropertyKey VAR_KEY

IMMEDIATE_KEY

public static final PropertyKey IMMEDIATE_KEY

GOTO_LISTENER_KEY

public static final PropertyKey GOTO_LISTENER_KEY

RANGE_LABEL_FACET

public static final java.lang.String RANGE_LABEL_FACET

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

UIXSelectRange

public UIXSelectRange()

Construct an instance of the UIXSelectRange.

Method Detail

getRangeLabel

public final javax.faces.component.UIComponent getRangeLabel()

use to customize the label of each range selection.

setRangeLabel

public final void setRangeLabel(javax.faces.component.UIComponent rangeLabelFacet)

use to customize the label of each range selection.

getFirst

public final int getFirst()

Gets the index of the first row in the current range of rows. This index is zero-based. This attribute is used to control which range of rows to display to the user.

setFirst

public final void setFirst(int first)

Sets the index of the first row in the current range of rows. This index is zero-based. This attribute is used to control which range of rows to display to the user.

Specified by:

setFirst in class SelectRangeBase

getRows

public final int getRows()

Gets the maximum number of rows to display in a single range of rows. Some ranges might have fewer than the number of rows specified by this attribute (eg: the last range might have an insufficient number of rows).

setRows

public final void setRows(int rows)

Sets the maximum number of rows to display in a single range of rows. Some ranges might have fewer than the number of rows specified by this attribute (eg: the last range might have an insufficient number of rows).

getValue

public final java.lang.Object getValue()

Gets the data model being used by this component. This is used to determine the maximum rows and to customize the range labels. See the "rangeLabel" facet and the "var" attribute. The specific model class is oracle.adf.view.faces.model.CollectionModel. You may also use other model instances, e.g., java.util.List , array, and javax.faces.model.DataModel. The selectRange component will automatically convert the instance into a CollectionModel.

Specified by:

getValue in class SelectRangeBase

setValue

public final void setValue(java.lang.Object value)

Sets the data model being used by this component. This is used to determine the maximum rows and to customize the range labels. See the "rangeLabel" facet and the "var" attribute. The specific model class is oracle.adf.view.faces.model.CollectionModel. You may also use other model instances, e.g., java.util.List , array, and javax.faces.model.DataModel. The selectRange component will automatically convert the instance into a CollectionModel.

getVar

public final java.lang.String getVar()

Gets the name of the EL variable that provides access to the "start" and "end" variables that point to the start and end row in the each range from the data model. This can be used to customize the range text.

This is a required property on the bean.

setVar

public final void setVar(java.lang.String var)

Sets the name of the EL variable that provides access to the "start" and "end" variables that point to the start and end row in the each range from the data model. This can be used to customize the range text.

This is a required property on the bean.

isImmediate

public final boolean isImmediate()

Gets whether or not data validation - client-side or server-side - should take place when events are generated by this component. When immediate is true, the default ActionListener provided by the JavaServer Faces implementation should be executed during Apply Request Values phase of the request processing lifecycle, rather than waiting until the Invoke Application phase.

Specified by:

isImmediate in class SelectRangeBase

setImmediate

public final void setImmediate(boolean immediate)

Sets whether or not data validation - client-side or server-side - should take place when events are generated by this component. When immediate is true, the default ActionListener provided by the JavaServer Faces implementation should be executed during Apply Request Values phase of the request processing lifecycle, rather than waiting until the Invoke Application phase.

getGotoListener

public final javax.faces.el.MethodBinding getGotoListener()

Gets a method reference to a goto listener that will be called when a new range is selected.

Specified by:

getGotoListener in class SelectRangeBase

setGotoListener

public final void setGotoListener(javax.faces.el.MethodBinding gotoListener)

Sets a method reference to a goto listener that will be called when a new range is selected.

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class UIXComponentBase

getBeanType

protected FacesBean.Type getBeanType()

Overrides:

getBeanType in class UIXComponentBase