org.alfresco.web.ui.repo.component.property
Class PropertySheetItem
java.lang.Object
javax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIPanel
org.alfresco.web.ui.repo.component.property.PropertySheetItem
- All Implemented Interfaces:
- javax.faces.component.NamingContainer, javax.faces.component.StateHolder
- Direct Known Subclasses:
- UIAssociation, UIChildAssociation, UIProperty, UISeparator
public abstract class PropertySheetItem
- extends javax.faces.component.UIPanel
- implements javax.faces.component.NamingContainer
Abstract base class for all items that can appear in a property sheet component
Fields inherited from class javax.faces.component.UIPanel |
COMPONENT_FAMILY, COMPONENT_TYPE |
Fields inherited from interface javax.faces.component.NamingContainer |
SEPARATOR_CHAR |
Methods inherited from class javax.faces.component.UIPanel |
getFamily |
Methods inherited from class javax.faces.component.UIComponentBase |
addFacesListener, broadcast, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, 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 |
name
protected java.lang.String name
displayLabel
protected java.lang.String displayLabel
converter
protected java.lang.String converter
readOnly
protected java.lang.Boolean readOnly
ignoreIfMissing
protected java.lang.Boolean ignoreIfMissing
componentGenerator
protected java.lang.String componentGenerator
resolvedDisplayLabel
protected java.lang.String resolvedDisplayLabel
PropertySheetItem
public PropertySheetItem()
encodeBegin
public void encodeBegin(javax.faces.context.FacesContext context)
throws java.io.IOException
- Overrides:
encodeBegin
in class javax.faces.component.UIComponentBase
- Throws:
java.io.IOException
- See Also:
UIComponentBase.encodeBegin(javax.faces.context.FacesContext)
getDisplayLabel
public java.lang.String getDisplayLabel()
- Returns:
- Returns the display label
setDisplayLabel
public void setDisplayLabel(java.lang.String displayLabel)
- Parameters:
displayLabel
- Sets the display label
getName
public java.lang.String getName()
- Returns:
- Returns the name
setName
public void setName(java.lang.String name)
- Parameters:
name
- Sets the name
getConverter
public java.lang.String getConverter()
- Returns:
- Returns the converter
setComponentGenerator
public void setComponentGenerator(java.lang.String componentGenerator)
- Parameters:
componentGenerator
- Sets the component generator
getComponentGenerator
public java.lang.String getComponentGenerator()
- Returns:
- Returns the component generator
setConverter
public void setConverter(java.lang.String converter)
- Parameters:
converter
- Sets the converter
isReadOnly
public boolean isReadOnly()
- Returns:
- Returns whether the property is read only
setReadOnly
public void setReadOnly(boolean readOnly)
- Parameters:
readOnly
- Sets the read only flag for the component
getIgnoreIfMissing
public boolean getIgnoreIfMissing()
- Returns:
- Determines whether the item should be ignored (not rendered)
if the item can not be found
setIgnoreIfMissing
public void setIgnoreIfMissing(boolean ignoreIfMissing)
- Parameters:
ignoreIfMissing
- Sets the whether the item will be ignored
if it can not be found
restoreState
public void restoreState(javax.faces.context.FacesContext context,
java.lang.Object state)
- Specified by:
restoreState
in interface javax.faces.component.StateHolder
- Overrides:
restoreState
in class javax.faces.component.UIComponentBase
- See Also:
StateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object)
saveState
public java.lang.Object saveState(javax.faces.context.FacesContext context)
- Specified by:
saveState
in interface javax.faces.component.StateHolder
- Overrides:
saveState
in class javax.faces.component.UIComponentBase
- See Also:
StateHolder.saveState(javax.faces.context.FacesContext)
getResolvedDisplayLabel
public java.lang.String getResolvedDisplayLabel()
- Returns the resolved display label
- Returns:
- The display label being used at runtime
generateItem
protected abstract void generateItem(javax.faces.context.FacesContext context,
UIPropertySheet propSheet)
throws java.io.IOException
- Generates the label and control for the item
- Parameters:
context
- FacesContextpropSheet
- The property sheet that the item is a child of
- Throws:
java.io.IOException
getIncorrectParentMsg
protected abstract java.lang.String getIncorrectParentMsg()
- Returns the message to use in the exception that is thrown if the component
is not nested inside a PropertySheet component
- Returns:
- The message
generateLabel
protected void generateLabel(javax.faces.context.FacesContext context,
UIPropertySheet propSheet,
java.lang.String displayLabel)
- Generates a JSF OutputText component/renderer
- Parameters:
context
- JSF contextpropSheet
- The property sheet that the item is a child ofdisplayLabel
- The display label text
Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.