public class DrawLinePath extends DrawItem
config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassName
Constructor and Description |
---|
DrawLinePath() |
DrawLinePath(com.google.gwt.core.client.JavaScriptObject jsObj) |
Modifier and Type | Method and Description |
---|---|
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
Canvas defaults)
Changes the defaults for Canvas AutoChildren named
autoChildName . |
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
DrawItem defaults)
Changes the defaults for DrawItem AutoChildren named
autoChildName . |
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
FormItem defaults)
Changes the defaults for FormItem AutoChildren named
autoChildName . |
protected com.google.gwt.core.client.JavaScriptObject |
create() |
Point |
getCenter()
Get the center point of the line path.
|
ConnectorOrientation |
getConnectorOrientation()
The ConnectorOrientation controlling the orientation and behavior of this line's tail segments.
|
ConnectorStyle |
getConnectorStyle()
The ConnectorStyle controlling the presentation and behavior of this line's tail segments.
|
Point |
getControlPoint1()
The point at which the leading tail segment joins the connecting center segment.
|
Point |
getControlPoint2()
The point at which the trailing tail segment joins the connecting center segment.
|
ArrowStyle |
getEndArrow()
Style of arrow head to draw at the end of the line or path.
|
int |
getEndLeft()
Ending left coordinate of the line.
|
double |
getEndLeftAsDouble()
Ending left coordinate of the line.
|
Point |
getEndPoint()
End point of the line
|
int |
getEndTop()
Ending top coordinate of the line.
|
double |
getEndTopAsDouble()
Ending top coordinate of the line.
|
KnobType[] |
getKnobs()
Array of control knobs to display for this item.
|
com.smartgwt.logicalstructure.core.LogicalStructureObject |
getLogicalStructure()
Getter implementing the
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility. |
static DrawLinePath |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
boolean |
getShowTitleLabelBackground()
If the
titleLabel is showing, should the titleLabelBackground be created and placed behind
the titleLabel ? |
int |
getStartLeft()
Starting left coordinate of the line.
|
double |
getStartLeftAsDouble()
Starting left coordinate of the line.
|
Point |
getStartPoint()
Start point of the line
|
int |
getStartTop()
Starting top coordinate of the line.
|
double |
getStartTopAsDouble()
Starting top coordinate of the line.
|
int |
getTailSize()
Length of the horizontal/vertical "tail segments" between the start and end points of this DrawLinePath and the
connecting center segment.
|
double |
getTailSizeAsDouble()
Length of the horizontal/vertical "tail segments" between the start and end points of this DrawLinePath and the
connecting center segment.
|
TitleRotationMode |
getTitleRotationMode()
The mode in which the
titleLabel (if shown) is
rotated with this draw item. |
void |
moveBy(int left,
int top)
Move both the start and end points of the line by a relative amount.
|
void |
moveStartPointTo(java.lang.Integer left,
java.lang.Integer top)
Moves the line path such that the
startPoint ends
up at the specified point. |
void |
setConnectorOrientation(ConnectorOrientation connectorOrientation)
The ConnectorOrientation controlling the orientation and behavior of this line's tail segments.
|
void |
setConnectorStyle(ConnectorStyle connectorStyle)
The ConnectorStyle controlling the presentation and behavior of this line's tail segments.
|
void |
setControlPoint1(Point controlPoint1)
The point at which the leading tail segment joins the connecting center segment.
|
void |
setControlPoint2(Point controlPoint2)
The point at which the trailing tail segment joins the connecting center segment.
|
static void |
setDefaultProperties(DrawLinePath drawLinePathProperties)
Class level method to set the default properties of this class.
|
void |
setEndArrow(ArrowStyle endArrow)
Style of arrow head to draw at the end of the line or path.
|
void |
setEndLeft(int endLeft)
Ending left coordinate of the line.
|
void |
setEndPoint(Point endPoint)
End point of the line
If this method is called after the component has been drawn/initialized: Update the endPoint |
void |
setEndTop(int endTop)
Ending top coordinate of the line.
|
void |
setKnobs(KnobType... knobs)
Array of control knobs to display for this item.
|
com.smartgwt.logicalstructure.core.LogicalStructureObject |
setLogicalStructure(com.smartgwt.logicalstructure.widgets.drawing.DrawLinePathLogicalStructure s)
Setter implementing the
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility. |
void |
setShowTitleLabelBackground(boolean showTitleLabelBackground)
If the
titleLabel is showing, should the titleLabelBackground be created and placed behind
the titleLabel ? |
void |
setStartLeft(int startLeft)
Starting left coordinate of the line.
|
void |
setStartPoint(Point startPoint)
Start point of the line
If this method is called after the component has been drawn/initialized: Update the startPoint |
void |
setStartTop(int startTop)
Starting top coordinate of the line.
|
void |
setTailSize(int tailSize)
Length of the horizontal/vertical "tail segments" between the start and end points of this DrawLinePath and the
connecting center segment.
|
void |
setTitleRotationMode(TitleRotationMode titleRotationMode)
The mode in which the
titleLabel (if shown) is
rotated with this draw item. |
addClickHandler, addDragMoveHandler, addDragResizeMoveHandler, addDragResizeStartHandler, addDragResizeStopHandler, addDragStartHandler, addDragStopHandler, addDrawEndHandler, addDrawStartHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseUpHandler, addMovedHandler, addResizedHandler, addShowContextMenuHandler, bringToFront, computeAngle, computeAngleAsDouble, dragResizeMove, draw, erase, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getBoundingBox, getBoundingBoxAsDouble, getById, getByJSObject, getCanDrag, getCanHover, getCanvasAutoChild, getContextMenu, getCornerResizeKnob, getCursor, getDestroyed, getDestroying, getDragStartDistance, getDrawGroup, getDrawItemAutoChild, getDrawPane, getEditProxyConstructor, getEndKnob, getEventOpaque, getFillColor, getFillGradient, getFillGradientAsString, getFillOpacity, getFormItemAutoChild, getHoverDelay, getHoverHTML, getKeepInParentRect, getLineCap, getLineColor, getLineOpacity, getLinePattern, getLineWidth, getMoveKnob, getMoveKnobOffset, getMoveKnobPoint, getPageLeft, getPageTop, getPaletteDefaults, getPrompt, getProportionalResizeModifiers, getProportionalResizing, getRef, getResizeBoundingBox, getResizeBoundingBoxAsDouble, getResizeKnobPoints, getResizeOutline, getResizeViaLocalTransformOnly, getRotateKnob, getRotation, getRotationAsDouble, getScale, getShadow, getShowHover, getShowResizeOutline, getSideResizeKnob, getStartArrow, getStartKnob, getSvgString, getTitle, getTitleAutoFit, getTitleAutoFitMargin, getTitleAutoFitRotationMode, getTitleLabel, getTitleLabelBackground, getTitleLabelPadding, getTranslate, getUnderlyingGWTCanvas, getUseSimpleTransform, getXShearFactor, getYShearFactor, getZIndex, hide, hideAllKnobs, hideKnobs, hideKnobs, hover, isInBounds, isPointInPath, moveTo, resizeBy, resizeTo, rotateBy, rotateTo, scaleBy, scaleTo, sendToBack, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setCanDrag, setCanHover, setCenterPoint, setContextMenu, setCursor, setDefaultProperties, setDragStartDistance, setDrawGroup, setDrawPane, setEditProxyConstructor, setEventOpaque, setFillColor, setFillGradient, setFillGradient, setFillOpacity, setHoverDelay, setKeepInParentRect, setKeepInParentRect, setLineCap, setLineColor, setLineOpacity, setLinePattern, setLineWidth, setLogicalStructure, setMoveKnobOffset, setMoveKnobPoint, setPrompt, setPropertyValue, setProportionalResizeModifiers, setProportionalResizing, setResizeKnobPoints, setResizeViaLocalTransformOnly, setRotation, setRotation, setScale, setShadow, setShapeData, setShowHover, setShowResizeOutline, setStartArrow, setTitle, setTitleAutoFit, setTitleAutoFitMargin, setTitleAutoFitRotationMode, setTitleLabelPadding, setTranslate, setUseSimpleTransform, setXShearFactor, setYShearFactor, setZIndex, show, showAllKnobs, showKnobs, showKnobs, supportsEndArrow, supportsStartArrow
addDrawHandler, applyFactoryProperties, completeCreation, destroy, doAddHandler, doInit, doOnRender, equals, error, errorIfNotCreated, getAttribute, getAttributeAsDateArray, getAttributeAsFloatArray, getAttributeAsIntArray, getAttributeAsRecord, getAttributeAsStringArray, getClassName, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getScClassName, hasAutoAssignedID, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, isDrawn, isFactoryCreated, onBind, onDestroy, onDraw, onInit, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDefaultProperties, setDragTracker, setFactoryCreated, setHtmlElement, setID, setJavaScriptObject, setLogicalStructure, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toString
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents
addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, setVisible, setWidth, sinkBitlessEvent
public DrawLinePath()
public DrawLinePath(com.google.gwt.core.client.JavaScriptObject jsObj)
public static DrawLinePath getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public static void changeAutoChildDefaults(java.lang.String autoChildName, Canvas defaults)
autoChildName
.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
.AutoChildUsage
public static void changeAutoChildDefaults(java.lang.String autoChildName, FormItem defaults)
autoChildName
.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
.AutoChildUsage
public static void changeAutoChildDefaults(java.lang.String autoChildName, DrawItem defaults)
autoChildName
.autoChildName
- name of an AutoChild to customize the defaults for.defaults
- DrawItem 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
.AutoChildUsage
protected com.google.gwt.core.client.JavaScriptObject create()
public void setConnectorOrientation(ConnectorOrientation connectorOrientation) throws java.lang.IllegalStateException
connectorOrientation
- New connectorOrientation value. Default value is "auto"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic ConnectorOrientation getConnectorOrientation()
public void setConnectorStyle(ConnectorStyle connectorStyle) throws java.lang.IllegalStateException
connectorStyle
- New connectorStyle value. Default value is "diagonal"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic ConnectorStyle getConnectorStyle()
public void setControlPoint1(Point controlPoint1)
controlPoint1
- left coordinate for start point, in pixels. Default value is nullpublic Point getControlPoint1()
public void setControlPoint2(Point controlPoint2)
controlPoint2
- left coordinate for start point, in pixels. Default value is nullpublic Point getControlPoint2()
public void setEndArrow(ArrowStyle endArrow)
setEndArrow
in class DrawItem
endArrow
- New endArrow value. Default value is "open", IRWpublic ArrowStyle getEndArrow()
getEndArrow
in class DrawItem
public void setEndLeft(int endLeft) throws java.lang.IllegalStateException
endPoint
if both are set.endLeft
- New endLeft value. Default value is 0 , IRWjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getEndLeft()
endPoint
if both are set.public double getEndLeftAsDouble()
endPoint
if both are set.public void setEndPoint(Point endPoint)
endPoint
- left coordinate for end point, in pixels. Default value is [100,100]public Point getEndPoint()
public void setEndTop(int endTop) throws java.lang.IllegalStateException
endPoint
if both are set.endTop
- New endTop value. Default value is 0 , IRWjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getEndTop()
endPoint
if both are set.public double getEndTopAsDouble()
endPoint
if both are set.public void setKnobs(KnobType... knobs) throws java.lang.IllegalStateException
KnobType
specified in this will
turn on UI element(s) allowing the user to manipulate this DrawLinePath. To update the set of knobs at runtime use
DrawItem.showKnobs()
and DrawItem.hideKnobs()
. DrawLinePath supports the KnobType.STARTPOINT
, KnobType.ENDPOINT
, KnobType.CONTROLPOINT1
, and KnobType.CONTROLPOINT2
knob
types.
setKnobs
in class DrawItem
knobs
- New knobs value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdDrawItem.setKnobs(com.smartgwt.client.types.KnobType...)
public KnobType[] getKnobs()
KnobType
specified in this will
turn on UI element(s) allowing the user to manipulate this DrawLinePath. To update the set of knobs at runtime use
DrawItem.showKnobs()
and DrawItem.hideKnobs()
. DrawLinePath supports the KnobType.STARTPOINT
, KnobType.ENDPOINT
, KnobType.CONTROLPOINT1
, and KnobType.CONTROLPOINT2
knob
types.
getKnobs
in class DrawItem
DrawItem.getKnobs()
public void setShowTitleLabelBackground(boolean showTitleLabelBackground) throws java.lang.IllegalStateException
titleLabel
is showing, should the titleLabelBackground
be created and placed behind
the titleLabel
? This defaults to true for DrawSector
s and
shapes that are not commonly filled (e.g. DrawLine
s).
Note : This is an advanced setting
setShowTitleLabelBackground
in class DrawItem
showTitleLabelBackground
- New showTitleLabelBackground value. Default value is truejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic boolean getShowTitleLabelBackground()
titleLabel
is showing, should the titleLabelBackground
be created and placed behind
the titleLabel
? This defaults to true for DrawSector
s and
shapes that are not commonly filled (e.g. DrawLine
s).
getShowTitleLabelBackground
in class DrawItem
public void setStartLeft(int startLeft) throws java.lang.IllegalStateException
startPoint
if both are set.startLeft
- New startLeft value. Default value is 0 , IRWjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getStartLeft()
startPoint
if both are set.public double getStartLeftAsDouble()
startPoint
if both are set.public void setStartPoint(Point startPoint)
startPoint
- left coordinate for start point, in pixels. Default value is [0,0]public Point getStartPoint()
public void setStartTop(int startTop) throws java.lang.IllegalStateException
startPoint
if both are set.startTop
- New startTop value. Default value is 0 , IRWjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getStartTop()
startPoint
if both are set.public double getStartTopAsDouble()
startPoint
if both are set.public void setTailSize(int tailSize) throws java.lang.IllegalStateException
tailSize
- New tailSize value. Default value is 30java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getTailSize()
public double getTailSizeAsDouble()
public void setTitleRotationMode(TitleRotationMode titleRotationMode) throws java.lang.IllegalStateException
titleLabel
(if shown) is
rotated with this draw item.
Note : This is an advanced setting
setTitleRotationMode
in class DrawItem
titleRotationMode
- New titleRotationMode value. Default value is "withLineAlwaysUp"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdDrawItem.setTitle(java.lang.String)
public TitleRotationMode getTitleRotationMode()
titleLabel
(if shown) is
rotated with this draw item.getTitleRotationMode
in class DrawItem
DrawItem.getTitle()
public Point getCenter()
public void moveBy(int left, int top)
public void moveStartPointTo(java.lang.Integer left, java.lang.Integer top)
startPoint
ends
up at the specified point.left
- new left coordinate in pixelstop
- new top coordinate in pixelspublic static void setDefaultProperties(DrawLinePath drawLinePathProperties)
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.
drawLinePathProperties
- properties that should be used as new defaults when instances of this class are createdSGWTProperties
public com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.drawing.DrawLinePathLogicalStructure s)
LogicalStructure
interface,
which supports Eclipse's logical structure debugging facility.public com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()
LogicalStructure
interface,
which supports Eclipse's logical structure debugging facility.getLogicalStructure
in interface LogicalStructure
getLogicalStructure
in class DrawItem