Class PointerSettings
- All Implemented Interfaces:
HasAttachHandlers,HasHandlers,EventListener,HasVisibility,IsWidget,LogicalStructure
canvas
pointer.-
Nested Class Summary
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled -
Field Summary
Fields inherited from class com.smartgwt.client.widgets.BaseWidget
config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassNameFields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic voidchangeAutoChildDefaults(String autoChildName, Canvas defaults) Changes the defaults for Canvas AutoChildren namedautoChildName.static voidchangeAutoChildDefaults(String autoChildName, FormItem defaults) Changes the defaults for FormItem AutoChildren namedautoChildName.protected JavaScriptObjectcreate()getColor()By default, the pointer will assume the same color as its parent canvas.Specifies the amount of offset in pixels from the corner to position the pointer whensnapTois TL, TR, BL or BR.Getter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.static PointerSettingsgetOrCreateRef(JavaScriptObject jsObj) By default, the pointer will show the same shadow as its parent canvas.IfsnapTois defined, this property can be used to specify an offset in px or percentage for the left coordinate of the pointer.IfsnapTois defined, this property can be used to specify an offset in px or percentage for the top coordinate of the pointer.Specifies the position of the pointer whenshowing.IftargetSnapTois defined, this property can be used to specify an offset in px or percentage for the coordinate of the pointer into theCanvas.pointerTarget.IftargetSnapTois defined, this property can be used to specify an offset in px or percentage for the left coordinate of the pointer.IftargetSnapTois defined, this property can be used to specify an offset in px or percentage for the top coordinate of the pointer.Specifies the position of the pointer into the target whenshowing.By default, the pointer will assume the same color as its parent canvas.setCornerOffset(Integer cornerOffset) Specifies the amount of offset in pixels from the corner to position the pointer whensnapTois TL, TR, BL or BR.static voidsetDefaultProperties(PointerSettings pointerSettingsProperties) Class level method to set the default properties of this class.Setter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.setShowShadow(Boolean showShadow) By default, the pointer will show the same shadow as its parent canvas.setSnapOffsetLeft(Integer snapOffsetLeft) IfsnapTois defined, this property can be used to specify an offset in px or percentage for the left coordinate of the pointer.setSnapOffsetTop(Integer snapOffsetTop) IfsnapTois defined, this property can be used to specify an offset in px or percentage for the top coordinate of the pointer.Specifies the position of the pointer whenshowing.setTargetOffsetInto(Integer targetOffsetInto) IftargetSnapTois defined, this property can be used to specify an offset in px or percentage for the coordinate of the pointer into theCanvas.pointerTarget.setTargetOffsetLeft(Integer targetOffsetLeft) IftargetSnapTois defined, this property can be used to specify an offset in px or percentage for the left coordinate of the pointer.setTargetOffsetTop(Integer targetOffsetTop) IftargetSnapTois defined, this property can be used to specify an offset in px or percentage for the top coordinate of the pointer.setTargetSnapTo(String targetSnapTo) Specifies the position of the pointer into the target whenshowing.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, toStringMethods 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, unsinkEventsMethods 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, sinkBitlessEventMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
-
Constructor Details
-
PointerSettings
public PointerSettings() -
PointerSettings
-
-
Method Details
-
getOrCreateRef
-
changeAutoChildDefaults
Changes the defaults for Canvas AutoChildren namedautoChildName.- 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, seeSGWTProperties.- See Also:
-
changeAutoChildDefaults
Changes the defaults for FormItem AutoChildren namedautoChildName.- 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, seeSGWTProperties.- See Also:
-
create
- Overrides:
createin classBaseWidget
-
setColor
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:
PointerSettingsinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
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:
-
setCornerOffset
Specifies the amount of offset in pixels from the corner to position the pointer whensnapTois 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:
PointerSettingsinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getCornerOffset
Specifies the amount of offset in pixels from the corner to position the pointer whensnapTois TL, TR, BL or BR. This is useful for a canvas with a rounded corner.- Returns:
- Current cornerOffset value. Default value is null
-
setShowShadow
By default, the pointer will show the same shadow as its parent canvas. SetshowShadowto false to render the pointer without a shadow.- Parameters:
showShadow- New showShadow value. Default value is null- Returns:
PointerSettingsinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getShowShadow
By default, the pointer will show the same shadow as its parent canvas. SetshowShadowto false to render the pointer without a shadow.- Returns:
- Current showShadow value. Default value is null
-
setSnapOffsetLeft
IfsnapTois defined, this property can be used to specify an offset in px or percentage for the left coordinate of the pointer.For example if
snapTois specified as"L"andsnapOffsetLeftis set to 6, the pointer will be rendered 6px inside the left edge of the window. Alternatively ifsnapTowas set to"R", asnapOffsetLeftvalue 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:
PointerSettingsinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getSnapOffsetLeft
IfsnapTois defined, this property can be used to specify an offset in px or percentage for the left coordinate of the pointer.For example if
snapTois specified as"L"andsnapOffsetLeftis set to 6, the pointer will be rendered 6px inside the left edge of the window. Alternatively ifsnapTowas set to"R", asnapOffsetLeftvalue 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:
-
setSnapOffsetTop
IfsnapTois defined, this property can be used to specify an offset in px or percentage for the top coordinate of the pointer.For example if
snapTois specified as"T"andsnapOffsetTopis set to 6, the pointer will be rendered 6px below the top edge of the window. Alternatively ifsnapTowas set to"B", asnapOffsetTopvalue 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:
PointerSettingsinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getSnapOffsetTop
IfsnapTois defined, this property can be used to specify an offset in px or percentage for the top coordinate of the pointer.For example if
snapTois specified as"T"andsnapOffsetTopis set to 6, the pointer will be rendered 6px below the top edge of the window. Alternatively ifsnapTowas set to"B", asnapOffsetTopvalue 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:
-
setSnapTo
Specifies the position of the pointer whenshowing. Accepts similar values asCanvas.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/Lpositions the pointer along the bottom edge halfway between the bottom-left and the bottom-center.If
Canvas.showPointeris enabled and aCanvas.pointerTargetis specified butsnapTois null, a reasonable location is calculated based on the location of thepointerTarget.- Parameters:
snapTo- New snapTo value. Default value is null- Returns:
PointerSettingsinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getSnapTo
Specifies the position of the pointer whenshowing. Accepts similar values asCanvas.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/Lpositions the pointer along the bottom edge halfway between the bottom-left and the bottom-center.If
Canvas.showPointeris enabled and aCanvas.pointerTargetis specified butsnapTois null, a reasonable location is calculated based on the location of thepointerTarget.- Returns:
- Current snapTo value. Default value is null
- See Also:
-
setTargetOffsetInto
IftargetSnapTois defined, this property can be used to specify an offset in px or percentage for the coordinate of the pointer into theCanvas.pointerTarget.While
targetOffsetLeftandtargetOffsetTopcan 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
targetSnapTois specified as"L"andtargetOffsetIntois 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:
PointerSettingsinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getTargetOffsetInto
IftargetSnapTois defined, this property can be used to specify an offset in px or percentage for the coordinate of the pointer into theCanvas.pointerTarget.While
targetOffsetLeftandtargetOffsetTopcan 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
targetSnapTois specified as"L"andtargetOffsetIntois 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:
-
setTargetOffsetLeft
IftargetSnapTois defined, this property can be used to specify an offset in px or percentage for the left coordinate of the pointer.For example if
targetSnapTois specified as"L"andtargetOffsetLeftis set to 6, the pointer will be rendered 6px inside the left edge of the pointer target canvas. Alternatively iftargetSnapTowas set to"R", atargetOffsetLeftvalue of -6 would cause the pointer to be rendered 6px inside the right edge of the pointer target canvas.Note that
targetOffsetIntois likely more suitable for simple customizations.- Parameters:
targetOffsetLeft- New targetOffsetLeft value. Default value is null- Returns:
PointerSettingsinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getTargetOffsetLeft
IftargetSnapTois defined, this property can be used to specify an offset in px or percentage for the left coordinate of the pointer.For example if
targetSnapTois specified as"L"andtargetOffsetLeftis set to 6, the pointer will be rendered 6px inside the left edge of the pointer target canvas. Alternatively iftargetSnapTowas set to"R", atargetOffsetLeftvalue of -6 would cause the pointer to be rendered 6px inside the right edge of the pointer target canvas.Note that
targetOffsetIntois likely more suitable for simple customizations.- Returns:
- Current targetOffsetLeft value. Default value is null
- See Also:
-
setTargetOffsetTop
IftargetSnapTois defined, this property can be used to specify an offset in px or percentage for the top coordinate of the pointer.For example if
targetSnapTois specified as"T"andtargetOffsetTopis set to 6, the pointer will be rendered 6px below the top edge of the pointer target canvas. Alternatively iftargetSnapTowas set to"B", atargetOffsetTopvalue of -6 would cause the pointer to be rendered 6px inside the bottom edge of the pointer target canvas.Note that
targetOffsetIntois likely more suitable for simple customizations.- Parameters:
targetOffsetTop- New targetOffsetTop value. Default value is null- Returns:
PointerSettingsinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getTargetOffsetTop
IftargetSnapTois defined, this property can be used to specify an offset in px or percentage for the top coordinate of the pointer.For example if
targetSnapTois specified as"T"andtargetOffsetTopis set to 6, the pointer will be rendered 6px below the top edge of the pointer target canvas. Alternatively iftargetSnapTowas set to"B", atargetOffsetTopvalue of -6 would cause the pointer to be rendered 6px inside the bottom edge of the pointer target canvas.Note that
targetOffsetIntois likely more suitable for simple customizations.- Returns:
- Current targetOffsetTop value. Default value is null
- See Also:
-
setTargetSnapTo
Specifies the position of the pointer into the target whenshowing. Accepts the same values assnapTo.If not specified the center location on the appropriate edge is chosen to match up with the
snapTovalue.- Parameters:
targetSnapTo- New targetSnapTo value. Default value is null- Returns:
PointerSettingsinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getTargetSnapTo
Specifies the position of the pointer into the target whenshowing. Accepts the same values assnapTo.If not specified the center location on the appropriate edge is chosen to match up with the
snapTovalue.- Returns:
- Current targetSnapTo value. Default value is null
- See Also:
-
setDefaultProperties
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:
-
setLogicalStructure
Setter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility. -
getLogicalStructure
Getter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.- Specified by:
getLogicalStructurein interfaceLogicalStructure- Overrides:
getLogicalStructurein classBaseWidget
-