|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
org.apache.myfaces.trinidad.component.UIXSelectRange
public class UIXSelectRange
UIXSelectRange is a base abstraction for components that select a range, e.g, 5 - 10 of 50.
Type | Phases | Description |
---|---|---|
org.apache.myfaces.trinidad.event.RangeChangeEvent |
Any Phase Invoke Application |
The range change event is delivered when the user navigates. |
org.apache.myfaces.trinidad.event.AttributeChangeEvent |
Invoke Application Apply Request Values |
Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change event might include the width of a column that supported client-side resizing. |
Field Summary | |
---|---|
static String |
COMPONENT_FAMILY
|
static String |
COMPONENT_TYPE
|
static PropertyKey |
FIRST_KEY
|
static PropertyKey |
IMMEDIATE_KEY
|
static PropertyKey |
RANGE_CHANGE_LISTENER_KEY
|
static String |
RANGE_LABEL_FACET
|
static PropertyKey |
ROWS_KEY
|
static FacesBean.Type |
TYPE
|
static PropertyKey |
VALUE_KEY
|
static PropertyKey |
VAR_KEY
|
Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase |
---|
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY |
Fields inherited from class javax.faces.component.UIComponent |
---|
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY |
Constructor Summary | |
---|---|
|
UIXSelectRange()
Construct an instance of the UIXSelectRange. |
protected |
UIXSelectRange(String rendererType)
Construct an instance of the UIXSelectRange. |
Method Summary | |
---|---|
void |
addRangeChangeListener(RangeChangeListener listener)
Adds a rangeChange listener. |
void |
broadcast(javax.faces.event.FacesEvent event)
|
void |
encodeBegin(javax.faces.context.FacesContext context)
|
protected FacesBean.Type |
getBeanType()
|
String |
getFamily()
|
int |
getFirst()
Gets the index of the first row in the currently range of rows. |
javax.el.MethodExpression |
getRangeChangeListener()
Gets a method reference to a rangeChange listener that will be called when a new range is selected. |
RangeChangeListener[] |
getRangeChangeListeners()
Returns an array of attached rangeChange listeners. |
javax.faces.component.UIComponent |
getRangeLabel()
use to customize the label of each range selection. |
int |
getRowCount()
Gets the total number of rows in this table. |
Object |
getRowData()
Gets the data for the current row. |
Object |
getRowData(int rowIndex)
Gets the data for the current row. |
int |
getRowIndex()
|
int |
getRows()
Gets the maximum number of rows to display in a single range of rows. |
Object |
getValue()
Gets the data model being used by this component. |
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 data validation should be skipped when range change events are generated by this component. |
boolean |
isRowAvailable()
Checks to see if the current row is available. |
boolean |
isRowAvailable(int rowIndex)
Checks to see if the given row is available. |
void |
queueEvent(javax.faces.event.FacesEvent e)
* We don't want to update model if we have validation errors on the page, so if not immediate, queue the event in INVOKE_APPLICATION phase. |
void |
removeRangeChangeListener(RangeChangeListener listener)
Removes a rangeChange listener. |
void |
setFirst(int first)
Sets the index of the first row in the currently range of rows. |
void |
setImmediate(boolean immediate)
Sets whether data validation should be skipped when range change events are generated by this component. |
void |
setRangeChangeListener(javax.faces.el.MethodBinding binding)
Deprecated. |
void |
setRangeChangeListener(javax.el.MethodExpression rangeChangeListener)
Sets a method reference to a rangeChange listener that will be called when a new range is selected. |
void |
setRangeLabel(javax.faces.component.UIComponent rangeLabelFacet)
use to customize the label of each range selection. |
void |
setRowIndex(int rowIndex)
Makes a row current. |
void |
setRows(int rows)
Sets the maximum number of rows to display in a single range of rows. |
void |
setValue(Object value)
Sets the data model being used by this component. |
void |
setVar(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 javax.faces.component.UIComponent |
---|
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, setInView |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final FacesBean.Type TYPE
public static final PropertyKey VAR_KEY
public static final PropertyKey IMMEDIATE_KEY
public static final PropertyKey RANGE_CHANGE_LISTENER_KEY
public static final PropertyKey VALUE_KEY
public static final PropertyKey ROWS_KEY
public static final PropertyKey FIRST_KEY
public static final String RANGE_LABEL_FACET
public static final String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
Constructor Detail |
---|
public UIXSelectRange()
protected UIXSelectRange(String rendererType)
Method Detail |
---|
@Deprecated public void setRangeChangeListener(javax.faces.el.MethodBinding binding)
public void encodeBegin(javax.faces.context.FacesContext context) throws IOException
encodeBegin
in class UIXComponentBase
IOException
public void broadcast(javax.faces.event.FacesEvent event) throws javax.faces.event.AbortProcessingException
broadcast
in class UIXComponentBase
javax.faces.event.AbortProcessingException
public void queueEvent(javax.faces.event.FacesEvent e)
queueEvent
in class UIXComponentBase
public final void setRowIndex(int rowIndex)
rowIndex
- the zero-based row-index of the row that should be made
current. Use -1 to clear the current row.DataModel.setRowIndex(int)
public final int getRowIndex()
DataModel.getRowIndex()
public final int getRowCount()
DataModel.getRowCount()
public final boolean isRowAvailable()
CollectionModel.isRowAvailable(int)
public final boolean isRowAvailable(int rowIndex)
rowIndex
- identifies the row to check
CollectionModel.isRowAvailable(int)
public final Object getRowData()
CollectionModel.getRowData(int)
public final Object getRowData(int rowIndex)
rowIndex
- identifies the row to get data from
CollectionModel.getRowData(int)
public final javax.faces.component.UIComponent getRangeLabel()
public final void setRangeLabel(javax.faces.component.UIComponent rangeLabelFacet)
public final String getVar()
public final void setVar(String var)
var
- the new var valuepublic final boolean isImmediate()
public final void setImmediate(boolean immediate)
immediate
- the new immediate valuepublic final javax.el.MethodExpression getRangeChangeListener()
public final void setRangeChangeListener(javax.el.MethodExpression rangeChangeListener)
rangeChangeListener
- the new rangeChangeListener valuepublic final Object getValue()
org.apache.myfaces.trinidad.model.CollectionModel
.
You may also use other model instances, e.g.,
java.util.List
,
array, and javax.faces.model.DataModel
.
This component will automatically convert the instance
into a CollectionModel
.
public final void setValue(Object value)
org.apache.myfaces.trinidad.model.CollectionModel
.
You may also use other model instances, e.g.,
java.util.List
,
array, and javax.faces.model.DataModel
.
This component will automatically convert the instance
into a CollectionModel
.
value
- the new value valuepublic final int getRows()
public final void setRows(int rows)
rows
- the new rows valuepublic final int getFirst()
public final void setFirst(int first)
first
- the new first valuepublic final void addRangeChangeListener(RangeChangeListener listener)
listener
- the rangeChange listener to addpublic final void removeRangeChangeListener(RangeChangeListener listener)
listener
- the rangeChange listener to removepublic final RangeChangeListener[] getRangeChangeListeners()
public String getFamily()
getFamily
in class UIXComponentBase
protected FacesBean.Type getBeanType()
getBeanType
in class UIXComponentBase
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |