Package org.opencms.acacia.client.widgets

Class CmsDependentSelectWidget

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.acacia.client.widgets.CmsDependentSelectWidget
All Implemented Interfaces:
com.google.gwt.event.dom.client.HasFocusHandlers, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.HasValueChangeHandlers<String>, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.TakesValue<String>, com.google.gwt.user.client.ui.HasValue<String>, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsRenderable, com.google.gwt.user.client.ui.IsWidget, I_CmsEditWidget, I_CmsHasDisplayDirection
public class CmsDependentSelectWidget extends com.google.gwt.user.client.ui.Composite implements I_CmsEditWidget, I_CmsHasDisplayDirection
Select widget which uses other values from the content as select options.

This works as follows: The widget is given a configuration consisting of three pipe-separated OpenCms content value paths. The first path is used to select a set of nested content values. The second and third paths are relative to the first path and are used to select a select option and a select option display text from the nested contents matching the first path. Note that if you omit indexes on a component of the first path, all indexes will be matched. You can also use relative paths for the first path. Like '../NestedNode' or '../../OtherNode'.

The widget attaches event listeners to the editor so it can dynamically update the list of select options when the content changes.

  • 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

    Nested classes/interfaces inherited from interface org.opencms.acacia.client.widgets.I_CmsHasDisplayDirection

    I_CmsHasDisplayDirection.Direction

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected CmsSelectBox
    m_selectBox
    The global select box.

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

    DEBUG_ID_PREFIX

  • Constructor Summary

    Constructors
    Constructor
    Description
    CmsDependentSelectWidget(String configuration)
    Creates a new widget instance.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.gwt.event.shared.HandlerRegistration
    addFocusHandler(com.google.gwt.event.dom.client.FocusHandler handler)
     
    com.google.gwt.event.shared.HandlerRegistration
    addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<String> handler)
     
    void
    fireChangeEvent()
    Represents a value change event.
    I_CmsHasDisplayDirection.Direction
    getDisplayingDirection()
    Returns the display direction.
    String
    getValue()
     
    boolean
    isActive()
    Returns if the widget is active.
    void
    onAttachWidget()
    This method is called when a widget is attached to the browser's document.
    void
    onLoad()
     
    boolean
    owns(com.google.gwt.dom.client.Element element)
    Returns true if the element should be logically counted as part of the widget for the purpose of determining whether a mouse click is "outside".
    void
    setActive(boolean active)
    Sets the widget active/inactive.
    void
    setName(String name)
    Sets the name of input fields.
    void
    setValue(String value)
     
    void
    setValue(String value, boolean fireEvents)
     
    void
    update(org.opencms.acacia.shared.CmsEntity entity)
    Updates the select options from the given entity.

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

    Methods inherited from interface org.opencms.acacia.client.widgets.I_CmsEditWidget

    shouldSetDefaultWhenDisabled

    Methods inherited from interface com.google.gwt.user.client.ui.IsWidget

    asWidget