|
|||||||||
| 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.UIPanel
org.alfresco.web.ui.repo.component.property.UIPropertySheet
public class UIPropertySheet
Component that represents the properties of a Node
| Nested Class Summary | |
|---|---|
static class |
UIPropertySheet.ClientValidation
Inner class representing a validation case that must be enforced. |
| Field Summary | |
|---|---|
static java.lang.String |
EDIT_MODE
|
protected java.util.List |
validations
|
static java.lang.String |
VIEW_MODE
|
| Fields inherited from class javax.faces.component.UIPanel |
|---|
COMPONENT_FAMILY, COMPONENT_TYPE |
| Fields inherited from interface javax.faces.component.NamingContainer |
|---|
SEPARATOR_CHAR |
| Constructor Summary | |
|---|---|
UIPropertySheet()
Default constructor |
|
| Method Summary | |
|---|---|
void |
addClientValidation(UIPropertySheet.ClientValidation validation)
Adds a validation case to the property sheet |
void |
encodeBegin(javax.faces.context.FacesContext context)
|
void |
encodeEnd(javax.faces.context.FacesContext context)
|
java.util.List |
getClientValidations()
|
java.lang.String |
getConfigArea()
|
java.lang.String |
getFamily()
|
java.lang.String |
getFinishButtonId()
Returns the id of the finish button |
java.lang.String |
getMode()
|
java.lang.String |
getNextButtonId()
Returns the id of the next button |
Node |
getNode()
|
java.lang.String |
getVar()
|
boolean |
inEditMode()
Determines whether the property sheet is in edit mode |
boolean |
isReadOnly()
|
boolean |
isValidationEnabled()
|
protected void |
renderValidationMethod(javax.faces.context.ResponseWriter out,
UIPropertySheet.ClientValidation validation,
boolean lastMethod,
boolean showMessage)
|
protected void |
renderValidationScript(javax.faces.context.FacesContext context)
Renders the necessary JavaScript to enforce any constraints the properties have. |
void |
restoreState(javax.faces.context.FacesContext context,
java.lang.Object state)
|
java.lang.Object |
saveState(javax.faces.context.FacesContext context)
|
void |
setConfigArea(java.lang.String configArea)
|
void |
setFinishButtonId(java.lang.String finishButtonId)
Sets the id of the finish button being used on the page |
void |
setMode(java.lang.String mode)
|
void |
setNextButtonId(java.lang.String nextButtonId)
Sets the id of the next button being used on the page |
void |
setNode(Node node)
|
void |
setReadOnly(boolean readOnly)
|
void |
setValidationEnabled(boolean validationEnabled)
|
void |
setVar(java.lang.String variable)
|
| Methods inherited from class javax.faces.component.UIComponentBase |
|---|
addFacesListener, broadcast, decode, encodeChildren, 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 |
| Field Detail |
|---|
public static final java.lang.String VIEW_MODE
public static final java.lang.String EDIT_MODE
protected java.util.List validations
| Constructor Detail |
|---|
public UIPropertySheet()
| Method Detail |
|---|
public java.lang.String getFamily()
getFamily in class javax.faces.component.UIPanelUIComponent.getFamily()
public void encodeBegin(javax.faces.context.FacesContext context)
throws java.io.IOException
encodeBegin in class javax.faces.component.UIComponentBasejava.io.IOExceptionUIComponent.encodeBegin(javax.faces.context.FacesContext)
public void encodeEnd(javax.faces.context.FacesContext context)
throws java.io.IOException
encodeEnd in class javax.faces.component.UIComponentBasejava.io.IOExceptionUIComponent.encodeBegin(javax.faces.context.FacesContext)
public void restoreState(javax.faces.context.FacesContext context,
java.lang.Object state)
restoreState in interface javax.faces.component.StateHolderrestoreState in class javax.faces.component.UIComponentBaseStateHolder.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.UIComponentBaseStateHolder.saveState(javax.faces.context.FacesContext)public Node getNode()
public void setNode(Node node)
node - The nodepublic java.lang.String getVar()
public void setVar(java.lang.String variable)
variable - The variable to set.public boolean isReadOnly()
public void setReadOnly(boolean readOnly)
readOnly - Sets the read only flag for the property sheetpublic boolean isValidationEnabled()
public void setValidationEnabled(boolean validationEnabled)
validationEnabled - Sets the validationEnabled flagpublic java.lang.String getFinishButtonId()
public void setFinishButtonId(java.lang.String finishButtonId)
finishButtonId - The id of the finish buttonpublic java.lang.String getNextButtonId()
public void setNextButtonId(java.lang.String nextButtonId)
nextButtonId - The id of the next buttonpublic java.lang.String getMode()
public void setMode(java.lang.String mode)
mode - Sets the modepublic boolean inEditMode()
public java.lang.String getConfigArea()
public void setConfigArea(java.lang.String configArea)
configArea - Sets the config area to usepublic void addClientValidation(UIPropertySheet.ClientValidation validation)
validation - The validation case to enforcepublic java.util.List getClientValidations()
protected void renderValidationScript(javax.faces.context.FacesContext context)
throws java.io.IOException
context - FacesContext
java.io.IOException
protected void renderValidationMethod(javax.faces.context.ResponseWriter out,
UIPropertySheet.ClientValidation validation,
boolean lastMethod,
boolean showMessage)
throws java.io.IOException
java.io.IOException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||