|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIOutput
javax.faces.component.UIInput
org.alfresco.web.ui.repo.component.UIMultiValueEditor
public class UIMultiValueEditor
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.
| Nested Class Summary | |
|---|---|
static class |
UIMultiValueEditor.MultiValueEditorEvent
Class representing an action relevant to the ChildAssociationEditor component. |
| Field Summary | |
|---|---|
static int |
ACTION_ADD
|
static int |
ACTION_NONE
|
static int |
ACTION_REMOVE
|
static int |
ACTION_SELECT
|
static java.lang.String |
ACTION_SEPARATOR
|
| Fields inherited from class javax.faces.component.UIInput |
|---|
COMPONENT_FAMILY, COMPONENT_TYPE, CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID |
| Constructor Summary | |
|---|---|
UIMultiValueEditor()
Default constructor |
|
| Method Summary | |
|---|---|
void |
broadcast(javax.faces.event.FacesEvent event)
|
void |
encodeChildren(javax.faces.context.FacesContext context)
|
boolean |
getAddingNewItem()
Determines whether the component is adding a new item |
java.lang.String |
getFamily()
|
java.lang.Object |
getLastItemAdded()
Returns the last item added by the user |
java.lang.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()
|
java.lang.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'. |
java.lang.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(javax.faces.context.FacesContext context,
java.lang.Object state)
|
java.lang.Object |
saveState(javax.faces.context.FacesContext context)
|
void |
setLastItemAdded(java.lang.Object lastItemAdded)
Sets the last item to be added by the user |
void |
setNoSelectedItemsMsg(java.lang.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(java.lang.String selectedItemsMsg)
Sets the selected items message to display in the UI |
void |
setSelectItemMsg(java.lang.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, 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, getValue, 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, getValue, setConverter |
| Field Detail |
|---|
public static final java.lang.String ACTION_SEPARATOR
public static final int ACTION_NONE
public static final int ACTION_REMOVE
public static final int ACTION_SELECT
public static final int ACTION_ADD
| Constructor Detail |
|---|
public UIMultiValueEditor()
| Method Detail |
|---|
public java.lang.String getFamily()
getFamily in class javax.faces.component.UIInputUIComponent.getFamily()
public void restoreState(javax.faces.context.FacesContext context,
java.lang.Object state)
restoreState in interface javax.faces.component.StateHolderrestoreState in class javax.faces.component.UIInputStateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object)public java.lang.Object saveState(javax.faces.context.FacesContext context)
saveState in interface javax.faces.component.StateHoldersaveState in class javax.faces.component.UIInputStateHolder.saveState(javax.faces.context.FacesContext)public java.lang.Object getLastItemAdded()
public void setLastItemAdded(java.lang.Object lastItemAdded)
lastItemAdded - The last item addedpublic java.lang.String getSelectedItemsMsg()
public void setSelectedItemsMsg(java.lang.String selectedItemsMsg)
selectedItemsMsg - The messagepublic java.lang.String getNoSelectedItemsMsg()
public void setNoSelectedItemsMsg(java.lang.String noSelectedItemsMsg)
noSelectedItemsMsg - The messagepublic java.lang.String getSelectItemMsg()
public void setSelectItemMsg(java.lang.String selectItemMsg)
selectItemMsg - The messagepublic boolean getReadOnly()
public void setReadOnly(boolean readOnly)
readOnly - true to set read only modepublic boolean getAddingNewItem()
public void broadcast(javax.faces.event.FacesEvent event)
throws javax.faces.event.AbortProcessingException
broadcast in class javax.faces.component.UIInputjavax.faces.event.AbortProcessingExceptionUIComponent.broadcast(javax.faces.event.FacesEvent)
public void encodeChildren(javax.faces.context.FacesContext context)
throws java.io.IOException
encodeChildren in class javax.faces.component.UIComponentBasejava.io.IOExceptionpublic boolean getRendersChildren()
getRendersChildren in class javax.faces.component.UIComponentBaseUIComponent.getRendersChildren()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||