Package org.opencms.ui.apps.git

Class CmsGitToolOptionsPanel

  • 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 CmsGitToolOptionsPanel
extends com.vaadin.v7.ui.VerticalLayout
    Main widget for the Git check-in tool.

    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 ADDINFO_EMAIL
      Additional info key for the email address.
      static java.lang.String ADDINFO_MESSAGE
      Additional info key for the commit message.
      static java.lang.String ADDINFO_USER
      Additional info key for the user name.
      protected boolean m_advancedVisible
      True when advanced options are currently visible.

      • 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 Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.vaadin.ui.Window addAsWindow​(com.vaadin.ui.Component component)
      Opens a modal window with the given component as content.
      void addSelectableModule​(java.lang.String moduleName)
      Adds a check box and info widget for a module which should be selectable for check-in.
      void enableCheckboxesForNotInstalledModules​(boolean enable)
      Enables/disables checkboxes for listed modules which are not installed.
      java.util.Collection<java.lang.String> getSelectedModules()
      Gets the modules which are selected for check-in.
      void runAction​(org.opencms.ui.apps.git.CmsGitToolOptionsPanel.ActionType action)
      Executes one of the dialog actions.
      void setActionFlags()
      Sets the flags for the current action.
      void setAdvancedVisible​(boolean visible)
      Changes visibility of the advanced options.
      void setTab​(org.opencms.ui.apps.git.CmsGitToolOptionsPanel.DialogTab dialogTab)
      Called when the active tab is switched.
      protected void updateForNewConfiguration​(CmsGitConfiguration gitConfig)
      Updates the options panel for a special configuration.
      void updateNewModuleSelector()
      Updates the selection widget for adding new modules.

      • 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, readDesign, 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

      • CmsGitToolOptionsPanel

        public CmsGitToolOptionsPanel​(CmsGitCheckin checkinBean)
        Creates a new instance.

        Parameters:
        checkinBean - the bean to be used for the check-in operation.

    • Method Detail

      • addAsWindow

        public com.vaadin.ui.Window addAsWindow​(com.vaadin.ui.Component component)
        Opens a modal window with the given component as content.

        Parameters:
        component - the window content
        Returns:
        the window which is opened

      • addSelectableModule

        public void addSelectableModule​(java.lang.String moduleName)
        Adds a check box and info widget for a module which should be selectable for check-in.

        Parameters:
        moduleName - the name of the module

      • enableCheckboxesForNotInstalledModules

        public void enableCheckboxesForNotInstalledModules​(boolean enable)
        Enables/disables checkboxes for listed modules which are not installed.

        Parameters:
        enable - true if the checkboxes for modules which are not installed should be enabled, false if they should be disabled

      • getSelectedModules

        public java.util.Collection<java.lang.String> getSelectedModules()
        Gets the modules which are selected for check-in.

        Returns:
        the selected modules

      • runAction

        public void runAction​(org.opencms.ui.apps.git.CmsGitToolOptionsPanel.ActionType action)
        Executes one of the dialog actions.

        Parameters:
        action - the action to perform

      • setActionFlags

        public void setActionFlags()
        Sets the flags for the current action.

      • setAdvancedVisible

        public void setAdvancedVisible​(boolean visible)
        Changes visibility of the advanced options.

        Parameters:
        visible - true if the options should be shown

      • setTab

        public void setTab​(org.opencms.ui.apps.git.CmsGitToolOptionsPanel.DialogTab dialogTab)
        Called when the active tab is switched.

        Parameters:
        dialogTab - the dialog tab to which the user has switched

      • updateNewModuleSelector

        public void updateNewModuleSelector()
        Updates the selection widget for adding new modules.