public class PointerSettings extends BaseWidget
canvas
 pointer.config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassName| Constructor and Description | 
|---|
| PointerSettings() | 
| PointerSettings(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,
                       FormItem defaults)Changes the defaults for FormItem AutoChildren named  autoChildName. | 
| protected com.google.gwt.core.client.JavaScriptObject | create() | 
| java.lang.String | getColor()By default, the pointer will assume the same color as its parent canvas. | 
| java.lang.Integer | getCornerOffset()Specifies the amount of offset in pixels from the corner to position the pointer when  snapTois TL, TR, BL or BR. | 
| com.smartgwt.logicalstructure.core.LogicalStructureObject | getLogicalStructure()Getter implementing the  LogicalStructureinterface,
 which supports Eclipse's logical structure debugging facility. | 
| static PointerSettings | getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) | 
| java.lang.Boolean | getShowShadow()By default, the pointer will show the same shadow as its parent canvas. | 
| java.lang.Integer | getSnapOffsetLeft()If  snapTois defined, this property can be used to specify
 an offset in px or percentage for the left coordinate of the pointer. | 
| java.lang.Integer | getSnapOffsetTop()If  snapTois defined, this property can be used to specify
 an offset in px or percentage for the top coordinate of the pointer. | 
| java.lang.String | getSnapTo()Specifies the position of the pointer when  showing. | 
| java.lang.Integer | getTargetOffsetInto()If  targetSnapTois defined, this property can be
 used to specify an offset in px or percentage for the coordinate of the pointer into theCanvas.pointerTarget. | 
| java.lang.Integer | getTargetOffsetLeft()If  targetSnapTois defined, this property can be
 used to specify an offset in px or percentage for the left coordinate of the pointer. | 
| java.lang.Integer | getTargetOffsetTop()If  targetSnapTois defined, this property can be
 used to specify an offset in px or percentage for the top coordinate of the pointer. | 
| java.lang.String | getTargetSnapTo()Specifies the position of the pointer into the target when  showing. | 
| PointerSettings | setColor(java.lang.String color)By default, the pointer will assume the same color as its parent canvas. | 
| PointerSettings | setCornerOffset(java.lang.Integer cornerOffset)Specifies the amount of offset in pixels from the corner to position the pointer when  snapTois TL, TR, BL or BR. | 
| static void | setDefaultProperties(PointerSettings pointerSettingsProperties)Class level method to set the default properties of this class. | 
| com.smartgwt.logicalstructure.core.LogicalStructureObject | setLogicalStructure(com.smartgwt.logicalstructure.widgets.PointerSettingsLogicalStructure s)Setter implementing the  LogicalStructureinterface,
 which supports Eclipse's logical structure debugging facility. | 
| PointerSettings | setShowShadow(java.lang.Boolean showShadow)By default, the pointer will show the same shadow as its parent canvas. | 
| PointerSettings | setSnapOffsetLeft(java.lang.Integer snapOffsetLeft)If  snapTois defined, this property can be used to specify
 an offset in px or percentage for the left coordinate of the pointer. | 
| PointerSettings | setSnapOffsetTop(java.lang.Integer snapOffsetTop)If  snapTois defined, this property can be used to specify
 an offset in px or percentage for the top coordinate of the pointer. | 
| PointerSettings | setSnapTo(java.lang.String snapTo)Specifies the position of the pointer when  showing. | 
| PointerSettings | setTargetOffsetInto(java.lang.Integer targetOffsetInto)If  targetSnapTois defined, this property can be
 used to specify an offset in px or percentage for the coordinate of the pointer into theCanvas.pointerTarget. | 
| PointerSettings | setTargetOffsetLeft(java.lang.Integer targetOffsetLeft)If  targetSnapTois defined, this property can be
 used to specify an offset in px or percentage for the left coordinate of the pointer. | 
| PointerSettings | setTargetOffsetTop(java.lang.Integer targetOffsetTop)If  targetSnapTois defined, this property can be
 used to specify an offset in px or percentage for the top coordinate of the pointer. | 
| PointerSettings | setTargetSnapTo(java.lang.String targetSnapTo)Specifies the position of the pointer into the target when  showing. | 
addDrawHandler, addDynamicProperty, addDynamicProperty, addDynamicProperty, addDynamicProperty, applyFactoryProperties, clearDynamicProperty, completeCreation, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getById, getByJSObject, getClassName, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, getTitle, hasAutoAssignedID, hasDynamicProperty, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, isDrawn, isFactoryCreated, onBind, onDestroy, onDraw, onInit, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, 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, setTitle, toStringaddAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEventsaddStyleDependentName, 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, sinkBitlessEventpublic PointerSettings()
public PointerSettings(com.google.gwt.core.client.JavaScriptObject jsObj)
public static PointerSettings 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.AutoChildUsagepublic 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.AutoChildUsageprotected com.google.gwt.core.client.JavaScriptObject create()
create in class BaseWidgetpublic PointerSettings setColor(java.lang.String color) throws java.lang.IllegalStateException
color - New color value. Default value is nullPointerSettings instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdCSSColorpublic java.lang.String getColor()
CSSColorpublic PointerSettings setCornerOffset(java.lang.Integer cornerOffset) throws java.lang.IllegalStateException
snapTo is TL, TR, BL or BR. This is useful for a canvas with a
 rounded corner.cornerOffset - New cornerOffset value. Default value is nullPointerSettings instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Integer getCornerOffset()
snapTo is TL, TR, BL or BR. This is useful for a canvas with a
 rounded corner.public PointerSettings setShowShadow(java.lang.Boolean showShadow) throws java.lang.IllegalStateException
showShadow to false to render
 the pointer without a shadow.showShadow - New showShadow value. Default value is nullPointerSettings instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowShadow()
showShadow to false to render
 the pointer without a shadow.public PointerSettings setSnapOffsetLeft(java.lang.Integer snapOffsetLeft) throws java.lang.IllegalStateException
snapTo is defined, this property can be used to specify
 an offset in px or percentage for the left coordinate of the pointer.  For example if snapTo is
 specified as "L" and snapOffsetLeft is set to 6, the pointer will be rendered 6px inside the
 left edge of the window. Alternatively if snapTo was set to "R", a snapOffsetLeft
 value of -6 would cause the pointer to be rendered 6px inside the right edge of the window.
snapOffsetLeft - New snapOffsetLeft value. Default value is nullPointerSettings instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdsetSnapTo(java.lang.String), 
SnapPositioning overview and related methodspublic java.lang.Integer getSnapOffsetLeft()
snapTo is defined, this property can be used to specify
 an offset in px or percentage for the left coordinate of the pointer.  For example if snapTo is
 specified as "L" and snapOffsetLeft is set to 6, the pointer will be rendered 6px inside the
 left edge of the window. Alternatively if snapTo was set to "R", a snapOffsetLeft
 value of -6 would cause the pointer to be rendered 6px inside the right edge of the window.
getSnapTo(), 
SnapPositioning overview and related methodspublic PointerSettings setSnapOffsetTop(java.lang.Integer snapOffsetTop) throws java.lang.IllegalStateException
snapTo is defined, this property can be used to specify
 an offset in px or percentage for the top coordinate of the pointer.  For example if snapTo is specified
 as "T" and snapOffsetTop is set to 6, the pointer will be rendered 6px below the top edge of
 the window. Alternatively if snapTo was set to "B", a snapOffsetTop value of -6
 would cause the pointer to be rendered 6px inside the bottom edge of the window.
snapOffsetTop - New snapOffsetTop value. Default value is nullPointerSettings instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdsetSnapTo(java.lang.String), 
SnapPositioning overview and related methodspublic java.lang.Integer getSnapOffsetTop()
snapTo is defined, this property can be used to specify
 an offset in px or percentage for the top coordinate of the pointer.  For example if snapTo is specified
 as "T" and snapOffsetTop is set to 6, the pointer will be rendered 6px below the top edge of
 the window. Alternatively if snapTo was set to "B", a snapOffsetTop value of -6
 would cause the pointer to be rendered 6px inside the bottom edge of the window.
getSnapTo(), 
SnapPositioning overview and related methodspublic PointerSettings setSnapTo(java.lang.String snapTo) throws java.lang.IllegalStateException
showing. Accepts
 similar values as Canvas.snapTo.  Possible basic values: TL, TR, LT, LB, RT, RB, BL, BR, R, L, B, T where B=Bottom, T=Top, L=Left, R=right. The first letter indicates the edge and the second optional letter indicates the placement along the edge.
 In addition to the basic values above, two
 different basic values can be combined with a separating slash (/) to position the pointer between the two locations
 giving more precise control. For example, BL/L positions the pointer along the bottom edge halfway between
 the bottom-left and the bottom-center. 
 If Canvas.showPointer is enabled and a Canvas.pointerTarget is
 specified but snapTo is null, a reasonable location is calculated based on the location of the
 pointerTarget.
snapTo - New snapTo value. Default value is nullPointerSettings instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdSnapPositioning overview and related methodspublic java.lang.String getSnapTo()
showing. Accepts
 similar values as Canvas.snapTo.  Possible basic values: TL, TR, LT, LB, RT, RB, BL, BR, R, L, B, T where B=Bottom, T=Top, L=Left, R=right. The first letter indicates the edge and the second optional letter indicates the placement along the edge.
 In addition to the basic values above, two
 different basic values can be combined with a separating slash (/) to position the pointer between the two locations
 giving more precise control. For example, BL/L positions the pointer along the bottom edge halfway between
 the bottom-left and the bottom-center. 
 If Canvas.showPointer is enabled and a Canvas.pointerTarget is
 specified but snapTo is null, a reasonable location is calculated based on the location of the
 pointerTarget.
SnapPositioning overview and related methodspublic PointerSettings setTargetOffsetInto(java.lang.Integer targetOffsetInto) throws java.lang.IllegalStateException
targetSnapTo is defined, this property can be
 used to specify an offset in px or percentage for the coordinate of the pointer into the Canvas.pointerTarget.  While targetOffsetLeft and targetOffsetTop can be used to fine tune the pointer's
 target position the user must be aware of the orientation of the pointer. Instead, this property will be applied to the
 correct offset so that the pointer points inside (or outside if negative) the target. 
 For example if
 targetSnapTo is specified as "L" and targetOffsetInto is set to 6, the pointer
 will be rendered 6px inside the left edge of the position target.
targetOffsetInto - New targetOffsetInto value. Default value is nullPointerSettings instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdsetTargetSnapTo(java.lang.String)public java.lang.Integer getTargetOffsetInto()
targetSnapTo is defined, this property can be
 used to specify an offset in px or percentage for the coordinate of the pointer into the Canvas.pointerTarget.  While targetOffsetLeft and targetOffsetTop can be used to fine tune the pointer's
 target position the user must be aware of the orientation of the pointer. Instead, this property will be applied to the
 correct offset so that the pointer points inside (or outside if negative) the target. 
 For example if
 targetSnapTo is specified as "L" and targetOffsetInto is set to 6, the pointer
 will be rendered 6px inside the left edge of the position target.
getTargetSnapTo()public PointerSettings setTargetOffsetLeft(java.lang.Integer targetOffsetLeft) throws java.lang.IllegalStateException
targetSnapTo is defined, this property can be
 used to specify an offset in px or percentage for the left coordinate of the pointer.  For example if
 targetSnapTo is specified as "L" and targetOffsetLeft is set to 6, the pointer
 will be rendered 6px inside the left edge of the pointer target canvas. Alternatively if targetSnapTo was
 set to "R", a targetOffsetLeft value of -6 would cause the pointer to be rendered 6px inside
 the right edge of the pointer target canvas. 
 Note that targetOffsetInto is likely more suitable for simple
 customizations.
targetOffsetLeft - New targetOffsetLeft value. Default value is nullPointerSettings instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdsetTargetSnapTo(java.lang.String), 
setTargetOffsetInto(java.lang.Integer)public java.lang.Integer getTargetOffsetLeft()
targetSnapTo is defined, this property can be
 used to specify an offset in px or percentage for the left coordinate of the pointer.  For example if
 targetSnapTo is specified as "L" and targetOffsetLeft is set to 6, the pointer
 will be rendered 6px inside the left edge of the pointer target canvas. Alternatively if targetSnapTo was
 set to "R", a targetOffsetLeft value of -6 would cause the pointer to be rendered 6px inside
 the right edge of the pointer target canvas. 
 Note that targetOffsetInto is likely more suitable for simple
 customizations.
getTargetSnapTo(), 
getTargetOffsetInto()public PointerSettings setTargetOffsetTop(java.lang.Integer targetOffsetTop) throws java.lang.IllegalStateException
targetSnapTo is defined, this property can be
 used to specify an offset in px or percentage for the top coordinate of the pointer.  For example if
 targetSnapTo is specified as "T" and targetOffsetTop is set to 6, the pointer
 will be rendered 6px below the top edge of the pointer target canvas. Alternatively if targetSnapTo was set
 to "B", a targetOffsetTop value of -6 would cause the pointer to be rendered 6px inside the
 bottom edge of the pointer target canvas. 
 Note that targetOffsetInto is likely more suitable for simple
 customizations.
targetOffsetTop - New targetOffsetTop value. Default value is nullPointerSettings instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdsetTargetSnapTo(java.lang.String), 
setTargetOffsetInto(java.lang.Integer)public java.lang.Integer getTargetOffsetTop()
targetSnapTo is defined, this property can be
 used to specify an offset in px or percentage for the top coordinate of the pointer.  For example if
 targetSnapTo is specified as "T" and targetOffsetTop is set to 6, the pointer
 will be rendered 6px below the top edge of the pointer target canvas. Alternatively if targetSnapTo was set
 to "B", a targetOffsetTop value of -6 would cause the pointer to be rendered 6px inside the
 bottom edge of the pointer target canvas. 
 Note that targetOffsetInto is likely more suitable for simple
 customizations.
getTargetSnapTo(), 
getTargetOffsetInto()public PointerSettings setTargetSnapTo(java.lang.String targetSnapTo) throws java.lang.IllegalStateException
showing. Accepts the same values as snapTo.  If not
 specified the center location on the appropriate edge is chosen to match up with the snapTo value.
targetSnapTo - New targetSnapTo value. Default value is nullPointerSettings instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdSnapGridDragging overview and related methodspublic java.lang.String getTargetSnapTo()
showing. Accepts the same values as snapTo.  If not
 specified the center location on the appropriate edge is chosen to match up with the snapTo value.
SnapGridDragging overview and related methodspublic static void setDefaultProperties(PointerSettings pointerSettingsProperties)
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.
pointerSettingsProperties - properties that should be used as new defaults when instances of this class are createdSGWTPropertiespublic com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.PointerSettingsLogicalStructure 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 LogicalStructuregetLogicalStructure in class BaseWidget