Class ListPropertiesDialog

All Implemented Interfaces:
HasAttachHandlers, HasHandlers, EventListener, HasVisibility, IsWidget, LogicalStructure, HasClearHandlers, HasClickHandlers, HasCloseClickHandlers, HasDoubleClickHandlers, HasDragMoveHandlers, HasDragRepositionMoveHandlers, HasDragRepositionStartHandlers, HasDragRepositionStopHandlers, HasDragResizeMoveHandlers, HasDragResizeStartHandlers, HasDragResizeStopHandlers, HasDragStartHandlers, HasDragStopHandlers, HasDropHandlers, HasDropMoveHandlers, HasDropOutHandlers, HasDropOverHandlers, HasFocusChangedHandlers, HasHoverHandlers, HasHoverHiddenHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasMaximizeClickHandlers, HasMinimizeClickHandlers, HasMouseDownHandlers, HasMouseMoveHandlers, HasMouseOutHandlers, HasMouseOverHandlers, HasMouseStillDownHandlers, HasMouseUpHandlers, HasMouseWheelHandlers, HasMovedHandlers, HasParentMovedHandlers, HasResizedHandlers, HasRestoreClickHandlers, HasRightMouseDownHandlers, HasRuleContextChangedHandlers, HasScrolledHandlers, HasShowContextMenuHandlers, HasVisibilityChangedHandlers, HasMembersChangedHandlers, HasApplyClickHandlers, HasCancelClickHandlers

public class ListPropertiesDialog extends Window implements HasApplyClickHandlers, HasCancelClickHandlers
Dialog shown for editing properties of HTML lists in a RichTextEditor. Contains a ListPropertiesPane.

Cannot be directly used; shown in documentation only for skinning purposes.

  • Constructor Details

    • ListPropertiesDialog

      public ListPropertiesDialog()
    • ListPropertiesDialog

      public ListPropertiesDialog(JavaScriptObject jsObj)
  • Method Details

    • getOrCreateRef

      public static ListPropertiesDialog getOrCreateRef(JavaScriptObject jsObj)
    • changeAutoChildDefaults

      public static void changeAutoChildDefaults(String autoChildName, Canvas defaults)
      Changes the defaults for Canvas AutoChildren named autoChildName.
      Parameters:
      autoChildName - name of an AutoChild to customize the defaults for.
      defaults - Canvas defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, see SGWTProperties.
      See Also:
    • changeAutoChildDefaults

      public static void changeAutoChildDefaults(String autoChildName, FormItem defaults)
      Changes the defaults for FormItem AutoChildren named autoChildName.
      Parameters:
      autoChildName - name of an AutoChild to customize the defaults for.
      defaults - FormItem defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, see SGWTProperties.
      See Also:
    • create

      protected JavaScriptObject create()
      Overrides:
      create in class Window
    • getApplyButton

      public IButton getApplyButton() throws IllegalStateException
      The Apply button. When clicked, the applyClick event is fired.

      applyButtonTitle is a passthrough for the button's title.

      This component is an AutoChild named "applyButton". For an overview of how to use and configure AutoChildren, see Using AutoChildren.

      Returns:
      Current applyButton value. Default value is null
      Throws:
      IllegalStateException - if this widget has not yet been rendered.
    • setApplyButtonTitle

      public ListPropertiesDialog setApplyButtonTitle(String applyButtonTitle) throws IllegalStateException
      The title of the Apply button.
      Parameters:
      applyButtonTitle - New applyButtonTitle value. Default value is "Apply"
      Returns:
      ListPropertiesDialog instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
    • getApplyButtonTitle

      public String getApplyButtonTitle()
      The title of the Apply button.
      Returns:
      Current applyButtonTitle value. Default value is "Apply"
    • getCancelButton

      public IButton getCancelButton() throws IllegalStateException
      The Cancel button. When clicked, the cancelClick event is fired.

      cancelButtonTitle is a passthrough for the button's title.

      This component is an AutoChild named "cancelButton". For an overview of how to use and configure AutoChildren, see Using AutoChildren.

      Returns:
      Current cancelButton value. Default value is null
      Throws:
      IllegalStateException - if this widget has not yet been rendered.
    • setCancelButtonTitle

      public ListPropertiesDialog setCancelButtonTitle(String cancelButtonTitle) throws IllegalStateException
      The title of the Cancel button.
      Parameters:
      cancelButtonTitle - New cancelButtonTitle value. Default value is "Cancel"
      Returns:
      ListPropertiesDialog instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
    • getCancelButtonTitle

      public String getCancelButtonTitle()
      The title of the Cancel button.
      Returns:
      Current cancelButtonTitle value. Default value is "Cancel"
    • getListPropertiesPane

      public ListPropertiesPane getListPropertiesPane() throws IllegalStateException
      The ListPropertiesPane contained by this ListPropertiesDialog.

      This component is an AutoChild named "listPropertiesPane". For an overview of how to use and configure AutoChildren, see Using AutoChildren.

      Returns:
      Current listPropertiesPane value. Default value is null
      Throws:
      IllegalStateException - if this widget has not yet been rendered.
    • setTitle

      public void setTitle(String title) throws IllegalStateException
      The title of this ListPropertiesDialog.
      Overrides:
      setTitle in class Window
      Parameters:
      title - New title value. Default value is "List Properties"
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
      See Also:
    • getTitle

      public String getTitle()
      The title of this ListPropertiesDialog.
      Overrides:
      getTitle in class Window
      Returns:
      Current title value. Default value is "List Properties"
      See Also:
    • addApplyClickHandler

      public HandlerRegistration addApplyClickHandler(ApplyClickHandler handler)
      Add a applyClick handler.

      Notification method fired when the Apply button is clicked.

      Specified by:
      addApplyClickHandler in interface HasApplyClickHandlers
      Parameters:
      handler - the applyClick handler
      Returns:
      HandlerRegistration used to remove this handler
    • addCancelClickHandler

      public HandlerRegistration addCancelClickHandler(CancelClickHandler handler)
      Add a cancelClick handler.

      Notification method fired when the Cancel button is clicked.

      Specified by:
      addCancelClickHandler in interface HasCancelClickHandlers
      Parameters:
      handler - the cancelClick handler
      Returns:
      HandlerRegistration used to remove this handler
    • setDefaultProperties

      public static void setDefaultProperties(ListPropertiesDialog listPropertiesDialogProperties)
      Class level method to set the default properties of this class. If set, then all existing and subsequently created instances of this class will automatically have default properties corresponding to the properties set on the SmartGWT class instance passed to this function before its underlying SmartClient JS object was created. This is a powerful feature that eliminates the need for users to create a separate hierarchy of subclasses that only alter the default properties of this class. Can also be used for skinning / styling purposes.

      Note: This method is intended for setting default attributes only and will affect all instances of the underlying class (including those automatically generated in JavaScript). This method should not be used to apply standard EventHandlers or override methods for a class - use a custom subclass instead. Calling this method after instances have been created can result in undefined behavior, since it bypasses any setters and a class instance may have already examined a particular property and not be expecting any changes through this route.

      Parameters:
      listPropertiesDialogProperties - properties that should be used as new defaults when instances of this class are created
      See Also:
    • setLogicalStructure

      Setter implementing the LogicalStructure interface, which supports Eclipse's logical structure debugging facility.
    • getLogicalStructure

      public LogicalStructureObject getLogicalStructure()
      Getter implementing the LogicalStructure interface, which supports Eclipse's logical structure debugging facility.
      Specified by:
      getLogicalStructure in interface LogicalStructure
      Overrides:
      getLogicalStructure in class Window