org.alfresco.web.ui.repo.component

Class UIMultiValueEditor

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIOutput

javax.faces.component.UIInput

org.alfresco.web.ui.repo.component.UIMultiValueEditor

All Implemented Interfaces:

EditableValueHolder, StateHolder, ValueHolder

public class UIMultiValueEditor
extends UIInput

This component wraps a standard component to give it multi value capabilities. A list of existing values are available, items can be removed from this list or new items added to the list. To add new items the component dynamically shows the child component this one wraps.

Author:

gavinc

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UIMultiValueEditor.MultiValueEditorEvent Class representing an action relevant to the ChildAssociationEditor component.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACTION_ADD
static int	ACTION_NONE
static int	ACTION_REMOVE
static int	ACTION_SELECT
static String	ACTION_SEPARATOR

Fields inherited from class javax.faces.component.UIInput

COMPONENT_FAMILY, COMPONENT_TYPE, CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID

Constructor Summary

Constructors

Constructor and Description
UIMultiValueEditor() Default constructor

Method Summary

Modifier and Type	Method and Description
void	broadcast(FacesEvent event)
void	encodeChildren(FacesContext context)
boolean	getAddingNewItem() Determines whether the component is adding a new item
String	getFamily()
Object	getLastItemAdded() Returns the last item added by the user
String	getNoSelectedItemsMsg() Returns the message to display when no items have been selected, if one hasn't been set it defaults to the message in the bundle under key 'no_selected_items'.
boolean	getReadOnly() Determines whether the component is in read only mode
boolean	getRendersChildren()
String	getSelectedItemsMsg() Returns the message to display for the selected items, if one hasn't been set it defaults to the message in the bundle under key 'selected_items'.
String	getSelectItemMsg() Returns the message to display for select an item, if one hasn't been set it defaults to the message in the bundle under key 'select_an_item'.
void	restoreState(FacesContext context, Object state)
Object	saveState(FacesContext context)
void	setLastItemAdded(Object lastItemAdded) Sets the last item to be added by the user
void	setNoSelectedItemsMsg(String noSelectedItemsMsg) Sets the no selected items message to display in the UI
void	setReadOnly(boolean readOnly) Sets the read only mode for the component
void	setSelectedItemsMsg(String selectedItemsMsg) Sets the selected items message to display in the UI
void	setSelectItemMsg(String selectItemMsg) Sets the select an item message to display in the UI

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, compareValues, decode, getConvertedValue, getSubmittedValue, getValidator, getValidators, getValue, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, setImmediate, setLocalValueSet, setRequired, setSubmittedValue, setValid, setValidator, setValue, setValueChangeListener, updateModel, validate, validateValue

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, setConverter

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, encodeBegin, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

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.ValueHolder

getConverter, getLocalValue, setConverter

Field Detail

ACTION_SEPARATOR

public static final String ACTION_SEPARATOR

See Also:

Constant Field Values

ACTION_NONE

public static final int ACTION_NONE

See Also:

Constant Field Values

ACTION_REMOVE

public static final int ACTION_REMOVE

See Also:

Constant Field Values

ACTION_SELECT

public static final int ACTION_SELECT

See Also:

Constant Field Values

ACTION_ADD

public static final int ACTION_ADD

See Also:

Constant Field Values

Constructor Detail

UIMultiValueEditor

public UIMultiValueEditor()

Default constructor

Method Detail

getFamily

public String getFamily()

Overrides:

getFamily in class UIInput

See Also:

UIComponent.getFamily()

restoreState

public void restoreState(FacesContext context,
                         Object state)

Specified by:

restoreState in interface StateHolder

Overrides:

restoreState in class UIInput

See Also:

StateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object)

saveState

public Object saveState(FacesContext context)

Specified by:

saveState in interface StateHolder

Overrides:

saveState in class UIInput

See Also:

StateHolder.saveState(javax.faces.context.FacesContext)

getLastItemAdded

public Object getLastItemAdded()

Returns the last item added by the user

Returns:

The last item added

setLastItemAdded

public void setLastItemAdded(Object lastItemAdded)

Sets the last item to be added by the user

Parameters:

lastItemAdded - The last item added

getSelectedItemsMsg

public String getSelectedItemsMsg()

Returns the message to display for the selected items, if one hasn't been set it defaults to the message in the bundle under key 'selected_items'.

Returns:

The message

setSelectedItemsMsg

public void setSelectedItemsMsg(String selectedItemsMsg)

Sets the selected items message to display in the UI

Parameters:

selectedItemsMsg - The message

getNoSelectedItemsMsg

public String getNoSelectedItemsMsg()

Returns the message to display when no items have been selected, if one hasn't been set it defaults to the message in the bundle under key 'no_selected_items'.

Returns:

The message

setNoSelectedItemsMsg

public void setNoSelectedItemsMsg(String noSelectedItemsMsg)

Sets the no selected items message to display in the UI

Parameters:

noSelectedItemsMsg - The message

getSelectItemMsg

public String getSelectItemMsg()

Returns the message to display for select an item, if one hasn't been set it defaults to the message in the bundle under key 'select_an_item'.

Returns:

The message

setSelectItemMsg

public void setSelectItemMsg(String selectItemMsg)

Sets the select an item message to display in the UI

Parameters:

selectItemMsg - The message

getReadOnly

public boolean getReadOnly()

Determines whether the component is in read only mode

Returns:

true if the component is in read only mode

setReadOnly

public void setReadOnly(boolean readOnly)

Sets the read only mode for the component

Parameters:

readOnly - true to set read only mode

getAddingNewItem

public boolean getAddingNewItem()

Determines whether the component is adding a new item

Returns:

true if we are adding a new item

broadcast

public void broadcast(FacesEvent event)
               throws AbortProcessingException

Overrides:

broadcast in class UIInput

Throws:

AbortProcessingException

See Also:

UIComponent.broadcast(javax.faces.event.FacesEvent)

encodeChildren

public void encodeChildren(FacesContext context)
                    throws IOException

Overrides:

encodeChildren in class UIComponentBase

Throws:

IOException

getRendersChildren

public boolean getRendersChildren()

Overrides:

getRendersChildren in class UIComponentBase

See Also:

UIComponent.getRendersChildren()