|
|||||||||
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.AbstractItemSelector
public abstract class AbstractItemSelector
Abstract component to allow the selection of a hierarchical item
Nested Class Summary | |
---|---|
static class |
AbstractItemSelector.ItemSelectorEvent
Class representing the clicking of a breadcrumb element. |
Field Summary | |
---|---|
protected java.lang.String |
avmStore
current AVM store being browsed |
protected java.lang.Boolean |
disabled
Flag to show whether the component is disabled |
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 a space is selected |
protected int |
mode
what mode the component is in |
protected static int |
MODE_BEFORE_SELECTION
|
protected static int |
MODE_CANCEL_SELECTION
|
protected static int |
MODE_CONFIRM_SELECTION
|
protected static int |
MODE_DRILLDOWN_SELECTION
|
protected static int |
MODE_INITIAL_SELECTION
|
protected java.lang.String |
navigationId
currently browsing node id |
protected static java.lang.String |
OPTION
|
protected java.lang.Integer |
spacing
cellspacing between options |
Fields inherited from class javax.faces.component.UIInput |
---|
COMPONENT_FAMILY, COMPONENT_TYPE, CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID |
Constructor Summary | |
---|---|
AbstractItemSelector()
Default constructor |
Method Summary | |
---|---|
void |
broadcast(javax.faces.event.FacesEvent event)
|
void |
decode(javax.faces.context.FacesContext context)
|
void |
encodeBegin(javax.faces.context.FacesContext context)
|
protected java.lang.String |
encodeFieldValues(int mode,
java.lang.String id)
|
abstract java.util.Collection |
getChildrenForNode(javax.faces.context.FacesContext context)
Returns a collection of child associations for the current navigation node |
abstract java.lang.String |
getDefaultLabel()
Retrieves the default label to show if none has been defined and nothing has been selected |
protected static org.alfresco.service.cmr.dictionary.DictionaryService |
getDictionaryService(javax.faces.context.FacesContext context)
Use Spring JSF integration to return the Dictionary Service bean instance |
abstract java.lang.String |
getFamily()
|
protected static org.alfresco.service.cmr.repository.NodeService |
getFastNodeService(javax.faces.context.FacesContext context)
Use Spring JSF integration to return the node Service bean instance |
protected java.lang.String |
getHiddenFieldName()
We use a unique hidden field name based on our client Id. |
java.lang.String |
getInitialSelection()
|
abstract java.lang.String |
getItemIcon(javax.faces.context.FacesContext context,
org.alfresco.service.cmr.repository.NodeRef ref)
|
java.lang.String |
getLabel()
|
protected static org.alfresco.service.cmr.repository.NodeService |
getNodeService(javax.faces.context.FacesContext context)
Use Spring JSF integration to return the Node Service bean instance |
abstract java.lang.String |
getParentNodeId(javax.faces.context.FacesContext context)
Retrieves the id of the parent node of the current navigation node |
abstract java.util.Collection |
getRootChildren(javax.faces.context.FacesContext context)
Returns a collection of child associations of the root |
java.lang.Integer |
getSpacing()
|
boolean |
isDisabled()
Determines whether the component should be rendered in a disabled state |
protected java.lang.String |
renderNodeLink(javax.faces.context.FacesContext context,
java.lang.String id,
java.lang.String name,
java.lang.String prefix,
java.lang.StringBuilder buf)
Render a node descendant as a clickable link |
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 |
setInitialSelection(java.lang.String initialSelection)
|
void |
setLabel(java.lang.String label)
|
void |
setSpacing(java.lang.Integer spacing)
|
Methods inherited from class javax.faces.component.UIInput |
---|
addValidator, addValueChangeListener, 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 OPTION
protected static final int MODE_BEFORE_SELECTION
protected static final int MODE_INITIAL_SELECTION
protected static final int MODE_DRILLDOWN_SELECTION
protected static final int MODE_CONFIRM_SELECTION
protected static final int MODE_CANCEL_SELECTION
protected java.lang.String label
protected java.lang.Integer spacing
protected int mode
protected java.lang.String navigationId
protected java.lang.String avmStore
protected java.lang.String initialSelectionId
protected java.lang.Boolean disabled
Constructor Detail |
---|
public AbstractItemSelector()
Method Detail |
---|
public abstract java.lang.String getFamily()
getFamily
in class javax.faces.component.UIInput
UIComponent.getFamily()
public abstract java.lang.String getDefaultLabel()
public abstract java.lang.String getParentNodeId(javax.faces.context.FacesContext context)
context
- The Faces context
public abstract java.util.Collection getChildrenForNode(javax.faces.context.FacesContext context)
context
- The Faces context
public abstract java.util.Collection getRootChildren(javax.faces.context.FacesContext context)
context
- The Faces context
public abstract java.lang.String getItemIcon(javax.faces.context.FacesContext context, org.alfresco.service.cmr.repository.NodeRef ref)
ref
- NodeRef to the item to get the icon for
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 broadcast(javax.faces.event.FacesEvent event) throws javax.faces.event.AbortProcessingException
broadcast
in class javax.faces.component.UIInput
javax.faces.event.AbortProcessingException
UIInput.broadcast(javax.faces.event.FacesEvent)
public void encodeBegin(javax.faces.context.FacesContext context) throws java.io.IOException
encodeBegin
in class javax.faces.component.UIComponentBase
java.io.IOException
UIComponentBase.encodeBegin(javax.faces.context.FacesContext)
public java.lang.String getLabel()
public void setLabel(java.lang.String label)
label
- The label to set.public java.lang.Integer getSpacing()
public void setSpacing(java.lang.Integer spacing)
spacing
- The spacing 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 componentprotected java.lang.String getHiddenFieldName()
protected java.lang.String encodeFieldValues(int mode, java.lang.String id)
protected java.lang.String renderNodeLink(javax.faces.context.FacesContext context, java.lang.String id, java.lang.String name, java.lang.String prefix, java.lang.StringBuilder buf)
context
- FacesContextid
- The idname
- The nameprefix
- The prefixbuf
- String buffer
protected static org.alfresco.service.cmr.repository.NodeService getNodeService(javax.faces.context.FacesContext context)
context
- FacesContext
protected static org.alfresco.service.cmr.repository.NodeService getFastNodeService(javax.faces.context.FacesContext context)
context
- FacesContext
protected static org.alfresco.service.cmr.dictionary.DictionaryService getDictionaryService(javax.faces.context.FacesContext context)
context
- FacesContext
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |