A widget extension, which can be used to add constrained xy positioning support to the base Widget class, through the Base.build method. This extension requires that the WidgetPosition extension be added to the Widget (before WidgetPositionConstrain, if part of the same extension list passed to Base.build).
_afterConstrainChangee
After change listener for the "constrain" attribute, responsible for updating the UI, in response to attribute changes.
e
EventFacade
The event facade
_bindUIPosConstrainedBinds event listeners responsible for updating the UI state in response to Widget constrained positioning related state changes.
This method is invoked after bindUI is invoked for the Widget class using YUI's aop infrastructure.
_constrainval
axis
nodeRegion
constrainingRegion
The method which performs the actual constrain calculations for a given axis ("x" or "y") based on the regions provided.
The constrained value
_constrainOnXYChangee
The on change listener for the "xy" attribute. Modifies the event facade's newVal property with the constrained XY value.
e
EventFacade
The event facade for the attribute change
_enableConstraintsenable
Updates the UI if enabling constraints, and sets up the xyChange event listeners to constrain whenever the widget is moved. Disabling constraints removes the listeners.
enable
Boolean
Enable or disable constraints
_getRegionnode
Utility method to normalize region retrieval from a node instance, or the viewport, if no node is provided.
node
Node
Optional.
_preventOverlapval
axis
nodeRegion
constrainingRegion
The method which performs the preventOverlap calculations for a given axis ("x" or "y") based on the value and regions provided.
The constrained value
_setConstrainval
The setter implementation for the "constrain" attribute.
val
Node | boolean
The attribute value
constrainxy
node
Constrains the widget's bounding box to a node (or the viewport). If xy or node are not passed in, the current position and the value of "constrain" will be used respectively.
The widget's position will be changed to the constrained position.
ATTRSStatic property used to define the default attribute configuration introduced by WidgetPositionConstrain.
constrainThe node to constrain the widget's bounding box to, when setting xy. Can also be set to true, to constrain to the viewport.
Default: null
constrainChange
Fires when the value for the configuration attribute constrain 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.
e
EventFacade
preventOverlapIf set to true, and WidgetPositionAlign is also added to the Widget, constrained positioning will attempt to prevent the widget's bounding box from overlapping the element to which it has been aligned, by flipping the orientation of the alignment for corner based alignments
preventOverlapChange
Fires when the value for the configuration attribute preventOverlap 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.
e
EventFacade