Package com.smartgwt.client.widgets.drawing

Class DrawPolygon

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.drawing.DrawItem
com.smartgwt.client.widgets.drawing.DrawPath
com.smartgwt.client.widgets.drawing.DrawPolygon
All Implemented Interfaces:
HasAttachHandlers, HasHandlers, EventListener, HasVisibility, IsWidget, LogicalStructure, HasClickHandlers, HasDragMoveHandlers, HasDragResizeMoveHandlers, HasDragResizeStartHandlers, HasDragResizeStopHandlers, HasDragStartHandlers, HasDragStopHandlers, HasDrawEndHandlers, HasDrawStartHandlers, HasMouseDownHandlers, HasMouseMoveHandlers, HasMouseOutHandlers, HasMouseOverHandlers, HasMouseUpHandlers, HasMovedHandlers, HasResizedHandlers, HasShowContextMenuHandlers
Direct Known Subclasses:
DrawTriangle
public class DrawPolygon extends DrawPath
DrawItem subclass to render polygons

  • Constructor Details

    • DrawPolygon

      public DrawPolygon()

    • DrawPolygon

      public DrawPolygon(JavaScriptObject jsObj)

  • Method Details

    • getOrCreateRef

      public static DrawPolygon 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 DrawPath

    • setKnobs

      public DrawPolygon setKnobs(KnobType... knobs) throws IllegalStateException
      DrawPolygon only supports the KnobType.MOVE knob type.
      Overrides:
      setKnobs in class DrawPath
      Parameters:
      knobs - New knobs value. Default value is null
      Returns:
      DrawPolygon instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
      See Also:

    • getKnobs

      public KnobType[] getKnobs()
      DrawPolygon only supports the KnobType.MOVE knob type.
      Overrides:
      getKnobs in class DrawPath
      Returns:
      Current knobs value. Default value is null
      See Also:

    • setLineCap

      public DrawPolygon setLineCap(LineCap lineCap)
      Style of drawing the corners of the polygon.
      Overrides:
      setLineCap in class DrawItem
      Parameters:
      lineCap - New lineCap value. Default value is "butt"
      Returns:
      DrawPolygon instance, for chaining setter calls

    • getLineCap

      public LineCap getLineCap()
      Style of drawing the corners of the polygon.
      Overrides:
      getLineCap in class DrawItem
      Returns:
      Current lineCap value. Default value is "butt"

    • setPoints

      public DrawPolygon setPoints(Point... points)
      Array of points of the polygon, specified in the local coordinate system.
      Overrides:
      setPoints in class DrawPath
      Parameters:
      points - New points value. Default value is [[0,0], [50,50], [100,0]]
      Returns:
      DrawPolygon instance, for chaining setter calls

    • getPoints

      public Point[] getPoints()
      Array of points of the polygon, specified in the local coordinate system.
      Overrides:
      getPoints in class DrawPath
      Returns:
      Current points value. Default value is [[0,0], [50,50], [100,0]]

    • setShowTitleLabelBackground

      public DrawPolygon setShowTitleLabelBackground(boolean showTitleLabelBackground) throws IllegalStateException
      If the titleLabel is showing, should the titleLabelBackground be created and placed behind the titleLabel?

      This defaults to true for DrawSectors and shapes that are not commonly filled (e.g. DrawLines).

      Note : This is an advanced setting

      Overrides:
      setShowTitleLabelBackground in class DrawPath
      Parameters:
      showTitleLabelBackground - New showTitleLabelBackground value. Default value is false
      Returns:
      DrawPolygon instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created

    • getShowTitleLabelBackground

      public boolean getShowTitleLabelBackground()
      If the titleLabel is showing, should the titleLabelBackground be created and placed behind the titleLabel?

      This defaults to true for DrawSectors and shapes that are not commonly filled (e.g. DrawLines).

      Overrides:
      getShowTitleLabelBackground in class DrawPath
      Returns:
      Current showTitleLabelBackground value. Default value is false

    • setTitleRotationMode

      public DrawPolygon setTitleRotationMode(TitleRotationMode titleRotationMode) throws IllegalStateException
      The mode in which the titleLabel (if shown) is rotated with this draw item.

      Note : This is an advanced setting

      Overrides:
      setTitleRotationMode in class DrawItem
      Parameters:
      titleRotationMode - New titleRotationMode value. Default value is "withItemAlwaysUp"
      Returns:
      DrawPolygon instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
      See Also:

    • getTitleRotationMode

      public TitleRotationMode getTitleRotationMode()
      The mode in which the titleLabel (if shown) is rotated with this draw item.
      Overrides:
      getTitleRotationMode in class DrawItem
      Returns:
      Current titleRotationMode value. Default value is "withItemAlwaysUp"
      See Also:

    • setDefaultProperties

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

    • setLogicalStructure

      public LogicalStructureObject setLogicalStructure(DrawPolygonLogicalStructure 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 DrawPath