Class 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 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
      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.
      • 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
    • 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.
      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 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
    • 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 component
        ou - the current OU
        window - window to be closed after finishing
        widgetType - type of principal to be shown
        realOnly - true, only show real principals
        defaultView - 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 component
        ou - the current OU
        window - window to be closed after finishing
        widgetType - type of principal to be shown
        realOnly - true, only show real principals
        defaultView - default mode to open
        includeWebOus - if web OUs should be included
        roleSelectionAllowed - 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 context
        params - 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 context
        params - the request parameters
        includeWebOus - 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