Package org.opencms.ade.containerpage.client.ui.groupeditor

Class A_CmsGroupEditor

  • All Implemented Interfaces:
    com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsRenderable, com.google.gwt.user.client.ui.IsWidget
    Direct Known Subclasses:
    CmsGroupContainerEditor, CmsInheritanceContainerEditor
    public abstract class A_CmsGroupEditor
extends com.google.gwt.user.client.ui.Composite
    Abstract group editor.

    Since:
    8.5.0

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

        com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected com.google.gwt.dom.client.DivElement m_containerMarker
      The container marker div element.
      protected com.google.gwt.user.client.ui.FlowPanel m_dialogContent
      The dialog element.
      protected org.opencms.ade.containerpage.shared.CmsContainerElementData m_elementData
      The container element data.
      protected com.google.gwt.dom.client.DivElement m_overlayDiv
      The overlay div element.

      • Fields inherited from class com.google.gwt.user.client.ui.UIObject

        DEBUG_ID_PREFIX

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      protected void addButton​(com.google.gwt.user.client.ui.Widget button)
      Adds a button to the dialog.
      protected abstract void addButtons()
      Adds the buttons to the dialog.
      protected void addCancelButton()
      Adds a cancel button to the dialog.
      protected void addInputField​(java.lang.String label, com.google.gwt.user.client.ui.Widget inputWidget)
      Adds an input field with the given label to the dialog.
      protected abstract void addInputFields()
      Adds the required input fields to the dialog.
      protected void addSaveButton()
      Adds the save button to the dialog.
      protected abstract void cancelEdit()
      On click function for cancel button.
      protected abstract void clearInstance()
      Clears the static instance reference.
      protected void closeDialog​(boolean breakingUp)
      Closes the dialog.
      protected com.google.gwt.dom.client.Element createPlaceholder​(com.google.gwt.dom.client.Element element)
      Creates a place-holder for the group-container.
      protected java.util.List<CmsContainerPageElementPanel> getBackUpElements()
      Returns the list of back up elements.
      protected CmsContainerpageController getController()
      Returns the container page controller.
      protected java.util.Set<java.lang.String> getElementIds()
      Returns the ids of the contained elements and group-container itself.
      protected java.util.List<org.opencms.ade.containerpage.shared.CmsContainerElement> getElements()
      Returns the element data of the contained elements.
      CmsGroupContainerElementPanel getGroupContainerWidget()
      Returns the group container widget.
      CmsContainerpageHandler getHandler()
      Returns the the container page handler.
      protected int getIndexPosition()
      Returns the group container widget index position.
      protected CmsContainerPageContainer getParentContainer()
      Returns the parent container widget.
      void hidePopup()
      Hides the editor pop-up.
      protected void openDialog​(java.lang.String dialogTitle)
      Opens the group container edit dialog.
      abstract void reinitializeButtons()
      Reinitializes the option bar buttons on the contained elements.
      protected void removeAllChildren()
      Removes all child container elements.
      protected abstract void saveEdit()
      On click function for save button.
      protected void setSaveEnabled​(boolean enabled, java.lang.String disabledMessage)
      Enables or disables the save button.
      void showPopup()
      Shows the editor pop-up.
      void updateBackupElements​(java.util.Map<java.lang.String,​org.opencms.ade.containerpage.shared.CmsContainerElementData> updateElements)
      Updates the backup elements.

      • Methods inherited from class com.google.gwt.user.client.ui.Composite

        claimElement, getWidget, initializeClaimedElement, initWidget, isAttached, onAttach, onBrowserEvent, onDetach, render, render, resolvePotentialElement, setWidget

      • Methods inherited from class com.google.gwt.user.client.ui.Widget

        addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

      • Methods inherited from class com.google.gwt.user.client.ui.UIObject

        addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • m_containerMarker

        @UiField
protected com.google.gwt.dom.client.DivElement m_containerMarker
        The container marker div element.

      • m_dialogContent

        @UiField
protected com.google.gwt.user.client.ui.FlowPanel m_dialogContent
        The dialog element.

      • m_elementData

        protected org.opencms.ade.containerpage.shared.CmsContainerElementData m_elementData
        The container element data.

      • m_overlayDiv

        @UiField
protected com.google.gwt.dom.client.DivElement m_overlayDiv
        The overlay div element.

    • Method Detail

      • hidePopup

        public void hidePopup()
        Hides the editor pop-up. Use during inline editing.

      • reinitializeButtons

        public abstract void reinitializeButtons()
        Reinitializes the option bar buttons on the contained elements.

      • showPopup

        public void showPopup()
        Shows the editor pop-up.

      • updateBackupElements

        public void updateBackupElements​(java.util.Map<java.lang.String,​org.opencms.ade.containerpage.shared.CmsContainerElementData> updateElements)
        Updates the backup elements.

        Parameters:
        updateElements - the updated element data

      • addButton

        protected void addButton​(com.google.gwt.user.client.ui.Widget button)
        Adds a button to the dialog.

        Parameters:
        button - the button to add

      • addButtons

        protected abstract void addButtons()
        Adds the buttons to the dialog.

      • addCancelButton

        protected void addCancelButton()
        Adds a cancel button to the dialog.

      • addInputField

        protected void addInputField​(java.lang.String label,
                             com.google.gwt.user.client.ui.Widget inputWidget)
        Adds an input field with the given label to the dialog.

        Parameters:
        label - the label
        inputWidget - the input widget

      • addInputFields

        protected abstract void addInputFields()
        Adds the required input fields to the dialog.

      • addSaveButton

        protected void addSaveButton()
        Adds the save button to the dialog.

      • cancelEdit

        protected abstract void cancelEdit()
        On click function for cancel button.

      • clearInstance

        protected abstract void clearInstance()
        Clears the static instance reference.

      • closeDialog

        protected void closeDialog​(boolean breakingUp)
        Closes the dialog.

        Parameters:
        breakingUp - true if the group container is to be removed

      • createPlaceholder

        protected com.google.gwt.dom.client.Element createPlaceholder​(com.google.gwt.dom.client.Element element)
        Creates a place-holder for the group-container.

        Parameters:
        element - the element
        Returns:
        the place-holder widget

      • getElementIds

        protected java.util.Set<java.lang.String> getElementIds()
        Returns the ids of the contained elements and group-container itself.

        Returns:
        the element ids

      • getElements

        protected java.util.List<org.opencms.ade.containerpage.shared.CmsContainerElement> getElements()
        Returns the element data of the contained elements.

        Returns:
        the contained elements data

      • getIndexPosition

        protected int getIndexPosition()
        Returns the group container widget index position.

        Returns:
        the index position

      • openDialog

        protected void openDialog​(java.lang.String dialogTitle)
        Opens the group container edit dialog.

        Parameters:
        dialogTitle - the dialog title

      • removeAllChildren

        protected void removeAllChildren()
        Removes all child container elements.

      • saveEdit

        protected abstract void saveEdit()
        On click function for save button.

      • setSaveEnabled

        protected void setSaveEnabled​(boolean enabled,
                              java.lang.String disabledMessage)
        Enables or disables the save button.

        Parameters:
        enabled - true to enable the save button
        disabledMessage - the message to display when the button is disabled