AlloyUI - API Docs

  • API Docs for Version: 3.1.0-deprecated.60

    • Show:

    WidgetPosition Class

    Defined in: yui3/src/widget-position/js/Widget-Position.js:24
    Module: widget-position

    Widget extension, which can be used to add positioning support to the base Widget class, through the <a href="Base.html#method_build">Base.build</a> method.

    Methods

    _afterXYChange

    (
    • e
    )
    protected

    Defined in yui3/src/widget-position/js/Widget-Position.js:245

    Default attribute change listener for the xy attribute, responsible for updating the UI, in response to attribute changes.

    Parameters:

    • e EventFacade

      <p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The event facade for the attribute change</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>

    _bindUIPosition

    () protected

    Defined in yui3/src/widget-position/js/Widget-Position.js:146

    Binds event listeners responsible for updating the UI state in response to Widget position related state changes. <p> This method in invoked after bindUI is invoked for the Widget class using YUI's aop infrastructure. </p>

    _getX

    () Number protected

    Defined in yui3/src/widget-position/js/Widget-Position.js:221

    Default getter for the X attribute. The value is retrieved from the XY attribute, which is the sole store for the XY state.

    Returns:

    Number:

    <p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The X page co-ordinate value</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>

    _getY

    () Number protected

    Defined in yui3/src/widget-position/js/Widget-Position.js:233

    Default getter for the Y attribute. The value is retrieved from the XY attribute, which is the sole store for the XY state.

    Returns:

    Number:

    <p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The Y page co-ordinate value</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>

    _renderUIPosition

    () protected

    Defined in yui3/src/widget-position/js/Widget-Position.js:116

    Creates/Initializes the DOM to support xy page positioning. <p> This method in invoked after renderUI is invoked for the Widget class using YUI's aop infrastructure. </p>

    _setX

    (
    • val
    )
    protected

    Defined in yui3/src/widget-position/js/Widget-Position.js:197

    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

      <p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The X page co-ordinate value</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>

    _setY

    (
    • val
    )
    protected

    Defined in yui3/src/widget-position/js/Widget-Position.js:209

    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

      <p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The Y page co-ordinate value</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>

    _syncUIPosition

    () protected

    Defined in yui3/src/widget-position/js/Widget-Position.js:129

    Synchronizes the UI to match the Widgets xy page position state. <p> This method in invoked after syncUI is invoked for the Widget class using YUI's aop infrastructure. </p>

    _uiSetXY

    (
    • val
    )
    protected

    Defined in yui3/src/widget-position/js/Widget-Position.js:259

    Updates the UI to reflect the XY page co-ordinates passed in.

    Parameters:

    • val String

      <p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The XY page co-ordinates value to be reflected in the UI</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>

    _validateXY

    (
    • val
    )
    Boolean protected

    Defined in yui3/src/widget-position/js/Widget-Position.js:185

    Default validator for the XY attribute

    Parameters:

    • val Array

      <p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The XY page co-ordinate value which is being set.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>

    Returns:

    Boolean:

    <p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>true if valid, false if not.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>

    move

    (
    • x
    • [y]
    )

    Defined in yui3/src/widget-position/js/Widget-Position.js:160

    Moves the Widget to the specified page xy co-ordinate position.

    Parameters:

    • x Number | Number[]

      <p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The new x position or [x, y] values passed as an array to support simple pass through of Node.getXY results</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>

    • [y] Number optional

      <p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The new y position</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>

    syncXY

    ()

    Defined in yui3/src/widget-position/js/Widget-Position.js:175

    Synchronizes the Panel's "xy", "x", and "y" properties with the Widget's position in the DOM.

    Properties

    ATTRS

    Object static

    Defined in yui3/src/widget-position/js/Widget-Position.js:34

    Static property used to define the default attribute configuration introduced by WidgetPosition.

    POSITIONED_CLASS_NAME

    String static

    Defined in yui3/src/widget-position/js/Widget-Position.js:95

    Default class used to mark the boundingBox of a positioned widget.

    Default: "yui-widget-positioned"

    Attributes

    x

    Number

    Defined in yui3/src/widget-position/js/Widget-Position.js:44

    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

    xy

    Array

    Defined in yui3/src/widget-position/js/Widget-Position.js:80

    Page XY co-ordinate pair for the widget.

    Default: [0,0]

    y

    Number

    Defined in yui3/src/widget-position/js/Widget-Position.js:62

    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