Package org.opencms.acacia.client.widgets

Interface I_CmsEditWidget

All Superinterfaces:
com.google.gwt.event.dom.client.HasFocusHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.ui.HasValue<String>, com.google.gwt.event.logical.shared.HasValueChangeHandlers<String>, com.google.gwt.user.client.ui.IsWidget, com.google.gwt.user.client.TakesValue<String>
All Known Subinterfaces:
I_CmsFormEditWidget
All Known Implementing Classes:
A_CmsEditWidget, CmsAttributeSelectWidget, CmsCalendarWidget, CmsCategorizedSelectWidget, CmsCategoryWidget, CmsCheckboxWidget, CmsCodeMirrorWidget, CmsColorpickerWidget, CmsComboWidget, CmsDependentSelectWidget, CmsDisplayTypeSelectWidget, CmsDisplayWidget, CmsFileWidget, CmsFilterSelectWidget, CmsFormatterSelectWidget, CmsFormWidgetWrapper, CmsGalleryWidget, CmsImageGalleryWidget, CmsLocationPickerWidget, CmsMultiCheckboxWidget, CmsMultiSelectWidget, CmsPasswordWidget, CmsPrincipalWidget, CmsRadioSelectWidget, CmsSelectComboWidget, CmsSelectWidget, CmsSerialDateController, CmsSerialDateWidget, CmsStringWidget, CmsTextareaWidget, CmsTextboxWidget, CmsTinyMCEWidget, CmsVfsWidget, WidgetWrapper
public interface I_CmsEditWidget extends com.google.gwt.user.client.ui.HasValue<String>, com.google.gwt.event.dom.client.HasFocusHandlers, com.google.gwt.user.client.ui.IsWidget
The edit widget interface.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.gwt.event.shared.HandlerRegistration
    addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<String> handler)
     
    boolean
    isActive()
    Returns if the widget is active.
    void
    onAttachWidget()
    This method is called when a widget is attached to the browser's document.
    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, boolean fireEvent)
     
    default boolean
    shouldSetDefaultWhenDisabled()
    If this returns true, the default value will also be set as the widget value if the widget is inactive (i.e.

    Methods inherited from interface com.google.gwt.event.dom.client.HasFocusHandlers

    addFocusHandler

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

    fireEvent

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

    getValue, setValue

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

    asWidget

  • Method Details

    • addValueChangeHandler

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

    • isActive

      boolean isActive()
      Returns if the widget is active.

      Returns:
      true if the widget is active

    • onAttachWidget

      void onAttachWidget()
      This method is called when a widget is attached to the browser's document.

      It needs to call the Widget.onAttach() method.

    • owns

      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". For example, this is needed if the widget uses a popup.
      Parameters:
      element - the element to check
      Returns:
      true if the element counts as part of the widget

    • setActive

      void setActive(boolean active)
      Sets the widget active/inactive.

      Parameters:
      active - true to activate the widget

    • setName

      void setName(String name)
      Sets the name of input fields.

      Parameters:
      name - of the input field

    • setValue

      void setValue(String value, boolean fireEvent)
      Specified by:
      setValue in interface com.google.gwt.user.client.ui.HasValue<String>
      See Also:
      • HasValue.setValue(java.lang.Object, boolean)

    • shouldSetDefaultWhenDisabled

      default boolean shouldSetDefaultWhenDisabled()
      If this returns true, the default value will also be set as the widget value if the widget is inactive (i.e. for optional values which don't exist yet).
      Returns:
      true if the default value should be set even if the widget is inactive