#

API Docs for: 3.10.3
Show: Inherited Protected Private Deprecated

# WidgetPosition Class

Defined in: `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 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

### Attributes

- x
- xy
- y

## Methods

### `_afterXYChange`

(

- `e`

)
protected

Defined in `widget-position/js/Widget-Position.js:244`

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

Defined in `widget-position/js/Widget-Position.js:143`

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

Defined in `widget-position/js/Widget-Position.js:220`

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: The X page co-ordinate value

### `_getY`

() Number protected

Defined in `widget-position/js/Widget-Position.js:232`

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: The Y page co-ordinate value

### `_renderUIPosition`

() protected

Defined in `widget-position/js/Widget-Position.js:113`

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`

)
protected

Defined in `widget-position/js/Widget-Position.js:196`

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`

)
protected

Defined in `widget-position/js/Widget-Position.js:208`

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

Defined in `widget-position/js/Widget-Position.js:126`

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`

)
protected

Defined in `widget-position/js/Widget-Position.js:258`

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`

)
Boolean protected

Defined in `widget-position/js/Widget-Position.js:184`

Default validator for the XY attribute

#### Parameters:

- `val` Array

  The XY page co-ordinate value which is being set.

#### Returns:

Boolean: true if valid, false if not.

### `move`

(

- `x`
- `y`
- `x,`

)

Defined in `widget-position/js/Widget-Position.js:157`

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

#### Parameters:

- `x` Number

  The new x position

- `y` Number

  The new y position

  Or

- `x,` Array

  y values passed as an array ([x, y]), to support simple pass through of Node.getXY results

### `syncXY`

()

Defined in `widget-position/js/Widget-Position.js:174`

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

## Properties

### `ATTRS`

Object static

Defined in `widget-position/js/Widget-Position.js:40`

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

### `POSITIONED_CLASS_NAME`

String static

Defined in `widget-position/js/Widget-Position.js:101`

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

Default: "yui-widget-positioned"

## Attributes

### `x`

Number

Defined in `widget-position/js/Widget-Position.js:50`

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

Defined in `widget-position/js/Widget-Position.js:86`

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

Defined in `widget-position/js/Widget-Position.js:68`

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.