WidgetPosition Class
+ + + + +Widget extension, which can be used to add positioning support to the base Widget class, +through the Base.build method.
+-
+
- Index + + +
- Methods + + +
- Properties + + +
- Attributes + + +
Item Index
+ + +Methods
+ +-
+
+
- + _afterXYChange + + + + + +
- + _bindUIPosition + + + + + +
- + _getX + + + + + +
- + _getY + + + + + +
- + _renderUIPosition + + + + + +
- + _setX + + + + + +
- + _setY + + + + + +
- + _syncUIPosition + + + + + +
- + _uiSetXY + + + + + +
- + _validateXY + + + + + +
- + move + + + + + +
- + syncXY + + + + + +
Properties
+ +-
+
+
- + ATTRS + + + static + + + + +
- + POSITIONED_CLASS_NAME + + + static + + + + +
Methods
+ + +_afterXYChange
+
+
+ -
+
+
-
+
+
e+ +
+
+
Default attribute change listener for the xy attribute, responsible +for updating the UI, in response to attribute changes.
+Parameters:
+ +-
+
+
-
+
+
e+ EventFacade + + + + +++ + +The event facade for the attribute change
+
+
+
_bindUIPosition
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Binds event listeners responsible for updating the UI state in response to +Widget position related state changes.
+ ++This method in invoked after bindUI is invoked for the Widget class +using YUI's aop infrastructure. +
+_getX
+
+
+ ()
+
+
+
+
+ Number
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Default getter for the X attribute. The value is retrieved from +the XY attribute, which is the sole store for the XY state.
+Returns:
+ +_getY
+
+
+ ()
+
+
+
+
+ Number
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Default getter for the Y attribute. The value is retrieved from +the XY attribute, which is the sole store for the XY state.
+Returns:
+ +_renderUIPosition
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Creates/Initializes the DOM to support xy page positioning.
+ ++This method in invoked after renderUI is invoked for the Widget class +using YUI's aop infrastructure. +
+_setX
+
+
+ -
+
+
-
+
+
val+ +
+
+
Default setter for the X attribute. The setter passes the X value through +to the XY attribute, which is the sole store for the XY state.
+Parameters:
+ +-
+
+
-
+
+
val+ Number + + + + +++ + +The X page co-ordinate value
+
+
+
_setY
+
+
+ -
+
+
-
+
+
val+ +
+
+
Default setter for the Y attribute. The setter passes the Y value through +to the XY attribute, which is the sole store for the XY state.
+Parameters:
+ +-
+
+
-
+
+
val+ Number + + + + +++ + +The Y page co-ordinate value
+
+
+
_syncUIPosition
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Synchronizes the UI to match the Widgets xy page position state.
+ ++This method in invoked after syncUI is invoked for the Widget class +using YUI's aop infrastructure. +
+_uiSetXY
+
+
+ -
+
+
-
+
+
val+ +
+
+
Updates the UI to reflect the XY page co-ordinates passed in.
+Parameters:
+ +-
+
+
-
+
+
val+ String + + + + +++ + +The XY page co-ordinates value to be reflected in the UI
+
+
+
_validateXY
+
+
+ -
+
+
-
+
+
val+ +
+
+
Default validator for the XY attribute
+Parameters:
+ +-
+
+
-
+
+
val+ Array + + + + +++ + +The XY page co-ordinate value which is being set.
+
+
+
Returns:
+ +move
+
+
+ -
+
+
-
+
+
x+ +
+
+ -
+
+
y+ +
+
+ -
+
+
x,+ +
+
+
Moves the Widget to the specified page xy co-ordinate position.
+syncXY
+
+
+ ()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Synchronizes the Panel's "xy", "x", and "y" properties with the +Widget's position in the DOM.
+Properties
+ + +ATTRS
+ Object
+
+
+
+
+
+
+
+
+ static
+
+
+
+
+ Static property used to define the default attribute +configuration introduced by WidgetPosition.
+POSITIONED_CLASS_NAME
+ String
+
+
+
+
+
+
+
+
+ static
+
+
+
+
+ Default class used to mark the boundingBox of a positioned widget.
+Default: "yui-widget-positioned"
+ + + + + +Attributes
+ + +x
+ Number
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Page X co-ordinate for the widget. This attribute acts as a facade for the +xy attribute. Changes in position can be monitored by listening for xyChange events.
+Default: 0
+ + + +Fires event xChange
+
+
+ Fires when the value for the configuration attribute x is
+ changed. You can listen for the event using the on method if you
+ wish to be notified before the attribute's value has changed, or
+ using the after method if you wish to be notified after the
+ attribute's value has changed.
+
Parameters:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
xy
+ Array
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Page XY co-ordinate pair for the widget.
+Default: [0,0]
+ + + +Fires event xyChange
+
+
+ Fires when the value for the configuration attribute xy is
+ changed. You can listen for the event using the on method if you
+ wish to be notified before the attribute's value has changed, or
+ using the after method if you wish to be notified after the
+ attribute's value has changed.
+
Parameters:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
y
+ Number
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Page Y co-ordinate for the widget. This attribute acts as a facade for the +xy attribute. Changes in position can be monitored by listening for xyChange events.
+Default: 0
+ + + +Fires event yChange
+
+
+ Fires when the value for the configuration attribute y is
+ changed. You can listen for the event using the on method if you
+ wish to be notified before the attribute's value has changed, or
+ using the after method if you wish to be notified after the
+ attribute's value has changed.
+
Parameters:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+