Package com.smartgwt.client.widgets.rte

Class ListPropertiesPane

java.lang.Object
com.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.Widget
com.smartgwt.client.widgets.BaseWidget
com.smartgwt.client.widgets.Canvas
com.smartgwt.client.widgets.layout.Layout
com.smartgwt.client.widgets.rte.ListPropertiesPane
All Implemented Interfaces:
HasAttachHandlers, HasHandlers, EventListener, HasVisibility, IsWidget, LogicalStructure, HasClearHandlers, HasClickHandlers, HasDoubleClickHandlers, HasDragMoveHandlers, HasDragRepositionMoveHandlers, HasDragRepositionStartHandlers, HasDragRepositionStopHandlers, HasDragResizeMoveHandlers, HasDragResizeStartHandlers, HasDragResizeStopHandlers, HasDragStartHandlers, HasDragStopHandlers, HasDropHandlers, HasDropMoveHandlers, HasDropOutHandlers, HasDropOverHandlers, HasFocusChangedHandlers, HasHoverHandlers, HasHoverHiddenHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasMouseDownHandlers, HasMouseMoveHandlers, HasMouseOutHandlers, HasMouseOverHandlers, HasMouseStillDownHandlers, HasMouseUpHandlers, HasMouseWheelHandlers, HasMovedHandlers, HasParentMovedHandlers, HasResizedHandlers, HasRightMouseDownHandlers, HasRuleContextChangedHandlers, HasScrolledHandlers, HasShowContextMenuHandlers, HasVisibilityChangedHandlers, HasMembersChangedHandlers, HasListPropertiesChangedHandlers
public class ListPropertiesPane extends Layout implements HasListPropertiesChangedHandlers
Pane containing controls for editing the style of HTML lists in a RichTextEditor.

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

  • Constructor Details

    • ListPropertiesPane

      public ListPropertiesPane()

    • ListPropertiesPane

      public ListPropertiesPane(JavaScriptObject jsObj)

  • Method Details

    • getOrCreateRef

      public static ListPropertiesPane 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 Layout

    • getSampleTile

      public Canvas getSampleTile()
      Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists. See Using AutoChildren for details.

      Tile used to demonstrate each bullet style.

      Returns:
      null

    • getSampleTileLayout

      public TileLayout getSampleTileLayout() throws IllegalStateException
      Shows available bullet options as a series of tiles.

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

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

    • getStartNumberField

      public SpinnerItem getStartNumberField() throws IllegalStateException
      SpinnerItem used to modify the starting value of the list.

      startNumberFieldTitle is a passthrough for the field's title.

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

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

    • setStartNumberFieldTitle

      public ListPropertiesPane setStartNumberFieldTitle(String startNumberFieldTitle) throws IllegalStateException
      The title of the startNumberField.
      Parameters:
      startNumberFieldTitle - New startNumberFieldTitle value. Default value is "Start at"
      Returns:
      ListPropertiesPane instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created

    • getStartNumberFieldTitle

      public String getStartNumberFieldTitle()
      The title of the startNumberField.
      Returns:
      Current startNumberFieldTitle value. Default value is "Start at"

    • getStartNumberForm

      public DynamicForm getStartNumberForm() throws IllegalStateException
      Form used to show the startNumberField for configuring the starting value of a list.

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

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

    • addListPropertiesChangedHandler

      public HandlerRegistration addListPropertiesChangedHandler(ListPropertiesChangedHandler handler)
      Add a listPropertiesChanged handler.

      Notification method fired when the pane's ListPropertiesPane.listProperties changes.

      Specified by:
      addListPropertiesChangedHandler in interface HasListPropertiesChangedHandlers
      Parameters:
      handler - the listPropertiesChanged handler
      Returns:
      HandlerRegistration used to remove this handler

    • setDefaultProperties

      public static void setDefaultProperties(ListPropertiesPane listPropertiesPaneProperties)
      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:
      listPropertiesPaneProperties - properties that should be used as new defaults when instances of this class are created
      See Also:

    • setLogicalStructure

      public LogicalStructureObject setLogicalStructure(ListPropertiesPaneLogicalStructure s)
      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 Layout