Package org.opencms.ui.apps.modules.edit
Class CmsEditModuleForm
- java.lang.Object
-
- com.vaadin.server.AbstractClientConnector
-
- com.vaadin.ui.AbstractComponent
-
- com.vaadin.ui.AbstractComponentContainer
-
- com.vaadin.ui.AbstractLayout
-
- com.vaadin.ui.AbstractOrderedLayout
-
- com.vaadin.ui.VerticalLayout
-
- org.opencms.ui.components.CmsBasicDialog
-
- org.opencms.ui.apps.modules.edit.CmsEditModuleForm
-
- All Implemented Interfaces:
com.vaadin.event.ContextClickEvent.ContextClickNotifier
,com.vaadin.event.LayoutEvents.LayoutClickNotifier
,com.vaadin.event.MethodEventSource
,com.vaadin.server.ClientConnector
,com.vaadin.server.Sizeable
,com.vaadin.shared.Connector
,com.vaadin.ui.Component
,com.vaadin.ui.ComponentContainer
,com.vaadin.ui.HasComponents
,com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier
,com.vaadin.ui.Layout
,com.vaadin.ui.Layout.AlignmentHandler
,com.vaadin.ui.Layout.MarginHandler
,com.vaadin.ui.Layout.SpacingHandler
,java.io.Serializable
,java.lang.Iterable<com.vaadin.ui.Component>
public class CmsEditModuleForm extends CmsBasicDialog
Form for editing a module.- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.opencms.ui.components.CmsBasicDialog
CmsBasicDialog.DialogWidth
-
Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector
com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener
-
Nested classes/interfaces inherited from interface com.vaadin.ui.Component
com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.Listener
-
Nested classes/interfaces inherited from interface com.vaadin.ui.HasComponents
com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.HasComponents.ComponentAttachEvent, com.vaadin.ui.HasComponents.ComponentAttachListener, com.vaadin.ui.HasComponents.ComponentDetachEvent, com.vaadin.ui.HasComponents.ComponentDetachListener
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
COMPLEX_ROW
CSS class.static java.lang.String
CONFIG_FILE
static java.lang.String
ID_EMPTY_SITE
Dummy site root used to identify the 'none' select option in the module site selector.static java.lang.String
PATH_CLASSES
Classes folder within the module.static java.lang.String
PATH_ELEMENTS
Elements folder within the module.static java.lang.String
PATH_FORMATTERS
The formatters folder within the module.static java.lang.String
PATH_LIB
Lib folder within the module.static java.lang.String
PATH_RESOURCES
Resources folder within the module.static java.lang.String
PATH_SCHEMAS
Schemas folder within the module.static java.lang.String
PATH_TEMPLATES
Template folder within the module.
-
Constructor Summary
Constructors Constructor Description CmsEditModuleForm(CmsModule module, boolean newModule, java.lang.Runnable updateCallback)
Creates a new instance.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addDependencyRow(CmsModuleDependency dep)
Adds another entry to the list of module dependencies in the dependencies tab.void
addExportPointRow(java.lang.String src, java.lang.String target)
Adds another entry to the list of export points in the export point tab.static com.vaadin.v7.data.util.IndexedContainer
getModuleSiteContainer(CmsObject cms, java.lang.String captionPropertyName, java.lang.String prevValue)
Builds the container used for the module site selector.void
updateModule()
Writes the form data back to the module.-
Methods inherited from class org.opencms.ui.components.CmsBasicDialog
addButton, addButton, createButtonCancel, createButtonClose, createButtonOK, createResourceListPanel, createResourceListPanelDirectly, displayResourceInfo, displayResourceInfo, displayResourceInfo, displayResourceInfoDirectly, enableMaxHeight, getInfoResources, initActionHandler, prepareWindow, prepareWindow, readDesign, setAbove, setActionHandler, setBelow, setContent, setContentMinHeight, setContentVisibility, setWindowMinFullHeight
-
Methods inherited from class com.vaadin.ui.VerticalLayout
addComponentsAndExpand, getState, getState
-
Methods inherited from class com.vaadin.ui.AbstractOrderedLayout
addComponent, addComponent, addComponentAsFirst, addLayoutClickListener, getComponent, getComponentAlignment, getComponentCount, getComponentIndex, getCustomAttributes, getDefaultComponentAlignment, getExpandRatio, getMargin, isSpacing, iterator, removeComponent, removeLayoutClickListener, replaceComponent, setComponentAlignment, setDefaultComponentAlignment, setExpandRatio, setMargin, setMargin, setSpacing, writeDesign
-
Methods inherited from class com.vaadin.ui.AbstractComponentContainer
addComponentAttachListener, addComponentDetachListener, addComponents, fireComponentAttachEvent, fireComponentDetachEvent, getComponentIterator, moveComponentsFrom, removeAllComponents, removeComponentAttachListener, removeComponentDetachListener, setHeight, setWidth
-
Methods inherited from class com.vaadin.ui.AbstractComponent
addContextClickListener, addListener, addShortcutListener, addStyleName, attach, beforeClientResponse, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, focus, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isOrHasAncestor, isReadOnly, isRequiredIndicatorVisible, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeightFull, setHeightUndefined, setIcon, setId, setLocale, setParent, setPrimaryStyleName, setReadOnly, setRequiredIndicatorVisible, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setVisible, setWidth, setWidthFull, setWidthUndefined
-
Methods inherited from class com.vaadin.server.AbstractClientConnector
addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource, updateDiffstate
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.vaadin.server.ClientConnector
addAttachListener, addDetachListener, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler
-
Methods inherited from interface com.vaadin.ui.Component
addListener, addStyleName, addStyleNames, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, removeListener, removeStyleName, removeStyleNames, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, setStyleName, setVisible
-
Methods inherited from interface com.vaadin.ui.ComponentContainer
addComponents, getComponentIterator, moveComponentsFrom, removeAllComponents
-
-
-
-
Field Detail
-
COMPLEX_ROW
public static final java.lang.String COMPLEX_ROW
CSS class.- See Also:
- Constant Field Values
-
ID_EMPTY_SITE
public static final java.lang.String ID_EMPTY_SITE
Dummy site root used to identify the 'none' select option in the module site selector.- See Also:
- Constant Field Values
-
PATH_CLASSES
public static final java.lang.String PATH_CLASSES
Classes folder within the module.- See Also:
- Constant Field Values
-
PATH_ELEMENTS
public static final java.lang.String PATH_ELEMENTS
Elements folder within the module.- See Also:
- Constant Field Values
-
PATH_FORMATTERS
public static final java.lang.String PATH_FORMATTERS
The formatters folder within the module.- See Also:
- Constant Field Values
-
PATH_LIB
public static final java.lang.String PATH_LIB
Lib folder within the module.- See Also:
- Constant Field Values
-
PATH_RESOURCES
public static final java.lang.String PATH_RESOURCES
Resources folder within the module.- See Also:
- Constant Field Values
-
PATH_SCHEMAS
public static final java.lang.String PATH_SCHEMAS
Schemas folder within the module.- See Also:
- Constant Field Values
-
PATH_TEMPLATES
public static final java.lang.String PATH_TEMPLATES
Template folder within the module.- See Also:
- Constant Field Values
-
CONFIG_FILE
public static final java.lang.String CONFIG_FILE
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CmsEditModuleForm
public CmsEditModuleForm(CmsModule module, boolean newModule, java.lang.Runnable updateCallback)
Creates a new instance.- Parameters:
module
- the module to editnewModule
- true if the module is a new one, false for editing an existing moduleupdateCallback
- the update callback
-
-
Method Detail
-
getModuleSiteContainer
public static com.vaadin.v7.data.util.IndexedContainer getModuleSiteContainer(CmsObject cms, java.lang.String captionPropertyName, java.lang.String prevValue)
Builds the container used for the module site selector.- Parameters:
cms
- the CMS contextcaptionPropertyName
- the name of the property used to store captionsprevValue
- the value previously set in the module- Returns:
- the container with the available sites
-
addDependencyRow
public void addDependencyRow(CmsModuleDependency dep)
Adds another entry to the list of module dependencies in the dependencies tab.- Parameters:
dep
- the module dependency for which a new row should be added
-
addExportPointRow
public void addExportPointRow(java.lang.String src, java.lang.String target)
Adds another entry to the list of export points in the export point tab.- Parameters:
src
- the export point sourcetarget
- the export point target
-
updateModule
public void updateModule()
Writes the form data back to the module.
-
-