Package org.opencms.gwt.client.ui.input

Class CmsCategoryField

java.lang.Object
com.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.Widget
com.google.gwt.user.client.ui.Composite
org.opencms.gwt.client.ui.input.CmsCategoryField
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, I_CmsHasInit, I_CmsHasResizeOnShow, I_CmsFormWidget
public class CmsCategoryField extends com.google.gwt.user.client.ui.Composite implements I_CmsFormWidget, I_CmsHasInit, I_CmsHasResizeOnShow
Basic category widget for forms.

Since:
8.0.0

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    protected class 
    CmsCategoryField.A_SelectionHandler
    Selection handler to handle check box click events and double clicks on the list items.

    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

    Nested classes/interfaces inherited from interface org.opencms.gwt.client.ui.input.I_CmsFormWidget

    I_CmsFormWidget.FieldType

  • Field Summary

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

    DEBUG_ID_PREFIX

  • Constructor Summary

    Constructors
    Constructor
    Description
    CmsCategoryField()
    Category field widgets for ADE forms.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    buildCategoryTree(List<org.opencms.gwt.shared.CmsCategoryTreeEntry> treeEntries, Collection<String> selectedCategories)
    Builds and shows the category tree.
    List<String>
    getAllSitePath()
    Returns the site path of all shown categories.
    String
    getApparentValue()
    Returns the "apparent value", i.e.
    I_CmsFormWidget.FieldType
    getFieldType()
    Returns the type of data this widget produces.
    Object
    getFormValue()
    Gets the selected/entered value from the widget.
    String
    getFormValueAsString()
    Gets the current value of the widget as a string.
    CmsScrollPanel
    getScrollPanel()
    Returns the scroll panel of this widget.
    String
    getSingelSitePath()
    Returns the site path of the last category.
    int
    getValuesSet()
    Returns the count of values set to show.
    static void
    initClass()
    Initializes this class.
    boolean
    isEnabled()
    Returns true if this widget is enabled.
    static boolean
    isParentCategoryOfSelected(String category, Collection<String> selection)
    Checks if the given category is a parent category of any element of the given selection.
    protected void
    onAttach()
     
    void
    reset()
    Resets the widget to its default state.
    void
    resizeOnShow()
    Adjusts widget's size once it's visible.
    void
    setAutoHideParent(I_CmsAutoHider autoHideParent)
    Call this when auto hiding parents are shown.
    void
    setEnabled(boolean enabled)
    Enables or disables the widget.
    void
    setErrorMessage(String errorMessage)
    Sets the error message for this widget.
    void
    setFormValueAsString(String value)
    Sets the current value of the widget as a string.
    void
    setHeight(int height)
    Sets the height of this category field.
    void
    setParentSelection(boolean value)
    Sets if the parent category should be selected with the child or not.
    void
    setSelected(Object value)
    Sets the value of the widget.
    void
    setSelectedAsString(String newValue)
    Set the selected categories.

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

    claimElement, getWidget, initializeClaimedElement, initWidget, isAttached, 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