Package org.opencms.ade.galleries.client.ui

Class CmsGalleryField

  • All Implemented Interfaces:
    com.google.gwt.event.dom.client.HasFocusHandlers, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.HasResizeHandlers, com.google.gwt.event.logical.shared.HasValueChangeHandlers<java.lang.String>, 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, I_CmsHasInit, I_CmsFormWidget
    Direct Known Subclasses:
    CmsImageGalleryField
    public class CmsGalleryField
extends com.google.gwt.user.client.ui.Composite
implements I_CmsFormWidget, I_CmsHasInit, com.google.gwt.event.logical.shared.HasValueChangeHandlers<java.lang.String>, com.google.gwt.event.logical.shared.HasResizeHandlers, com.google.gwt.event.dom.client.HasFocusHandlers
    A widget for selecting a resource from an ADE gallery dialog.

    Since:
    8.0.0

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      protected static interface  CmsGalleryField.I_CmsGalleryFieldUiBinder
      The UI Binder interface for this widget.
      protected class  CmsGalleryField.OpenCloseHandler
      Handler to fire resize event on resource info widget open/close.

      • 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

    • Constructor Summary

      Constructors 
      Constructor Description
      CmsGalleryField​(org.opencms.ade.galleries.shared.I_CmsGalleryConfiguration configuration, boolean allowUploads)
      Constructs a new gallery widget.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addFieldStyleName​(java.lang.String styleName)
      Adds a style name to the DIV carrying the input field.
      com.google.gwt.event.shared.HandlerRegistration addFocusHandler​(com.google.gwt.event.dom.client.FocusHandler handler)  
      com.google.gwt.event.shared.HandlerRegistration addResizeHandler​(com.google.gwt.event.logical.shared.ResizeHandler handler)  
      protected void addToMain​(com.google.gwt.user.client.ui.IsWidget widget)
      Adds a widget to the main panel.
      com.google.gwt.event.shared.HandlerRegistration addValueChangeHandler​(com.google.gwt.event.logical.shared.ValueChangeHandler<java.lang.String> handler)  
      protected void fireChange​(boolean force)
      Fires the value change event if the value has changed.
      protected void fireResize()
      Fires the resize event for this widget.
      java.lang.String getApparentValue()
      Returns the "apparent value", i.e.
      protected java.lang.String getCurrentElement()
      Returns the currently set resource path.
      I_CmsFormWidget.FieldType getFieldType()
      Returns the type of data this widget produces.
      java.lang.Object getFormValue()
      Gets the selected/entered value from the widget.
      java.lang.String getFormValueAsString()
      Gets the current value of the widget as a string.
      protected org.opencms.ade.galleries.shared.rpc.I_CmsGalleryServiceAsync getGalleryService()
      Returns the gallery service instance.
      CmsGalleryPopup getPopup()
      Returns the gallery popup.
      static void initClass()
      Initializes this class.
      protected boolean isDndEnabled()
      Checks if drag/drop should be enabled.
      boolean isEnabled()
      Returns true if this widget is enabled.
      protected void onFocusTextbox​(com.google.gwt.event.dom.client.FocusEvent event)
      Handles the focus event on the opener.
      protected void openGalleryDialog()
      Internal method which opens the gallery dialog.
      protected boolean removeFromMain​(com.google.gwt.user.client.ui.IsWidget widget)
      Removes the given widget from the main panel.
      void reset()
      Resets the widget to its default state.
      void setAutoHideParent​(I_CmsAutoHider autoHideParent)
      Call this when auto hiding parents are shown.
      void setDropZoneElement​(com.google.gwt.dom.client.Element dropZone)
      Sets the upload drop zone element.
      void setEnabled​(boolean enabled)
      Enables or disables the widget.
      void setErrorMessage​(java.lang.String errorMessage)
      Sets the error message for this widget.
      void setFormValueAsString​(java.lang.String value)
      Sets the current value of the widget as a string.
      void setGalleryOpenerTitle​(java.lang.String openerTitle)
      Sets the gallery opener button title.
      void setHasImage​(boolean hasImage)
      Sets the has image flag.
      protected void setImagePreview​(java.lang.String realPath, java.lang.String imagePath)
      Sets the image preview.
      void setName​(java.lang.String name)
      Sets the name of the input field.
      protected void setValue​(java.lang.String value, boolean fireEvent)
      Sets the widget value.
      protected void setValueFromGallery​(java.lang.String resourcePath, org.opencms.util.CmsUUID structureId, CmsCroppingParamBean croppingParameter)
      Sets the widget value.
      protected void updateUploadTarget​(java.lang.String uploadTarget)
      Updates the upload target folder path.

      • 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

      • Methods inherited from interface com.google.gwt.event.shared.HasHandlers

        fireEvent

    • Constructor Detail

      • CmsGalleryField

        public CmsGalleryField​(org.opencms.ade.galleries.shared.I_CmsGalleryConfiguration configuration,
                       boolean allowUploads)
        Constructs a new gallery widget.

        Parameters:
        configuration - the gallery configuration
        allowUploads - states if the upload button should be enabled for this widget

    • Method Detail

      • initClass

        public static void initClass()
        Initializes this class.

      • addFieldStyleName

        public void addFieldStyleName​(java.lang.String styleName)
        Adds a style name to the DIV carrying the input field.

        Parameters:
        styleName - the style name to add

      • addFocusHandler

        public com.google.gwt.event.shared.HandlerRegistration addFocusHandler​(com.google.gwt.event.dom.client.FocusHandler handler)
        Specified by:
        addFocusHandler in interface com.google.gwt.event.dom.client.HasFocusHandlers
        See Also:
        HasFocusHandlers.addFocusHandler(com.google.gwt.event.dom.client.FocusHandler)

      • addResizeHandler

        public com.google.gwt.event.shared.HandlerRegistration addResizeHandler​(com.google.gwt.event.logical.shared.ResizeHandler handler)
        Specified by:
        addResizeHandler in interface com.google.gwt.event.logical.shared.HasResizeHandlers
        See Also:
        HasResizeHandlers.addResizeHandler(com.google.gwt.event.logical.shared.ResizeHandler)

      • addValueChangeHandler

        public com.google.gwt.event.shared.HandlerRegistration addValueChangeHandler​(com.google.gwt.event.logical.shared.ValueChangeHandler<java.lang.String> handler)
        Specified by:
        addValueChangeHandler in interface com.google.gwt.event.logical.shared.HasValueChangeHandlers<java.lang.String>
        See Also:
        HasValueChangeHandlers.addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler)

      • setDropZoneElement

        public void setDropZoneElement​(com.google.gwt.dom.client.Element dropZone)
        Sets the upload drop zone element.

        Parameters:
        dropZone - the upload drop zone element

      • setGalleryOpenerTitle

        public void setGalleryOpenerTitle​(java.lang.String openerTitle)
        Sets the gallery opener button title.

        Parameters:
        openerTitle - the gallery opener button title

      • setHasImage

        public void setHasImage​(boolean hasImage)
        Sets the has image flag.

        Parameters:
        hasImage - the has image flag

      • setName

        public void setName​(java.lang.String name)
        Sets the name of the input field.

        Parameters:
        name - of the input field

      • addToMain

        protected void addToMain​(com.google.gwt.user.client.ui.IsWidget widget)
        Adds a widget to the main panel.

        Parameters:
        widget - the widget to add

      • fireChange

        protected void fireChange​(boolean force)
        Fires the value change event if the value has changed.

        Parameters:
        force - true to force firing the event in any case

      • fireResize

        protected void fireResize()
        Fires the resize event for this widget.

      • getCurrentElement

        protected java.lang.String getCurrentElement()
        Returns the currently set resource path.

        Returns:
        the currently set resource path

      • getGalleryService

        protected org.opencms.ade.galleries.shared.rpc.I_CmsGalleryServiceAsync getGalleryService()
        Returns the gallery service instance.

        Returns:
        the gallery service instance

      • isDndEnabled

        protected boolean isDndEnabled()
        Checks if drag/drop should be enabled.
        Returns:
        true if drag/drop should be enabled

      • onFocusTextbox

        @UiHandler("m_textbox")
protected void onFocusTextbox​(com.google.gwt.event.dom.client.FocusEvent event)
        Handles the focus event on the opener.

        Parameters:
        event - the focus event

      • openGalleryDialog

        protected void openGalleryDialog()
        Internal method which opens the gallery dialog.

      • removeFromMain

        protected boolean removeFromMain​(com.google.gwt.user.client.ui.IsWidget widget)
        Removes the given widget from the main panel.

        Parameters:
        widget - the widget to remove
        Returns:
        true if the widget was a child of the main panel

      • setImagePreview

        protected void setImagePreview​(java.lang.String realPath,
                               java.lang.String imagePath)
        Sets the image preview.

        Parameters:
        realPath - the actual image path
        imagePath - the image path

      • setValue

        protected void setValue​(java.lang.String value,
                        boolean fireEvent)
        Sets the widget value.

        Parameters:
        value - the value to set
        fireEvent - if the change event should be fired

      • setValueFromGallery

        protected void setValueFromGallery​(java.lang.String resourcePath,
                                   org.opencms.util.CmsUUID structureId,
                                   CmsCroppingParamBean croppingParameter)
        Sets the widget value. To be called from the gallery dialog.

        Parameters:
        resourcePath - the selected resource path
        structureId - the resource structure id
        croppingParameter - the selected cropping

      • updateUploadTarget

        protected void updateUploadTarget​(java.lang.String uploadTarget)
        Updates the upload target folder path.

        Parameters:
        uploadTarget - the upload target folder