org.nuxeo.ecm.platform.ui.web.util

Class SelectionActionsBean

java.lang.Object

org.nuxeo.ecm.platform.ui.web.util.SelectionActionsBean

All Implemented Interfaces:

Serializable

@Name(value="selectionActions")
@Scope(value=EVENT)
public class SelectionActionsBean
extends Object
implements Serializable

Helper for selection actions, useful when performing ajax calls on a "liste shuttle" widget for instance, or to retrieve the selected value on a JSF component and set it on another.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SelectionActionsBean.ShiftType

Constructor Summary

Constructors

Constructor and Description
SelectionActionsBean()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAllToSelection(javax.faces.event.ActionEvent event)
void	addToSelection(javax.faces.event.ActionEvent event)
javax.faces.model.SelectItem[]	getEmptySelection()
String	getLookupLevelValue()
String	getSelectedValue()
String	getSelectedValueHolder()
javax.faces.component.UISelectMany	getSourceSelectComponent(javax.faces.event.ActionEvent event)
javax.faces.component.UISelectItems	getSourceSelectItems(javax.faces.event.ActionEvent event)
void	onClick(javax.faces.event.ActionEvent event) Deprecated. since 6.0: use onClick(AjaxBehaviorEvent) instead.
void	onClick(javax.faces.event.AjaxBehaviorEvent event)
void	onSelection(javax.faces.event.ActionEvent event) Deprecated. since 6.0: use onSelection(AjaxBehaviorEvent) instead.
void	onSelection(javax.faces.event.AjaxBehaviorEvent event)
void	removeAllFromSelection(javax.faces.event.ActionEvent event)
void	removeFromSelection(javax.faces.event.ActionEvent event)
void	setLookupLevelValue(String lookupLevelValue)
void	setSelectedValue(String selectedValue)
void	setSelectedValueHolder(String selectedValueHolder)
void	setStaticValue(javax.faces.event.ActionEvent event)
void	setStaticValue(javax.faces.event.AjaxBehaviorEvent event) Retrieves a value passed as an attribute with id "selectedValue" on the event component attributes and sets it on the target component.
void	setValueFromComponent(javax.faces.event.ActionEvent event)
void	setValueFromComponent(javax.faces.event.AjaxBehaviorEvent event) Retrieves a value from another component and sets it on the target component.
void	shiftSelected(SelectionActionsBean.ShiftType stype, javax.faces.event.ActionEvent event)
void	shiftSelectedDown(javax.faces.event.ActionEvent event)
void	shiftSelectedFirst(javax.faces.event.ActionEvent event)
void	shiftSelectedLast(javax.faces.event.ActionEvent event)
void	shiftSelectedUp(javax.faces.event.ActionEvent event)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SelectionActionsBean

public SelectionActionsBean()

Method Detail

getLookupLevelValue

public String getLookupLevelValue()

Since:

5.6

setLookupLevelValue

public void setLookupLevelValue(String lookupLevelValue)

Since:

5.6

getSelectedValue

public String getSelectedValue()

setSelectedValue

public void setSelectedValue(String selectedValue)

getSelectedValueHolder

public String getSelectedValueHolder()

setSelectedValueHolder

public void setSelectedValueHolder(String selectedValueHolder)

getEmptySelection

public javax.faces.model.SelectItem[] getEmptySelection()

shiftSelected

public void shiftSelected(SelectionActionsBean.ShiftType stype,
                 javax.faces.event.ActionEvent event)

shiftSelectedUp

public void shiftSelectedUp(javax.faces.event.ActionEvent event)
                     throws ClientException

Throws:

ClientException

shiftSelectedDown

public void shiftSelectedDown(javax.faces.event.ActionEvent event)
                       throws ClientException

Throws:

ClientException

shiftSelectedFirst

public void shiftSelectedFirst(javax.faces.event.ActionEvent event)
                        throws ClientException

Throws:

ClientException

shiftSelectedLast

public void shiftSelectedLast(javax.faces.event.ActionEvent event)
                       throws ClientException

Throws:

ClientException

addToSelection

public void addToSelection(javax.faces.event.ActionEvent event)
                    throws ClientException

Throws:

ClientException

removeFromSelection

public void removeFromSelection(javax.faces.event.ActionEvent event)
                         throws ClientException

Throws:

ClientException

addAllToSelection

public void addAllToSelection(javax.faces.event.ActionEvent event)

getSourceSelectComponent

public javax.faces.component.UISelectMany getSourceSelectComponent(javax.faces.event.ActionEvent event)

getSourceSelectItems

public javax.faces.component.UISelectItems getSourceSelectItems(javax.faces.event.ActionEvent event)

removeAllFromSelection

public void removeAllFromSelection(javax.faces.event.ActionEvent event)
                            throws ClientException

Throws:

ClientException

onSelection

@Deprecated
public void onSelection(javax.faces.event.ActionEvent event)

Deprecated. since 6.0: use onSelection(AjaxBehaviorEvent) instead.

Adds selection retrieved from a selector to another component

Must pass request parameters "selectorId" holding the id of component holding the value to pass to the other component, and "valueHolderId" holding the other component id.

Parameters:

event -

Since:

5.5

onSelection

public void onSelection(javax.faces.event.AjaxBehaviorEvent event)

Since:

6.0

onClick

@Deprecated
public void onClick(javax.faces.event.ActionEvent event)

Deprecated. since 6.0: use onClick(AjaxBehaviorEvent) instead.

Adds value retrieved from getSelectedValue() to a component

Must pass request parameters "valueHolderId" holding the id of the bound component, and call setSelectedValue(String) prior to this call.

As an alternative, must call setSelectedValueHolder(String) with the id of the bound component, and call setSelectedValue(String) prior to this call (this makes it possible to use the same logic in command buttons that do not make it possible to pass request parameters).

Parameters:

event -

Since:

5.5

onClick

public void onClick(javax.faces.event.AjaxBehaviorEvent event)

setValueFromComponent

public void setValueFromComponent(javax.faces.event.AjaxBehaviorEvent event)

Retrieves a value from another component and sets it on the target component.

Source component id must be passed in the event component attributes with id "sourceComponentId".

Target component id must be passed in the event component attributes with id "targetComponentId". If target component is an EditableValueHolder, its submitted value is set. Otherwise, its local value is set.

Parameters:

event -

Since:

6.0

setValueFromComponent

public void setValueFromComponent(javax.faces.event.ActionEvent event)

Since:

6.0

See Also:

setValueFromComponent(ActionEvent)

setStaticValue

public void setStaticValue(javax.faces.event.AjaxBehaviorEvent event)

Retrieves a value passed as an attribute with id "selectedValue" on the event component attributes and sets it on the target component.

Target component id must be passed in the event component attributes with id "targetComponentId". If target component is an EditableValueHolder, its submitted value is set. Otherwise, its local value is set.

Parameters:

event -

Since:

6.0

setStaticValue

public void setStaticValue(javax.faces.event.ActionEvent event)

Since:

6.0

See Also:

setStaticValue(ActionEvent)