Class CmsPrincipalSelectDialog
- 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.dialogs.permissions.CmsPrincipalSelectDialog
-
- 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 CmsPrincipalSelectDialog extends CmsBasicDialog
Class for the dialog to show the principal table.- 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
DIALOG_ID
The dialog id.static java.lang.String
PARAM_OU
Parameter key OU.static java.lang.String
PARAM_REAL_ONLY
Parameter key real groups only.static java.lang.String
PARAM_START_TYPE
Parameter key start view type.static java.lang.String
PARAM_TYPE
Parameter key widget type.
-
Constructor Summary
Constructors Constructor Description CmsPrincipalSelectDialog(I_CmsPrincipalSelect cmsPrincipalSelect, java.lang.String ou, com.vaadin.ui.Window window, CmsPrincipalSelect.WidgetType widgetType, boolean realOnly, CmsPrincipalSelect.PrincipalType defaultView)
public constructor.CmsPrincipalSelectDialog(I_CmsPrincipalSelect cmsPrincipalSelect, java.lang.String ou, com.vaadin.ui.Window window, CmsPrincipalSelect.WidgetType widgetType, boolean realOnly, CmsPrincipalSelect.PrincipalType defaultView, boolean includeWebOus, boolean roleSelectionAllowed)
public constructor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static void
openEmbeddedDialog(CmsEmbeddedDialogContext dialogContext, java.util.Map<java.lang.String,java.lang.String[]> params)
Opens the principal select dialog within an embedded dialog context.static void
openEmbeddedDialog(CmsEmbeddedDialogContext dialogContext, java.util.Map<java.lang.String,java.lang.String[]> params, boolean includeWebOus)
Opens the principal select dialog within an embedded dialog context.static void
openEmbeddedDialogV2(CmsEmbeddedDialogContext dialogContext, java.util.Map<java.lang.String,java.lang.String> params, boolean includeWebOus)
Opens the principal select dialog within an embedded dialog context.void
select(I_CmsPrincipal value)
Selects a principal and closes the dialog.void
setOuComboBoxEnabled(boolean enabled)
En/Disables the ou combo box.void
setSelectHandler(CmsPrincipalSelect.I_PrincipalSelectHandler selectHandler)
Sets the principal select handler.-
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
-
PARAM_OU
public static final java.lang.String PARAM_OU
Parameter key OU.- See Also:
- Constant Field Values
-
PARAM_TYPE
public static final java.lang.String PARAM_TYPE
Parameter key widget type.- See Also:
- Constant Field Values
-
PARAM_START_TYPE
public static final java.lang.String PARAM_START_TYPE
Parameter key start view type.- See Also:
- Constant Field Values
-
PARAM_REAL_ONLY
public static final java.lang.String PARAM_REAL_ONLY
Parameter key real groups only.- See Also:
- Constant Field Values
-
DIALOG_ID
public static final java.lang.String DIALOG_ID
The dialog id.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CmsPrincipalSelectDialog
public CmsPrincipalSelectDialog(I_CmsPrincipalSelect cmsPrincipalSelect, java.lang.String ou, com.vaadin.ui.Window window, CmsPrincipalSelect.WidgetType widgetType, boolean realOnly, CmsPrincipalSelect.PrincipalType defaultView)
public constructor.- Parameters:
cmsPrincipalSelect
- calling vaadin componentou
- the current OUwindow
- window to be closed after finishingwidgetType
- type of principal to be shownrealOnly
- true, only show real principalsdefaultView
- default mode to open
-
CmsPrincipalSelectDialog
public CmsPrincipalSelectDialog(I_CmsPrincipalSelect cmsPrincipalSelect, java.lang.String ou, com.vaadin.ui.Window window, CmsPrincipalSelect.WidgetType widgetType, boolean realOnly, CmsPrincipalSelect.PrincipalType defaultView, boolean includeWebOus, boolean roleSelectionAllowed)
public constructor.- Parameters:
cmsPrincipalSelect
- calling vaadin componentou
- the current OUwindow
- window to be closed after finishingwidgetType
- type of principal to be shownrealOnly
- true, only show real principalsdefaultView
- default mode to openincludeWebOus
- if web OUs should be includedroleSelectionAllowed
- if true, selecting roles should be allowed (if the widget type allows for roles)
-
-
Method Detail
-
openEmbeddedDialog
public static void openEmbeddedDialog(CmsEmbeddedDialogContext dialogContext, java.util.Map<java.lang.String,java.lang.String[]> params)
Opens the principal select dialog within an embedded dialog context.- Parameters:
dialogContext
- the dialog contextparams
- the request parameters
-
openEmbeddedDialog
public static void openEmbeddedDialog(CmsEmbeddedDialogContext dialogContext, java.util.Map<java.lang.String,java.lang.String[]> params, boolean includeWebOus)
Opens the principal select dialog within an embedded dialog context.- Parameters:
dialogContext
- the dialog contextparams
- the request parametersincludeWebOus
- include WebOu?
-
openEmbeddedDialogV2
public static void openEmbeddedDialogV2(CmsEmbeddedDialogContext dialogContext, java.util.Map<java.lang.String,java.lang.String> params, boolean includeWebOus)
Opens the principal select dialog within an embedded dialog context.- Parameters:
dialogContext
- the dialog contextparams
- the request parametersincludeWebOus
- include WebOu?
-
select
public void select(I_CmsPrincipal value)
Selects a principal and closes the dialog.- Parameters:
value
- the principal which was clicked
-
setOuComboBoxEnabled
public void setOuComboBoxEnabled(boolean enabled)
En/Disables the ou combo box.- Parameters:
enabled
- enabled boolean
-
setSelectHandler
public void setSelectHandler(CmsPrincipalSelect.I_PrincipalSelectHandler selectHandler)
Sets the principal select handler.- Parameters:
selectHandler
- the principal select handler
-
-