|
|||||||||
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.BaseAjaxItemPicker
public abstract class BaseAjaxItemPicker
Base class for the JSP components representing Ajax object pickers.
Handles the JSF lifecycle for the Ajax component. The Ajax calls themselves
are processed via the class org.alfresco.web.bean.ajax.PickerBean
.
The derived components are only responsible for specifing the ajax service call
to make, plus any defaults for icons etc.
Field Summary | |
---|---|
protected static int |
ACTION_CANCEL
|
protected static int |
ACTION_DONE
|
protected java.lang.Boolean |
disabled
flag to show whether the component is disabled |
protected static java.lang.String |
EMPTY
|
protected static java.lang.String |
FOLDER_IMAGE_PREFIX
|
protected java.lang.String |
height
Height style override for picker selector area |
protected static java.lang.String |
ID_ICON
|
protected static java.lang.String |
ID_ID
|
protected static java.lang.String |
ID_NAME
|
protected java.lang.String |
initialSelectionId
id of the initially selected item, if value is not set |
protected java.lang.String |
label
label to be displayed before an item is selected |
protected static java.lang.String |
MSG_CANCEL
|
protected static java.lang.String |
MSG_GO_UP
|
protected static java.lang.String |
MSG_OK
|
protected java.lang.Boolean |
singleSelect
True for single select mode, false for multi-select mode |
Fields inherited from class javax.faces.component.UIInput |
---|
COMPONENT_FAMILY, COMPONENT_TYPE, CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID |
Constructor Summary | |
---|---|
BaseAjaxItemPicker()
|
Method Summary | |
---|---|
void |
decode(javax.faces.context.FacesContext context)
|
void |
encodeBegin(javax.faces.context.FacesContext fc)
|
protected abstract java.lang.String |
getDefaultIcon()
|
abstract java.lang.String |
getFamily()
|
java.lang.String |
getHeight()
|
protected java.lang.String |
getHiddenFieldName()
We use a unique hidden field name based on our client Id. |
java.lang.String |
getInitialSelection()
|
protected java.lang.String |
getItemJson(java.lang.String id,
java.lang.String name,
java.lang.String icon)
Returns Json string representing an already-selected item. |
java.lang.String |
getLabel()
|
protected java.lang.String |
getRequestAttributes()
|
protected abstract java.lang.String |
getServiceCall()
|
java.lang.Boolean |
getSingleSelect()
|
boolean |
isDisabled()
Determines whether the component should be rendered in a disabled state |
void |
restoreState(javax.faces.context.FacesContext context,
java.lang.Object state)
|
java.lang.Object |
saveState(javax.faces.context.FacesContext context)
|
void |
setDisabled(boolean disabled)
Determines whether the component should be rendered in a disabled state |
void |
setHeight(java.lang.String height)
|
void |
setInitialSelection(java.lang.String initialSelection)
|
void |
setLabel(java.lang.String label)
|
void |
setSingleSelect(java.lang.Boolean singleSelect)
|
Methods inherited from class javax.faces.component.UIInput |
---|
addValidator, addValueChangeListener, broadcast, compareValues, 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, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, 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 |
---|
protected static final java.lang.String MSG_GO_UP
protected static final java.lang.String MSG_OK
protected static final java.lang.String MSG_CANCEL
protected static final java.lang.String ID_ID
protected static final java.lang.String ID_NAME
protected static final java.lang.String ID_ICON
protected static final java.lang.String EMPTY
protected static final java.lang.String FOLDER_IMAGE_PREFIX
protected java.lang.String label
protected java.lang.String initialSelectionId
protected java.lang.Boolean disabled
protected java.lang.Boolean singleSelect
protected java.lang.String height
protected static int ACTION_DONE
protected static int ACTION_CANCEL
Constructor Detail |
---|
public BaseAjaxItemPicker()
Method Detail |
---|
public abstract java.lang.String getFamily()
getFamily
in class javax.faces.component.UIInput
UIComponent.getFamily()
public void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class javax.faces.component.UIInput
StateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object)
public java.lang.Object saveState(javax.faces.context.FacesContext context)
saveState
in interface javax.faces.component.StateHolder
saveState
in class javax.faces.component.UIInput
StateHolder.saveState(javax.faces.context.FacesContext)
public void decode(javax.faces.context.FacesContext context)
decode
in class javax.faces.component.UIInput
UIComponentBase.decode(javax.faces.context.FacesContext)
public void encodeBegin(javax.faces.context.FacesContext fc) throws java.io.IOException
encodeBegin
in class javax.faces.component.UIComponentBase
java.io.IOException
UIComponentBase.encodeBegin(javax.faces.context.FacesContext)
protected abstract java.lang.String getServiceCall()
protected abstract java.lang.String getDefaultIcon()
protected java.lang.String getRequestAttributes()
public java.lang.String getLabel()
public void setLabel(java.lang.String label)
label
- The label to set.public java.lang.String getInitialSelection()
public void setInitialSelection(java.lang.String initialSelection)
initialSelection
- The initial selection to set.public boolean isDisabled()
public void setDisabled(boolean disabled)
disabled
- true to disable the componentpublic java.lang.Boolean getSingleSelect()
public void setSingleSelect(java.lang.Boolean singleSelect)
singleSelect
- true for single select mode, false for multi-selectpublic java.lang.String getHeight()
public void setHeight(java.lang.String height)
height
- The height to set.protected java.lang.String getHiddenFieldName()
protected java.lang.String getItemJson(java.lang.String id, java.lang.String name, java.lang.String icon)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |