com.smartgwt.client.widgets

Class PointerSettings

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.PointerSettings

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsWidget, LogicalStructure

public class PointerSettings
extends BaseWidget

A set of properties that can be used to configure a canvas pointer.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class com.smartgwt.client.widgets.BaseWidget

config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassName

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
PointerSettings()
PointerSettings(com.google.gwt.core.client.JavaScriptObject jsObj)

Method Summary

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 snapTo is TL, TR, BL or BR.
com.smartgwt.logicalstructure.core.LogicalStructureObject	getLogicalStructure() Getter implementing the LogicalStructure interface, 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 snapTo is 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 snapTo is 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 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.
java.lang.Integer	getTargetOffsetLeft() If targetSnapTo is 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 targetSnapTo is 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 snapTo is 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 LogicalStructure interface, 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 snapTo is 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 snapTo is 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 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.
PointerSettings	setTargetOffsetLeft(java.lang.Integer targetOffsetLeft) If targetSnapTo is 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 targetSnapTo is 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.

Methods inherited from class com.smartgwt.client.widgets.BaseWidget

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, toString

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Constructor Detail

PointerSettings

public PointerSettings()

PointerSettings

public PointerSettings(com.google.gwt.core.client.JavaScriptObject jsObj)

Method Detail

getOrCreateRef

public static PointerSettings getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)

changeAutoChildDefaults

public static void changeAutoChildDefaults(java.lang.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:

AutoChildUsage

changeAutoChildDefaults

public static void changeAutoChildDefaults(java.lang.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:

AutoChildUsage

create

protected com.google.gwt.core.client.JavaScriptObject create()

Overrides:

create in class BaseWidget

setColor

public PointerSettings setColor(java.lang.String color)
                         throws java.lang.IllegalStateException

By default, the pointer will assume the same color as its parent canvas. Set this attribute to enforce a custom color for the pointer.

Parameters:

color - New color value. Default value is null

Returns:

PointerSettings instance, for chaining setter calls

Throws:

java.lang.IllegalStateException - this property cannot be changed after the component has been created

See Also:

CSSColor

getColor

public java.lang.String getColor()

By default, the pointer will assume the same color as its parent canvas. Set this attribute to enforce a custom color for the pointer.

Returns:

Current color value. Default value is null

See Also:

CSSColor

setCornerOffset

public PointerSettings setCornerOffset(java.lang.Integer cornerOffset)
                                throws java.lang.IllegalStateException

Specifies the amount of offset in pixels from the corner to position the pointer when snapTo is TL, TR, BL or BR. This is useful for a canvas with a rounded corner.

Parameters:

cornerOffset - New cornerOffset value. Default value is null

Returns:

PointerSettings instance, for chaining setter calls

Throws:

java.lang.IllegalStateException - this property cannot be changed after the component has been created

getCornerOffset

public java.lang.Integer getCornerOffset()

Specifies the amount of offset in pixels from the corner to position the pointer when snapTo is TL, TR, BL or BR. This is useful for a canvas with a rounded corner.

Returns:

Current cornerOffset value. Default value is null

setShowShadow

public PointerSettings setShowShadow(java.lang.Boolean showShadow)
                              throws java.lang.IllegalStateException

By default, the pointer will show the same shadow as its parent canvas. Set showShadow to false to render the pointer without a shadow.

Parameters:

showShadow - New showShadow value. Default value is null

Returns:

PointerSettings instance, for chaining setter calls

Throws:

java.lang.IllegalStateException - this property cannot be changed after the component has been created

getShowShadow

public java.lang.Boolean getShowShadow()

By default, the pointer will show the same shadow as its parent canvas. Set showShadow to false to render the pointer without a shadow.

Returns:

Current showShadow value. Default value is null

setSnapOffsetLeft

public PointerSettings setSnapOffsetLeft(java.lang.Integer snapOffsetLeft)
                                  throws java.lang.IllegalStateException

If 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.

Parameters:

snapOffsetLeft - New snapOffsetLeft value. Default value is null

Returns:

PointerSettings instance, for chaining setter calls

Throws:

java.lang.IllegalStateException - this property cannot be changed after the component has been created

See Also:

setSnapTo(java.lang.String), SnapPositioning overview and related methods

getSnapOffsetLeft

public java.lang.Integer getSnapOffsetLeft()

If 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.

Returns:

Current snapOffsetLeft value. Default value is null

See Also:

getSnapTo(), SnapPositioning overview and related methods

setSnapOffsetTop

public PointerSettings setSnapOffsetTop(java.lang.Integer snapOffsetTop)
                                 throws java.lang.IllegalStateException

If 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.

Parameters:

snapOffsetTop - New snapOffsetTop value. Default value is null

Returns:

PointerSettings instance, for chaining setter calls

Throws:

java.lang.IllegalStateException - this property cannot be changed after the component has been created

See Also:

setSnapTo(java.lang.String), SnapPositioning overview and related methods

getSnapOffsetTop

public java.lang.Integer getSnapOffsetTop()

If 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.

Returns:

Current snapOffsetTop value. Default value is null

See Also:

getSnapTo(), SnapPositioning overview and related methods

setSnapTo

public PointerSettings setSnapTo(java.lang.String snapTo)
                          throws java.lang.IllegalStateException

Specifies the position of the pointer when 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.

Parameters:

snapTo - New snapTo value. Default value is null

Returns:

PointerSettings instance, for chaining setter calls

Throws:

java.lang.IllegalStateException - this property cannot be changed after the component has been created

See Also:

SnapPositioning overview and related methods

getSnapTo

public java.lang.String getSnapTo()

Specifies the position of the pointer when 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.

Returns:

Current snapTo value. Default value is null

See Also:

SnapPositioning overview and related methods

setTargetOffsetInto

public PointerSettings setTargetOffsetInto(java.lang.Integer targetOffsetInto)
                                    throws java.lang.IllegalStateException

If 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.

Parameters:

targetOffsetInto - New targetOffsetInto value. Default value is null

Returns:

PointerSettings instance, for chaining setter calls

Throws:

java.lang.IllegalStateException - this property cannot be changed after the component has been created

See Also:

setTargetSnapTo(java.lang.String)

getTargetOffsetInto

public java.lang.Integer getTargetOffsetInto()

If 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.

Returns:

Current targetOffsetInto value. Default value is null

See Also:

getTargetSnapTo()

setTargetOffsetLeft

public PointerSettings setTargetOffsetLeft(java.lang.Integer targetOffsetLeft)
                                    throws java.lang.IllegalStateException

If 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.

Parameters:

targetOffsetLeft - New targetOffsetLeft value. Default value is null

Returns:

PointerSettings instance, for chaining setter calls

Throws:

java.lang.IllegalStateException - this property cannot be changed after the component has been created

See Also:

setTargetSnapTo(java.lang.String), setTargetOffsetInto(java.lang.Integer)

getTargetOffsetLeft

public java.lang.Integer getTargetOffsetLeft()

If 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.

Returns:

Current targetOffsetLeft value. Default value is null

See Also:

getTargetSnapTo(), getTargetOffsetInto()

setTargetOffsetTop

public PointerSettings setTargetOffsetTop(java.lang.Integer targetOffsetTop)
                                   throws java.lang.IllegalStateException

If 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.

Parameters:

targetOffsetTop - New targetOffsetTop value. Default value is null

Returns:

PointerSettings instance, for chaining setter calls

Throws:

java.lang.IllegalStateException - this property cannot be changed after the component has been created

See Also:

setTargetSnapTo(java.lang.String), setTargetOffsetInto(java.lang.Integer)

getTargetOffsetTop

public java.lang.Integer getTargetOffsetTop()

If 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.

Returns:

Current targetOffsetTop value. Default value is null

See Also:

getTargetSnapTo(), getTargetOffsetInto()

setTargetSnapTo

public PointerSettings setTargetSnapTo(java.lang.String targetSnapTo)
                                throws java.lang.IllegalStateException

Specifies the position of the pointer into the target when 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.

Parameters:

targetSnapTo - New targetSnapTo value. Default value is null

Returns:

PointerSettings instance, for chaining setter calls

Throws:

java.lang.IllegalStateException - this property cannot be changed after the component has been created

See Also:

SnapGridDragging overview and related methods

getTargetSnapTo

public java.lang.String getTargetSnapTo()

Specifies the position of the pointer into the target when 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.

Returns:

Current targetSnapTo value. Default value is null

See Also:

SnapGridDragging overview and related methods

setDefaultProperties

public static void setDefaultProperties(PointerSettings pointerSettingsProperties)

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:

pointerSettingsProperties - properties that should be used as new defaults when instances of this class are created

See Also:

SGWTProperties

setLogicalStructure

public com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.PointerSettingsLogicalStructure s)

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

getLogicalStructure

public com.smartgwt.logicalstructure.core.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 BaseWidget