UIDialogForm (eXo PLF:: ECM Suite 5.3.x-SNAPSHOT API)

java.lang.Object
- org.exoplatform.webui.core.UIComponent
- - org.exoplatform.webui.core.UIContainer
  - - org.exoplatform.webui.form.UIForm
    - - org.exoplatform.ecm.webui.form.UIDialogForm

Direct Known Subclasses:

UIActionForm, UIActionForm, UIAddMetadataForm, UIContentDialogForm, UIDocumentForm, UIFCCActionForm, UIFCCForm, UIViewMetadataForm
```
public class UIDialogForm
extends org.exoplatform.webui.form.UIForm
```
Created by The eXo Platform SAS

Author:

: Hoa.Pham hoa.pham@exoplatform.com Jun 23, 2008

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class UIDialogForm.AddActionListener

static class UIDialogForm.OnchangeActionListener
- Nested classes/interfaces inherited from class org.exoplatform.webui.core.UIContainer
  org.exoplatform.webui.core.UIContainer.SelectTabActionListener

Nested Classes
Modifier and Type	Class and Description
`static class`	`UIDialogForm.AddActionListener`
`static class`	`UIDialogForm.OnchangeActionListener`

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String[]`	`ACTIONS`
`protected static String`	`CANCEL_ACTION`
`protected Map<String,Map<String,String>>`	`componentSelectors`
`protected String`	`contentType`
`protected Map<String,String>`	`fieldNames`
`protected String`	`i18nNodePath`
`protected boolean`	`isAddNew`
`protected boolean`	`isReference`
`protected boolean`	`isRemoveActionField`
`protected boolean`	`isRemovePreference`
`protected boolean`	`isShowActionsOnTop_`
`protected boolean`	`isShowingComponent`
`protected boolean`	`isUpdateSelect`
`protected String`	`nodePath`
`protected Map<String,String>`	`options`
`protected Map<String,JcrInputProperty>`	`properties`
`protected Map<String,String>`	`propertiesName`
`protected String`	`repositoryName`
`protected JCRResourceResolver`	`resourceResolver`
`protected static String`	`SAVE_ACTION`
`protected static String`	`SAVE_AND_CLOSE`
`protected Map<String,String[]>`	`uiMultiValueParam`
`protected String`	`workspaceName`

Fields inherited from class org.exoplatform.webui.form.UIForm
ACTION, SUBCOMPONENT_ID

Fields inherited from class org.exoplatform.webui.core.UIComponent
AJAX_ASYNC, config, OBJECTID, UICOMPONENT, uiparent

Constructor Summary

Constructors
Constructor and Description

UIDialogForm()

Constructors
Constructor and Description
`UIDialogForm()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addActionField(String name, String[] arguments)`
`void`	`addActionField(String name, String label, String[] arguments)`
`void`	`addCalendarField(String name, String[] arguments)`
`void`	`addCalendarField(String name, String label, String[] arguments)`
`void`	`addCheckBoxField(String name, String[] arguments)`
`void`	`addCheckBoxField(String name, String lable, String[] arguments)`
`void`	`addHiddenField(String name, String[] arguments)`
`void`	`addInterceptor(String scriptPath, String type)`
`void`	`addMixinField(String name, String[] arguments)`
`void`	`addMixinField(String name, String label, String[] arguments)`
`void`	`addNew(boolean b)`
`void`	`addRadioBoxField(String name, String[] arguments)`
`void`	`addRadioBoxField(String name, String label, String[] arguments)`
`void`	`addRemovedNode(String path)`
`void`	`addRichtextField(String name, String[] arguments)`
`void`	`addRichtextField(String name, String label, String[] arguments)`
`void`	`addSelectBoxField(String name, String[] arguments)`
`void`	`addSelectBoxField(String name, String label, String[] arguments)`
`void`	`addTextAreaField(String name, String[] arguments)`
`void`	`addTextAreaField(String name, String label, String[] arguments)`
`void`	`addTextField(String name, String[] arguments)`
`void`	`addTextField(String name, String label, String[] arguments)`
`void`	`addUploadField(String name, String[] arguments)`
`void`	`addUploadField(String name, String label, String[] arguments)`
`void`	`addWYSIWYGField(String name, String[] arguments)`
`void`	`addWYSIWYGField(String name, String label, String[] arguments)`
`void`	`clearDataRemovedList()`
`void`	`clearRemovedNode()`
`boolean`	`dataRemoved()` Deprecated.
`protected String`	`getCategoryLabel(String resource)`
`javax.jcr.Node`	`getChildNode()`
`String`	`getContentType()`
`String`	`geti18nNodePath()`
`String`	`getImage(InputStream input, String nodeName)`
`String`	`getImage(javax.jcr.Node node, String nodeTypeName)`
`String`	`getInputOption(String name)`
`Map<String,String>`	`getInputOptions()`
`Map<String,JcrInputProperty>`	`getInputProperties()`
`JcrInputProperty`	`getInputProperty(String name)`
`JCRResourceResolver`	`getJCRResourceResolver()`
`String`	`getLastModifiedDate()`
`String`	`getLastModifiedDate(javax.jcr.Node node)`
`List<String>`	`getListTaxonomy()`
`javax.jcr.Node`	`getNode()`
`javax.jcr.Node`	`getNodeByType(String nodeType)`
`String`	`getNodePath()`
`String`	`getPathTaxonomy()`
`String`	`getPropertyName(String jcrPath)`
`protected List<String>`	`getRemovedNodes()`
`String`	`getSelectBoxFieldValue(String name)`
`List<String>`	`getSelectedBoxFieldValue(String name)`
`String`	`getSelectedTab()`
`javax.jcr.Session`	`getSession()`
`String`	`getStoredPath()`
`String`	`getTemplate()`
`boolean`	`isAddNew()`
`boolean`	`isDataRemoved(String path)` Checking the binary field is removed or not
`boolean`	`isEditing()`
`boolean`	`isKeepinglock()`
`boolean`	`isOnchange()`
`boolean`	`isResetForm()`
`boolean`	`isShowActionsOnTop()`
`void`	`onchange(org.exoplatform.webui.event.Event<?> event)`
`void`	`processAction(org.exoplatform.webui.application.WebuiRequestContext context)`
`void`	`processRenderAction()`
`void`	`releaseLock()`
`void`	`removeComponent(String name)`
`void`	`removeData(String path)` Mark a uploaded field as removed.
`void`	`renderField(String name)`
`void`	`resetInterceptors()`
`void`	`resetProperties()`
`void`	`setChildPath(String childPath)`
`void`	`setContentType(String type)`
`void`	`setDataRemoved(boolean dataRemoved)` Deprecated.
`void`	`seti18nNodePath(String nodePath)`
`void`	`setInputOption(String name, String value)`
`void`	`setInputProperty(String name, JcrInputProperty value)`
`void`	`setIsKeepinglock(boolean isKeepinglock)`
`void`	`setIsNotEditNode(boolean isNotEditNode)`
`void`	`setIsNTFile(boolean isNTFile)`
`void`	`setIsOnchange(boolean isOnchange)`
`void`	`setIsResetForm(boolean isResetForm)`
`void`	`setIsResetMultiField(boolean isResetMultiField)`
`void`	`setIsUpdateSelect(boolean isUpdateSelect)`
`void`	`setJCRResourceResolver(JCRResourceResolver resourceResolver)`
`void`	`setListTaxonomy(List<String> listTaxonomy)`
`void`	`setNodePath(String nodePath)`
`void`	`setRepositoryName(String repositoryName)`
`void`	`setSelectedTab(String selectedTab)`
`void`	`setShowActionsOnTop(boolean isShowActionsOnTop)`
`void`	`setStoredLocation(String workspace, String storedPath)`
`void`	`setStoredPath(String storedPath)`
`void`	`setWorkspace(String workspace)`

Methods inherited from class org.exoplatform.webui.form.UIForm
addUIComponentInput, addUIFormInput, addUIFormInput, begin, end, event, event, event, getActions, getLabel, getLabel, getSubmitAction, getUICheckBoxInput, getUIComponentName, getUIFormCheckBoxInput, getUIFormDateTimeInput, getUIFormInputInfo, getUIFormSelectBox, getUIFormTextAreaInput, getUIInput, getUIStringInput, invokeGetBindingBean, invokeSetBindingBean, isMultipart, processRender, renderField, reset, setActions, setMultiPart, setSubmitAction, url

Methods inherited from class org.exoplatform.webui.core.UIContainer
addChild, addChild, findComponentById, findComponentOfType, findFirstComponentOfType, getChild, getChild, getChildById, getChildren, hasChildren, removeChild, removeChildById, renderChild, renderChild, renderChild, renderChild, renderChildren, renderChildren, renderUIComponent, replaceChild, replaceChild, setChildren, setRenderedChild, setRenderedChild, setRenderedChildrenOfTypes

Methods inherited from class org.exoplatform.webui.core.UIComponent
broadcast, buildModelObject, createEvent, createUIComponent, createUIComponent, createUIComponent, doAsync, event, getAncestorOfType, getApplicationComponent, getComponentConfig, getId, getName, getParent, getTemplateResourceResolver, isRendered, loadConfirmMesssage, processDecode, renderEventURL, setComponentConfig, setComponentConfig, setId, setParent, setRendered, setRenderSibling, url, url

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CANCEL_ACTION

protected static final String CANCEL_ACTION

See Also:: Constant Field Values

SAVE_ACTION

protected static final String SAVE_ACTION

See Also:: Constant Field Values

SAVE_AND_CLOSE

protected static final String SAVE_AND_CLOSE

See Also:: Constant Field Values

ACTIONS

protected static final String[] ACTIONS

componentSelectors

protected Map<String,Map<String,String>> componentSelectors

fieldNames

protected Map<String,String> fieldNames

propertiesName

protected Map<String,String> propertiesName

uiMultiValueParam

protected Map<String,String[]> uiMultiValueParam

contentType
```
protected String contentType
```

isAddNew
```
protected boolean isAddNew
```

isRemovePreference
```
protected boolean isRemovePreference
```

isRemoveActionField
```
protected boolean isRemoveActionField
```

isShowingComponent
```
protected boolean isShowingComponent
```

isUpdateSelect
```
protected boolean isUpdateSelect
```

properties

protected Map<String,JcrInputProperty> properties

options
```
protected Map<String,String> options
```

repositoryName
```
protected String repositoryName
```

resourceResolver

protected JCRResourceResolver resourceResolver

nodePath
```
protected String nodePath
```

i18nNodePath
```
protected String i18nNodePath
```

workspaceName
```
protected String workspaceName
```

isReference
```
protected boolean isReference
```

isShowActionsOnTop_
```
protected boolean isShowActionsOnTop_
```

Constructor Detail
- UIDialogForm
```
public UIDialogForm()
```

Method Detail

isEditing
```
public boolean isEditing()
```

isAddNew
```
public boolean isAddNew()
```

addNew
```
public void addNew(boolean b)
```

setSelectedTab

public void setSelectedTab(String selectedTab)

getSelectedTab
```
public String getSelectedTab()
```

isKeepinglock
```
public boolean isKeepinglock()
```

setIsKeepinglock

public void setIsKeepinglock(boolean isKeepinglock)

isShowActionsOnTop
```
public boolean isShowActionsOnTop()
```

setShowActionsOnTop

public void setShowActionsOnTop(boolean isShowActionsOnTop)

releaseLock

public void releaseLock()
                 throws Exception

Throws:: Exception

getListTaxonomy
```
public List<String> getListTaxonomy()
```

setListTaxonomy

public void setListTaxonomy(List<String> listTaxonomy)

setStoredLocation

public void setStoredLocation(String workspace,
                              String storedPath)

getCategoryLabel

protected String getCategoryLabel(String resource)

seti18nNodePath

public void seti18nNodePath(String nodePath)

geti18nNodePath
```
public String geti18nNodePath()
```

addActionField

public void addActionField(String name,
                           String label,
                           String[] arguments)
                    throws Exception

Throws:: Exception

addActionField

public void addActionField(String name,
                           String[] arguments)
                    throws Exception

Throws:: Exception

addCalendarField

public void addCalendarField(String name,
                             String label,
                             String[] arguments)
                      throws Exception

Throws:: Exception

addCalendarField

public void addCalendarField(String name,
                             String[] arguments)
                      throws Exception

Throws:: Exception

addHiddenField

public void addHiddenField(String name,
                           String[] arguments)
                    throws Exception

Throws:: Exception

addInterceptor

public void addInterceptor(String scriptPath,
                           String type)

addMixinField

public void addMixinField(String name,
                          String label,
                          String[] arguments)
                   throws Exception

Throws:: Exception

addMixinField

public void addMixinField(String name,
                          String[] arguments)
                   throws Exception

Throws:: Exception

addCheckBoxField

public void addCheckBoxField(String name,
                             String lable,
                             String[] arguments)
                      throws Exception

Throws:: Exception

addCheckBoxField

public void addCheckBoxField(String name,
                             String[] arguments)
                      throws Exception

Throws:: Exception

addRadioBoxField

public void addRadioBoxField(String name,
                             String label,
                             String[] arguments)
                      throws Exception

Throws:: Exception

addRadioBoxField

public void addRadioBoxField(String name,
                             String[] arguments)
                      throws Exception

Throws:: Exception

addSelectBoxField

public void addSelectBoxField(String name,
                              String label,
                              String[] arguments)
                       throws Exception

Throws:: Exception

addSelectBoxField

public void addSelectBoxField(String name,
                              String[] arguments)
                       throws Exception

Throws:: Exception

addTextAreaField

public void addTextAreaField(String name,
                             String label,
                             String[] arguments)
                      throws Exception

Throws:: Exception

addTextAreaField

public void addTextAreaField(String name,
                             String[] arguments)
                      throws Exception

Throws:: Exception

getPathTaxonomy

public String getPathTaxonomy()
                       throws Exception

Throws:: Exception

addTextField

public void addTextField(String name,
                         String label,
                         String[] arguments)
                  throws Exception

Throws:: Exception

addTextField

public void addTextField(String name,
                         String[] arguments)
                  throws Exception

Throws:: Exception

addUploadField

public void addUploadField(String name,
                           String label,
                           String[] arguments)
                    throws Exception

Throws:: Exception

addUploadField

public void addUploadField(String name,
                           String[] arguments)
                    throws Exception

Throws:: Exception

addWYSIWYGField

public void addWYSIWYGField(String name,
                            String label,
                            String[] arguments)
                     throws Exception

Throws:: Exception

addWYSIWYGField

public void addWYSIWYGField(String name,
                            String[] arguments)
                     throws Exception

Throws:: Exception

addRichtextField

public void addRichtextField(String name,
                             String label,
                             String[] arguments)
                      throws Exception

Throws:: Exception

addRichtextField

public void addRichtextField(String name,
                             String[] arguments)
                      throws Exception

Throws:: Exception

getChildNode

public javax.jcr.Node getChildNode()
                            throws Exception

Throws:: Exception

getContentType
```
public String getContentType()
```

getInputProperties

public Map<String,JcrInputProperty> getInputProperties()

getInputOptions

public Map<String,String> getInputOptions()

getInputProperty

public JcrInputProperty getInputProperty(String name)

getInputOption

public String getInputOption(String name)

getJCRResourceResolver

public JCRResourceResolver getJCRResourceResolver()

getNode
```
public javax.jcr.Node getNode()
```

getPropertyName

public String getPropertyName(String jcrPath)

getSelectBoxFieldValue

public String getSelectBoxFieldValue(String name)

getSelectedBoxFieldValue

public List<String> getSelectedBoxFieldValue(String name)

getSession

public javax.jcr.Session getSession()
                             throws Exception

Throws:: Exception

getTemplate
```
public String getTemplate()
```
Overrides:

getTemplate in class org.exoplatform.webui.core.UIComponent

isResetForm
```
public boolean isResetForm()
```

onchange

public void onchange(org.exoplatform.webui.event.Event<?> event)
              throws Exception

Throws:: Exception

processAction

public void processAction(org.exoplatform.webui.application.WebuiRequestContext context)
                   throws Exception

Overrides:: processAction in class org.exoplatform.webui.core.UIComponent
Throws:: Exception

removeComponent

public void removeComponent(String name)

renderField
```
public void renderField(String name)
                 throws Exception
```
Overrides:

renderField in class org.exoplatform.webui.form.UIForm

Throws:

Exception

getImage

public String getImage(javax.jcr.Node node,
                       String nodeTypeName)
                throws Exception

Throws:: Exception

getImage

public String getImage(InputStream input,
                       String nodeName)
                throws Exception

Throws:: Exception

dataRemoved

@Deprecated
public boolean dataRemoved()

Deprecated.

setDataRemoved

@Deprecated
public void setDataRemoved(boolean dataRemoved)

Deprecated.

removeData
```
public void removeData(String path)
```
Mark a uploaded field as removed.

Parameters:

path: - of property content binarydata for uploading

isDataRemoved
```
public boolean isDataRemoved(String path)
```
Checking the binary field is removed or not

Parameters:

path: - of property content binarydata for uploading

Returns:

: True if the uploaded field is removed from UI

clearDataRemovedList
```
public void clearDataRemovedList()
```

resetProperties
```
public void resetProperties()
```

resetInterceptors
```
public void resetInterceptors()
```

setChildPath

public void setChildPath(String childPath)

setContentType

public void setContentType(String type)

setInputProperty

public void setInputProperty(String name,
                             JcrInputProperty value)

setInputOption

public void setInputOption(String name,
                           String value)

setIsNotEditNode

public void setIsNotEditNode(boolean isNotEditNode)

setIsNTFile

public void setIsNTFile(boolean isNTFile)

setIsOnchange

public void setIsOnchange(boolean isOnchange)

setIsResetForm

public void setIsResetForm(boolean isResetForm)

setIsResetMultiField

public void setIsResetMultiField(boolean isResetMultiField)

setIsUpdateSelect

public void setIsUpdateSelect(boolean isUpdateSelect)

setJCRResourceResolver

public void setJCRResourceResolver(JCRResourceResolver resourceResolver)

setNodePath

public void setNodePath(String nodePath)

getNodePath
```
public String getNodePath()
```

setRepositoryName

public void setRepositoryName(String repositoryName)

setStoredPath

public void setStoredPath(String storedPath)

getStoredPath
```
public String getStoredPath()
```

setWorkspace

public void setWorkspace(String workspace)

getLastModifiedDate

public String getLastModifiedDate()
                           throws Exception

Throws:: Exception

getLastModifiedDate

public String getLastModifiedDate(javax.jcr.Node node)

getRemovedNodes

protected List<String> getRemovedNodes()

addRemovedNode

public void addRemovedNode(String path)

clearRemovedNode
```
public void clearRemovedNode()
```

isOnchange
```
public boolean isOnchange()
```

processRenderAction

public void processRenderAction()
                         throws Exception

Throws:: Exception

getNodeByType

public javax.jcr.Node getNodeByType(String nodeType)
                             throws Exception

Throws:: Exception

Class UIDialogForm

Nested Class Summary

Nested classes/interfaces inherited from class org.exoplatform.webui.core.UIContainer

Field Summary

Fields inherited from class org.exoplatform.webui.form.UIForm

Fields inherited from class org.exoplatform.webui.core.UIComponent

Constructor Summary

Method Summary

Methods inherited from class org.exoplatform.webui.form.UIForm

Methods inherited from class org.exoplatform.webui.core.UIContainer

Methods inherited from class org.exoplatform.webui.core.UIComponent

Methods inherited from class java.lang.Object

Field Detail

CANCEL_ACTION

SAVE_ACTION

SAVE_AND_CLOSE

ACTIONS

componentSelectors

fieldNames

propertiesName

uiMultiValueParam

contentType

isAddNew

isRemovePreference

isRemoveActionField

isShowingComponent

isUpdateSelect

properties

options

repositoryName

resourceResolver

nodePath

i18nNodePath

workspaceName

isReference

isShowActionsOnTop_

Constructor Detail

UIDialogForm

Method Detail

isEditing

isAddNew

addNew

setSelectedTab

getSelectedTab

isKeepinglock

setIsKeepinglock

isShowActionsOnTop

setShowActionsOnTop

releaseLock

getListTaxonomy

setListTaxonomy

setStoredLocation

getCategoryLabel

seti18nNodePath

geti18nNodePath

addActionField

addActionField

addCalendarField

addCalendarField

addHiddenField

addInterceptor

addMixinField

addMixinField

addCheckBoxField

addCheckBoxField

addRadioBoxField

addRadioBoxField

addSelectBoxField

addSelectBoxField

addTextAreaField

addTextAreaField

getPathTaxonomy

addTextField

addTextField

addUploadField

addUploadField

addWYSIWYGField

addWYSIWYGField

addRichtextField

addRichtextField