Package org.opencms.ui.apps.user

Class A_CmsEditUserGroupRoleDialog

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.user.A_CmsEditUserGroupRoleDialog

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>

Direct Known Subclasses:

CmsUserEditGroupsDialog, CmsUserEditRoleDialog

public abstract class A_CmsEditUserGroupRoleDialog
extends CmsBasicDialog

Abstract class for dialogs to change role or groups of a given user.

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

Nested classes/interfaces inherited from interface com.vaadin.ui.Layout

com.vaadin.ui.Layout.AlignmentHandler, com.vaadin.ui.Layout.MarginHandler, com.vaadin.ui.Layout.SpacingHandler

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

com.vaadin.server.Sizeable.Unit

Field Summary

Fields

Modifier and Type	Field	Description
protected CmsAccountsApp	m_app	The app instance.
protected CmsObject	m_cms	CmsObject.
protected CmsPrincipal	m_principal	User object to be edited.

Fields inherited from class com.vaadin.ui.AbstractOrderedLayout

ALIGNMENT_DEFAULT, components

Fields inherited from class com.vaadin.ui.AbstractComponent

DESIGN_ATTR_PLAIN_TEXT

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Constructor Summary

Constructors

Constructor	Description
A_CmsEditUserGroupRoleDialog(CmsObject cms, CmsUUID userId, com.vaadin.ui.Window window, CmsAccountsApp app)	public constructor.

Method Summary

Modifier and Type	Method	Description
abstract void	addItem(java.util.Set<java.lang.String> data)	Adds given items.
abstract java.lang.String	getAddActionCaption()	Caption for the add action.
abstract java.lang.String	getAddCaptionText()	Caption for the list with items to add.
abstract com.vaadin.v7.data.util.IndexedContainer	getAvailableItemsIndexedContainer(java.lang.String caption, java.lang.String propIcon)	Gets container with items which are available but not set.
abstract com.vaadin.ui.Button	getCloseButton()	Gets the close button to close the window.
abstract java.lang.String	getCurrentTableCaption()	Gets the caption for the table with the currently set elements for the user.
abstract java.lang.String	getDescriptionForItemId(java.lang.Object itemId)	Gets the description for the item.
abstract java.lang.String	getEmptyMessage()	Gets the empty message.
abstract java.lang.String	getFurtherColumnId()	Further ID for a column.
abstract com.vaadin.v7.ui.HorizontalLayout	getHLayout()	Gets the horizontal layout holding the tables.
abstract java.lang.String	getItemName()	Get name of the items.
abstract com.vaadin.v7.data.util.IndexedContainer	getItemsOfUserIndexedContainer(java.lang.String propName, java.lang.String propIcon, java.lang.String propStatus)	Gets container for items which are set for the user.
abstract com.vaadin.v7.ui.VerticalLayout	getLeftTableLayout()	Gets layout for the table with items which are set to the user.
abstract com.vaadin.v7.ui.VerticalLayout	getParentLayout()	Gets the parent layout.
abstract com.vaadin.v7.ui.VerticalLayout	getRightTableLayout()	Gets layout for the table with available item.
abstract java.util.Set<java.lang.String>	getStringSetValue(java.util.Set<java.lang.Object> value)	Get string values from given set of item-object.
abstract java.lang.String	getWindowCaptionMessageKey()	Gets the window caption message key.
protected void	init()	Init method.
abstract void	removeItem(java.util.Set<java.lang.String> items)	Remove items represented as strings (see getStringSetValue()).

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.AbstractLayout

readMargin, writeMargin

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

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier

addComponentAttachListener, addComponentDetachListener, removeComponentAttachListener, removeComponentDetachListener

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightFull, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull, setWidthUndefined

Field Detail

m_app

protected CmsAccountsApp m_app

The app instance.

m_cms

protected CmsObject m_cms

CmsObject.

m_principal

protected CmsPrincipal m_principal

User object to be edited.

Constructor Detail

A_CmsEditUserGroupRoleDialog

public A_CmsEditUserGroupRoleDialog(CmsObject cms,
                                    CmsUUID userId,
                                    com.vaadin.ui.Window window,
                                    CmsAccountsApp app)

public constructor.

Parameters:

cms - CmsObject

userId - id of user

window - window

app - the app instance

Method Detail

addItem

public abstract void addItem(java.util.Set<java.lang.String> data)

Adds given items.

Parameters:

data - data containing information about item to add (see getStringSetValue())

getAddActionCaption

public abstract java.lang.String getAddActionCaption()

Caption for the add action.

Returns:

String

getAddCaptionText

public abstract java.lang.String getAddCaptionText()

Caption for the list with items to add.

Returns:

String

getAvailableItemsIndexedContainer

public abstract com.vaadin.v7.data.util.IndexedContainer getAvailableItemsIndexedContainer(java.lang.String caption,
                                                                                           java.lang.String propIcon)

Gets container with items which are available but not set.

Parameters:

caption - caption property

propIcon - icon property

Returns:

IndexedContainer

getCloseButton

public abstract com.vaadin.ui.Button getCloseButton()

Gets the close button to close the window.

Returns:

the vaadin button

getCurrentTableCaption

public abstract java.lang.String getCurrentTableCaption()

Gets the caption for the table with the currently set elements for the user.

Returns:

String

getDescriptionForItemId

public abstract java.lang.String getDescriptionForItemId(java.lang.Object itemId)

Gets the description for the item.

Parameters:

itemId - to get description for

Returns:

String

getEmptyMessage

public abstract java.lang.String getEmptyMessage()

Gets the empty message.

Returns:

String

getFurtherColumnId

public abstract java.lang.String getFurtherColumnId()

Further ID for a column.

Returns:

id

getHLayout

public abstract com.vaadin.v7.ui.HorizontalLayout getHLayout()

Gets the horizontal layout holding the tables.

Returns:

horizontal layout

getItemName

public abstract java.lang.String getItemName()

Get name of the items.

Returns:

String

getItemsOfUserIndexedContainer

public abstract com.vaadin.v7.data.util.IndexedContainer getItemsOfUserIndexedContainer(java.lang.String propName,
                                                                                        java.lang.String propIcon,
                                                                                        java.lang.String propStatus)

Gets container for items which are set for the user.

Parameters:

propName - caption property

propIcon - icon property

propStatus - status property

Returns:

IndexedContainer

getLeftTableLayout

public abstract com.vaadin.v7.ui.VerticalLayout getLeftTableLayout()

Gets layout for the table with items which are set to the user.

Returns:

layout

getParentLayout

public abstract com.vaadin.v7.ui.VerticalLayout getParentLayout()

Gets the parent layout.

Returns:

layout

getRightTableLayout

public abstract com.vaadin.v7.ui.VerticalLayout getRightTableLayout()

Gets layout for the table with available item.

Returns:

layout

getStringSetValue

public abstract java.util.Set<java.lang.String> getStringSetValue(java.util.Set<java.lang.Object> value)

Get string values from given set of item-object.

Parameters:

value - set of items to create string set from

Returns:

set of strings

getWindowCaptionMessageKey

public abstract java.lang.String getWindowCaptionMessageKey()

Gets the window caption message key.

Returns:

message key

removeItem

public abstract void removeItem(java.util.Set<java.lang.String> items)

Remove items represented as strings (see getStringSetValue()).

Parameters:

items - to be removed

init

protected void init()

Init method.