Dial

`_getSrcNode`

() Node protected

Inherited from Widget: yui3/src/widget/js/WidgetHTMLParser.js:74

Returns:

Node:

The Node to apply HTML_PARSER to

(

string

)

private

Defined in yui3/src/dial/js/Dial.js:228

returns a properly formed yui class name

Parameters:

string String

to be appended at the end of class name

Returns:

`_setBorderRadius`

() private

Defined in yui3/src/dial/js/Dial.js:387

Sets -webkit-border-radius to 50% of width/height of the ring, handle, marker, and center-button. This is needed for iOS 3.x. The objects render square if the radius is > 50% of the width/height

`_handleCenterButtonEnter`

() protected

Defined in yui3/src/dial/js/Dial.js:413

Handles the mouseenter on the centerButton

`_handleCenterButtonLeave`

() protected

Defined in yui3/src/dial/js/Dial.js:423

Handles the mouseleave on the centerButton

`bindUI`

() protected

Inherited from Widget but overwritten in yui3/src/dial/js/Dial.js:433

Creates the Y.DD.Drag instance used for the handle movement and binds Dial interaction to the configured value model.

`_setTimesWrappedFromValue`

(

val

)

private

Defined in yui3/src/dial/js/Dial.js:483

Sets _timesWrapped based on Dial value to net integer revolutions the user dragged the handle around the Dial

Parameters:

val Number

current value of the Dial

`_getAngleFromHandleCenter`

(

handleCenterX
handleCenterY

)

Number protected

Defined in yui3/src/dial/js/Dial.js:499

gets the angle of the line from the center of the Dial to the center of the handle

Parameters:

handleCenterX Number
handleCenterY Number

Returns:

Number:

ang the angle

`_calculateDialCenter`

() protected

Defined in yui3/src/dial/js/Dial.js:514

calculates the XY of the center of the dial relative to the ring node. This is needed for calculating the angle of the handle

`_handleRingMouseup`

() protected

Defined in yui3/src/dial/js/Dial.js:526

Handles the mouseup on the ring

`_handleCenterButtonMouseup`

() protected

Defined in yui3/src/dial/js/Dial.js:536

Handles the mouseup on the centerButton

`_handleHandleMousedown`

() protected

Defined in yui3/src/dial/js/Dial.js:546

Handles the mousedown on the handle

`_handleDrag`

(

e

)

protected

Defined in yui3/src/dial/js/Dial.js:558

handles the user dragging the handle around the Dial, gets the angle, checks for wrapping around top center. Sets the new value of the Dial

Parameters:

e DOMEvent

the drag event object

`_handleMousedown`

(

e

)

private

Defined in yui3/src/dial/js/Dial.js:608

handles a mousedown or gesturemovestart event on the ring node

Parameters:

e DOMEvent

the event object

`_handleValuesBeyondMinMax`

(

e
newValue

)

protected

Defined in yui3/src/dial/js/Dial.js:751

handles the case where the value is less than min or greater than max This is used both when handle is dragged and when the ring is clicked

Parameters:

e DOMEvent

the event object
newValue Number

current value of the dial

`_handleDragStart`

(

e

)

protected

Defined in yui3/src/dial/js/Dial.js:777

handles the user starting to drag the handle around the Dial

Parameters:

e DOMEvent

the drag event object

`_handleDragEnd`

() protected

Defined in yui3/src/dial/js/Dial.js:792

handles the end of a user dragging the handle, animates the handle returning to resting position.

`_setNodeToFixedRadius`

(

obj
typeArray

)

Array protected

Defined in yui3/src/dial/js/Dial.js:820

returns the XY of the fixed position, handleDistance, from the center of the Dial (resting position). The XY also represents the angle related to the current value. If typeArray is true, [X,Y] is returned. If typeArray is false, the XY of the obj node passed in is set.

Parameters:

obj Node
typeArray Boolean

true returns an array [X,Y]

Returns:

Array:

an array of [XY] is optionally returned

`syncUI`

()

Inherited from Widget but overwritten in yui3/src/dial/js/Dial.js:849

Synchronizes the DOM state with the attribute settings.

`_setSizes`

() protected

Defined in yui3/src/dial/js/Dial.js:866

sets the sizes of ring, center-button, marker, handle, and VML ovals in pixels. Needed only because some IE versions ignore CSS percent sizes/offsets. so these must be set in pixels. Normally these are set in % of the ring.

`_renderLabel`

() protected

Defined in yui3/src/dial/js/Dial.js:914

renders the DOM object for the Dial's label

`_renderRing`

() protected

Defined in yui3/src/dial/js/Dial.js:931

renders the DOM object for the Dial's background ring

`_renderMarker`

() protected

Defined in yui3/src/dial/js/Dial.js:947

renders the DOM object for the Dial's background marker which tracks the angle of the user dragging the handle

`_renderCenterButton`

() protected

Defined in yui3/src/dial/js/Dial.js:963

renders the DOM object for the Dial's center

`_renderHandle`

() protected

Defined in yui3/src/dial/js/Dial.js:980

renders the DOM object for the Dial's user draggable handle

`_setLabelString`

(

str

)

deprecated protected

Defined in yui3/src/dial/js/Dial.js:999

Deprecated: Use DialObjName.set('strings',{'label':'My new label'}); before DialObjName.render();

sets the visible UI label HTML string

Parameters:

str String

`_setResetString`

(

str

)

deprecated protected

Defined in yui3/src/dial/js/Dial.js:1012

Deprecated: Use DialObjName.set('strings',{'resetStr':'My new reset string'}); before DialObjName.render();

sets the visible UI label HTML string

Parameters:

str String

`_setTooltipString`

(

str

)

deprecated protected

Defined in yui3/src/dial/js/Dial.js:1026

Deprecated: Use DialObjName.set('strings',{'tooltipHandle':'My new tooltip'}); before DialObjName.render();

sets the tooltip HTML string in the Dial's handle

Parameters:

str String

`_onDirectionKey`

(

e

)

protected

Defined in yui3/src/dial/js/Dial.js:1038

sets the Dial's value in response to key events. Left and right keys are in a separate method in case an implementation wants to increment values but needs left and right arrow keys for other purposes.

Parameters:

e Event

the key event

`_onLeftRightKey`

(

e

)

protected

Defined in yui3/src/dial/js/Dial.js:1072

sets the Dial's value in response to left or right key events

Parameters:

e Event

the key event

`_onLeftRightKeyMeta`

(

e

)

protected

Defined in yui3/src/dial/js/Dial.js:1091

sets the Dial's value in response to left or right key events when a meta (mac command/apple) key is also pressed

Parameters:

e Event

the key event

`_incrMinor`

() protected

Defined in yui3/src/dial/js/Dial.js:1110

increments Dial value by a minor increment

`_decrMinor`

() protected

Defined in yui3/src/dial/js/Dial.js:1126

decrements Dial value by a minor increment

`_incrMajor`

() protected

Defined in yui3/src/dial/js/Dial.js:1138

increments Dial value by a major increment

`_decrMajor`

() protected

Defined in yui3/src/dial/js/Dial.js:1150

decrements Dial value by a major increment

`_setToMax`

() protected

Defined in yui3/src/dial/js/Dial.js:1162

sets Dial value to dial's max attr

`_setToMin`

() protected

Defined in yui3/src/dial/js/Dial.js:1172

sets Dial value to dial's min attr

`_resetDial`

() protected

Defined in yui3/src/dial/js/Dial.js:1182

resets Dial value to the orignal initial value.

`_getAngleFromValue`

(

newVal

)

Number protected

Defined in yui3/src/dial/js/Dial.js:1197

returns the handle angle associated with the current value of the Dial. Returns a number between 0 and 360.

Parameters:

newVal Number

the current value of the Dial

Returns:

Number:

the angle associated with the current Dial value

`_getValueFromAngle`

(

angle

)

Number protected

Defined in yui3/src/dial/js/Dial.js:1212

returns the value of the Dial calculated from the current handle angle

Parameters:

angle Number

the current angle of the Dial's handle

Returns:

Number:

the current Dial value corresponding to the handle position

`_afterValueChange`

(

e

)

protected

Defined in yui3/src/dial/js/Dial.js:1232

calls the method to update the UI whenever the Dial value changes

Parameters:

e Event

`_valueToDecimalPlaces`

(

val

)

Number protected

Defined in yui3/src/dial/js/Dial.js:1243

Changes a value to have the correct decimal places per the attribute decimalPlaces

Parameters:

val Number

a raw value to set to the Dial

Returns:

Number:

the input val changed to have the correct decimal places

`_uiSetValue`

(

val

)

protected

Defined in yui3/src/dial/js/Dial.js:1255

Updates the UI display value of the Dial to reflect the value passed in. Makes all other needed UI display changes

Parameters:

val Number

value of the Dial

`_validateValue`

(

val

)

protected

Defined in yui3/src/dial/js/Dial.js:1292

value attribute default validator. Verifies that the value being set lies between the min/max value

Parameters:

val Number

value of the Dial

`getClassName`

(

args

)

Inherited from Widget but overwritten in yui3/src/widget/js/Widget.js:309

Generate a standard prefixed classname for the Widget, prefixed by the default prefix defined by the <code>Y.config.classNamePrefix</code> attribute used by <code>ClassNameManager</code> and <code>Widget.NAME.toLowerCase()</code> (e.g. "yui-widget-xxxxx-yyyyy", based on default values for the prefix and widget class name). The instance based version of this method can be used to generate standard prefixed classnames, based on the instances NAME, as opposed to Widget.NAME. This method should be used when you need to use a constant class name across different types instances.

Parameters:

args String multiple

0..n strings which should be concatenated, using the default separator defined by ClassNameManager, to create the class name

`initializer`

(

config

)

protected

Inherited from Widget: yui3/src/widget/js/Widget.js:380

Initializer lifecycle implementation for the Widget class. Registers the widget instance, and runs through the Widget's HTML_PARSER definition.

Parameters:

config Object

Configuration object literal for the widget

`_mapInstance`

(

The

)

protected

Inherited from Widget: yui3/src/widget/js/Widget.js:410

Utility method used to add an entry to the boundingBox id to instance map.

This method can be used to populate the instance with lazily created boundingBox Node references.

Parameters:

The String

boundingBox id

`destructor`

() protected

Inherited from Widget: yui3/src/widget/js/Widget.js:423

Destructor lifecycle implementation for the Widget class. Purges events attached to the bounding box and content box, removes them from the DOM and removes the Widget from the list of registered widgets.

`destroy`

(

destroyAllNodes

)

Widget chainable

Inherited from BaseObservable but overwritten in yui3/src/widget/js/Widget.js:448

Destroy lifecycle method. Fires the destroy event, prior to invoking destructors for the class hierarchy.

Overrides Base's implementation, to support arguments to destroy Subscribers to the destroy event can invoke preventDefault on the event object, to prevent destruction from proceeding.

Parameters:

destroyAllNodes Boolean

If true, all nodes contained within the Widget are removed and destroyed. Defaults to false due to potentially high run-time cost.

Returns:

Widget:

A reference to this object

`_destroyBox`

() protected

Inherited from Widget: yui3/src/widget/js/Widget.js:472

Removes and destroys the widgets rendered boundingBox, contentBox, and detaches bound UI events.

`render`

(

parentNode

)

final chainable

Inherited from Widget: yui3/src/widget/js/Widget.js:509

Establishes the initial DOM for the widget. Invoking this method will lead to the creating of all DOM elements for the widget (or the manipulation of existing DOM elements for the progressive enhancement use case). This method should only be invoked once for an initialized widget. It delegates to the widget specific renderer method to do the actual work.

Parameters:

parentNode Object | String

Optional. The Node under which the Widget is to be rendered. This can be a Node instance or a CSS selector string. If the selector string returns more than one Node, the first node will be used as the parentNode. NOTE: This argument is required if both the boundingBox and contentBox are not currently in the document. If it's not provided, the Widget will be rendered to the body of the current document in this case.

`_defRenderFn`

(

e
parentNode

)

protected

Inherited from Widget: yui3/src/widget/js/Widget.js:567

Default render handler

Parameters:

e EventFacade

The Event object
parentNode Node

The parent node to render to, if passed in to the <code>render</code> method

`renderer`

() protected

Inherited from Widget: yui3/src/widget/js/Widget.js:584

Creates DOM (or manipulates DOM for progressive enhancement) This method is invoked by render() and is not chained automatically for the class hierarchy (unlike initializer, destructor) so it should be chained manually for subclasses if required.

`hide`

() chainable

Inherited from Widget: yui3/src/widget/js/Widget.js:641

Hides the Widget by setting the "visible" attribute to "false".

`show`

() chainable

Inherited from Widget: yui3/src/widget/js/Widget.js:650

Shows the Widget by setting the "visible" attribute to "true".

`focus`

() chainable

Inherited from Widget: yui3/src/widget/js/Widget.js:659

Causes the Widget to receive the focus by setting the "focused" attribute to "true".

`blur`

() chainable

Inherited from Widget: yui3/src/widget/js/Widget.js:669

Causes the Widget to lose focus by setting the "focused" attribute to "false"

`enable`

() chainable

Inherited from Widget: yui3/src/widget/js/Widget.js:679

Set the Widget's "disabled" attribute to "false".

`disable`

() chainable

Inherited from Widget: yui3/src/widget/js/Widget.js:688

Set the Widget's "disabled" attribute to "true".

`_uiSizeCB`

(

expand

)

protected

Inherited from Widget: yui3/src/widget/js/Widget.js:697

Parameters:

expand Boolean

`_renderBox`

(

parentNode

)

private

Inherited from Widget: yui3/src/widget/js/Widget.js:706

Helper method to collect the boundingBox and contentBox and append to the provided parentNode, if not already a child. The owner document of the boundingBox, or the owner document of the contentBox will be used as the document into which the Widget is rendered if a parentNode is node is not provided. If both the boundingBox and the contentBox are not currently in the document, and no parentNode is provided, the widget will be rendered to the current document's body.

Parameters:

parentNode Node

The parentNode to render the widget to. If not provided, and both the boundingBox and the contentBox are not currently in the document, the widget will be rendered to the current document's body.

`_setBB`

(

node

)

private

Inherited from Widget: yui3/src/widget/js/Widget.js:752

Setter for the boundingBox attribute

Parameters:

node Node | String

Returns:

Node

`_setCB`

(

node

)

private

Inherited from Widget: yui3/src/widget/js/Widget.js:764

Setter for the contentBox attribute

Parameters:

node Node | String

Returns:

Node

`_defaultBB`

() protected

Inherited from Widget: yui3/src/widget/js/Widget.js:776

Returns the default value for the boundingBox attribute.

For the Widget class, this will most commonly be null (resulting in a new boundingBox node instance being created), unless a srcNode was provided and CONTENT_TEMPLATE is null, in which case it will be srcNode. This behavior was introduced in @VERSION@ to accomodate single-box widgets whose BB & CB both point to srcNode (e.g. Y.Button).

`_defaultCB`

() protected

Inherited from Widget: yui3/src/widget/js/Widget.js:795

Returns the default value for the contentBox attribute.

For the Widget class, this will be the srcNode if provided, otherwise null (resulting in a new contentBox node instance being created)

`_setBox`

(

id
node
template
isBounding

)

Node private

Inherited from Widget: yui3/src/widget/js/Widget.js:808

Helper method to set the bounding/content box, or create it from the provided template if not found.

Parameters:

id String

The node's id attribute
node Node | String

The node reference
template String

HTML string template for the node
isBounding Boolean

true if this is the boundingBox, false if it's the contentBox

Returns:

Node:

The node

`_renderUI`

() protected

Inherited from Widget: yui3/src/widget/js/Widget.js:842

Initializes the UI state for the Widget's bounding/content boxes.

`_renderBoxClassNames`

() protected

Inherited from Widget: yui3/src/widget/js/Widget.js:853

Applies standard class names to the boundingBox and contentBox

`_removeLoadingClassNames`

() protected

Inherited from Widget: yui3/src/widget/js/Widget.js:877

Removes class names representative of the widget's loading state from the boundingBox.

`_bindUI`

() protected

Inherited from Widget: yui3/src/widget/js/Widget.js:898

Sets up DOM and CustomEvent listeners for the widget.

`_unbindUI`

() protected

Inherited from Widget: yui3/src/widget/js/Widget.js:909

`_bindDOM`

() protected

Inherited from Widget: yui3/src/widget/js/Widget.js:917

Sets up DOM listeners, on elements rendered by the widget.

`_unbindDOM`

() protected

Inherited from Widget: yui3/src/widget/js/Widget.js:948

`_syncUI`

() protected

Inherited from Widget: yui3/src/widget/js/Widget.js:979

Updates the widget UI to reflect the attribute state.

`_uiSetHeight`

(

val

)

protected

Inherited from Widget: yui3/src/widget/js/Widget.js:989

Sets the height on the widget's bounding box element

Parameters:

val String | Number

`_uiSetWidth`

(

val

)

protected

Inherited from Widget: yui3/src/widget/js/Widget.js:1001

Sets the width on the widget's bounding box element

Parameters:

val String | Number

`_uiSetDim`

(

dim
val

)

private

Inherited from Widget: yui3/src/widget/js/Widget.js:1012

Parameters:

dim String

The dimension - "width" or "height"
val Number | String

The value to set

`_uiSetVisible`

(

val

)

protected

Inherited from Widget: yui3/src/widget/js/Widget.js:1022

Sets the visible state for the UI

Parameters:

val Boolean

`_uiSetDisabled`

(

val

)

protected

Inherited from Widget: yui3/src/widget/js/Widget.js:1033

Sets the disabled state for the UI

Parameters:

val Boolean

`_uiSetFocused`

(

val
src

)

protected

Inherited from Widget: yui3/src/widget/js/Widget.js:1044

Sets the focused state for the UI

Parameters:

val Boolean
src String

String representing the source that triggered an update to the UI.

`_uiSetTabIndex`

(

Number

)

protected

Inherited from Widget: yui3/src/widget/js/Widget.js:1066

Set the tabIndex on the widget's rendered UI

Parameters:

Number Object

`_onDocMouseDown`

(

evt

)

protected

Inherited from Widget: yui3/src/widget/js/Widget.js:1083

"mousedown" event handler for the owner document of the widget's bounding box.

Parameters:

evt EventFacade

The event facade for the DOM focus event

`_onDocFocus`

(

evt

)

protected

Inherited from Widget: yui3/src/widget/js/Widget.js:1096

DOM focus event handler, used to sync the state of the Widget with the DOM

Parameters:

evt EventFacade

The event facade for the DOM focus event

`toString`

() String

Inherited from BaseCore but overwritten in yui3/src/widget/js/Widget.js:1122

Generic toString implementation for all widgets.

Returns:

String:

The default string value for the widget [ displays the NAME of the instance, and the unique id ]

`_guid`

() protected

Inherited from Widget: yui3/src/widget/js/Widget.js:1168

`_validTabIndex`

(

tabIndex

)

protected

Inherited from Widget: yui3/src/widget/js/Widget.js:1176

Parameters:

tabIndex Number

`_bindAttrUI`

(

attrs

)

private

Inherited from Widget: yui3/src/widget/js/Widget.js:1185

Binds after listeners for the list of attributes provided

Parameters:

attrs Array

`_syncAttrUI`

(

attrs

)

private

Inherited from Widget: yui3/src/widget/js/Widget.js:1201

Invokes the _uiSet=ATTR NAME> method for the list of attributes provided

Parameters:

attrs Array

`_setAttrUI`

(

e

)

private

Inherited from Widget: yui3/src/widget/js/Widget.js:1216

Parameters:

e EventFacade

`_strSetter`

(

strings

)

String protected

Inherited from Widget: yui3/src/widget/js/Widget.js:1227

The default setter for the strings attribute. Merges partial sets into the full string set, to allow users to partial sets of strings

Parameters:

strings Object

Returns:

String:

The full set of strings to set

`getString`

(

key

)

String deprecated

Inherited from Widget: yui3/src/widget/js/Widget.js:1240

Deprecated: Used by deprecated WidgetLocale implementations.

Helper method to get a specific string value

Parameters:

key String

Returns:

String:

The string

`getStrings`

(

key

)

String deprecated

Inherited from Widget: yui3/src/widget/js/Widget.js:1252

Deprecated: Used by deprecated WidgetLocale implementations.

Helper method to get the complete set of strings for the widget

Parameters:

key String

Returns:

String:

The strings

`renderUI`

() protected

Inherited from Widget but overwritten in yui3/src/dial/js/Dial.js:352

creates the DOM structure for the Dial.

`_preAddAttrs`

(

attrs
userVals
lazy

)

protected

Inherited from Widget: yui3/src/widget/js/WidgetHTMLParser.js:83

Implement the BaseCore _preAddAttrs method hook, to add the srcNode and related attributes, so that HTML_PARSER (which relies on this.get("srcNode")) can merge in it's results before the rest of the attributes are added.

Parameters:

attrs Object

The full hash of statically defined ATTRS attributes being added for this instance
userVals Object

The hash of user values passed to the constructor
lazy Boolean

Whether or not to add the attributes lazily

`_applyParsedConfig`

() Object protected

Inherited from Widget: yui3/src/widget/js/WidgetHTMLParser.js:121

Returns:

Object:

The merged configuration literal

`_applyParser`

(

config

)

protected

Inherited from Widget: yui3/src/widget/js/WidgetHTMLParser.js:130

Utility method used to apply the <code>HTML_PARSER</code> configuration for the instance, to retrieve config data values.

Parameters:

config Object

User configuration object (will be populated with values from Node)

`_getNodeToParse`

() Node private

Inherited from Widget: yui3/src/widget/js/WidgetHTMLParser.js:172

Determines whether we have a node reference which we should try and parse.

The current implementation does not parse nodes generated from CONTENT_TEMPLATE, only explicitly set srcNode, or contentBox attributes.

Returns:

Node:

The node reference to apply HTML_PARSER to.

`_getHtmlParser`

() Object private

Inherited from Widget: yui3/src/widget/js/WidgetHTMLParser.js:187

Gets the HTML_PARSER definition for this instance, by merging HTML_PARSER definitions across the class hierarchy.

Returns:

Object:

HTML_PARSER definition for this instance

`getSkinName`

(

[skinPrefix]

)

String

Inherited from Widget: yui3/src/widget/js/WidgetSkin.js:12

Returns the name of the skin that's currently applied to the widget.

Searches up the Widget's ancestor axis for, by default, a class yui3-skin-(name), and returns the (name) portion. Otherwise, returns null.

This is only really useful after the widget's DOM structure is in the document, either by render or by progressive enhancement.

Parameters:

[skinPrefix] String optional

The prefix which the implementation uses for the skin ("yui3-skin-" is the default). NOTE: skinPrefix will be used as part of a regular expression: <pre><code>new RegExp('\b' + skinPrefix + '(\S+)') </code></pre> Although an unlikely use case, literal characters which may result in an invalid regular expression should be escaped.

Returns:

String:

The name of the skin, or null, if a matching skin class is not found.

`_destroyUIEvents`

() private

Inherited from Widget: yui3/src/widget/js/WidgetUIEvents.js:20

Destructor logic for UI event infrastructure, invoked during Widget destruction.

`_getUIEventNode`

() protected

Inherited from Widget but overwritten in yui3/src/widget/js/WidgetUIEvents.js:62

Returns the node on which to bind delegate listeners.

`_createUIEvent`

(

type

)

private

Inherited from Widget: yui3/src/widget/js/WidgetUIEvents.js:73

Binds a delegated DOM event listener of the specified type to the Widget's outtermost DOM element to facilitate the firing of a Custom Event of the same type for the Widget instance.

Parameters:

type String

String representing the name of the event

`_filterUIEvent`

(

evt

)

Boolean private

Inherited from Widget: yui3/src/widget/js/WidgetUIEvents.js:117

This method is used to determine if we should fire the UI Event or not. The default implementation makes sure that for nested delegates (nested unrelated widgets), we don't fire the UI event listener more than once at each level.

For example, without the additional filter, if you have nested widgets, each widget will have a delegate listener. If you click on the inner widget, the inner delegate listener's filter will match once, but the outer will match twice (based on delegate's design) - once for the inner widget, and once for the outer.

Parameters:

evt DOMEventFacade

Returns:

Boolean:

true if it's OK to fire the custom UI event, false if not.

`_isUIEvent`

(

type

)

String private

Inherited from Widget: yui3/src/widget/js/WidgetUIEvents.js:143

Determines if the specified event is a UI event.

Parameters:

type String

String representing the name of the event

Returns:

String:

Event Returns the name of the UI Event, otherwise undefined.

`_initUIEvent`

(

type

)

String private

Inherited from Widget: yui3/src/widget/js/WidgetUIEvents.js:176

Sets up infrastructure required to fire a UI event.

Parameters:

type String

String representing the name of the event

Returns:

String:

`next`

(

circular

)

Widget

Inherited from Widget: yui3/src/widget-child/js/Widget-Child.js:191

Returns the Widget's next sibling.

Parameters:

circular Boolean

Boolean indicating if the parent's first child should be returned if the child has no next sibling.

Returns:

Widget:

Widget instance.

`previous`

(

circular

)

Widget

Inherited from Widget: yui3/src/widget-child/js/Widget-Child.js:216

Returns the Widget's previous sibling.

Parameters:

circular Boolean

Boolean indicating if the parent's last child should be returned if the child has no previous sibling.

Returns:

Widget:

Widget instance.

`isRoot`

() Boolean

Inherited from Widget: yui3/src/widget-child/js/Widget-Child.js:267

Determines if the Widget is the root Widget in the object hierarchy.

Returns:

Boolean:

Boolean indicating if Widget is the root Widget in the object hierarchy.

`ancestor`

(

depth

)

Widget

Inherited from Widget: yui3/src/widget-child/js/Widget-Child.js:279

Returns the Widget instance at the specified depth.

Parameters:

depth Number

Number representing the depth of the ancestor.

Returns:

Widget:

Widget instance.

`_uiSetChildSelected`

(

selected

)

protected

Inherited from Widget: yui3/src/widget-child/js/Widget-Child.js:305

Updates the UI to reflect the <code>selected</code> attribute value.

Parameters:

selected Number

The selected value to be reflected in the UI.

`_afterChildSelectedChange`

(

event

)

protected

Inherited from Widget: yui3/src/widget-child/js/Widget-Child.js:327

Default attribute change listener for the <code>selected</code> attribute, responsible for updating the UI, in response to attribute changes.

Parameters:

event EventFacade

The event facade for the attribute change.

`_syncUIChild`

() protected

Inherited from Widget: yui3/src/widget-child/js/Widget-Child.js:341

Synchronizes the UI to match the WidgetChild state. This method is invoked after bindUI is invoked for the Widget class using YUI's aop infrastructure.

`_bindUIChild`

() protected

Inherited from Widget: yui3/src/widget-child/js/Widget-Child.js:356

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

`_initAttrHost`

(

attrs
values
lazy

)

private

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:140

Constructor logic for attributes. Initializes the host state, and sets up the inital attributes passed to the constructor.

Parameters:

attrs Object

The attributes to add during construction (passed through to <a href="#method_addAttrs">addAttrs</a>). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.
values Object

The initial attribute values to apply (passed through to <a href="#method_addAttrs">addAttrs</a>). These are not merged/cloned. The caller is responsible for isolating user provided values if required.
lazy Boolean

Whether or not to add attributes lazily (passed through to <a href="#method_addAttrs">addAttrs</a>).

`addAttr`

(

name
config
lazy

)

Object chainable

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:157

Adds an attribute with the provided configuration to the host object. The config argument object supports the following properties: <dl> <dt>value <Any></dt> <dd>The initial value to set on the attribute</dd> <dt>valueFn <Function | String></dt> <dd> A function, which will return the initial value to set on the attribute. This is useful for cases where the attribute configuration is defined statically, but needs to reference the host instance ("this") to obtain an initial value. If both the value and valueFn properties are defined, the value returned by the valueFn has precedence over the value property, unless it returns undefined, in which case the value property is used. valueFn can also be set to a string, representing the name of the instance method to be used to retrieve the value. </dd> <dt>readOnly <boolean></dt> <dd>Whether or not the attribute is read only. Attributes having readOnly set to true cannot be modified by invoking the set method.</dd> <dt>writeOnce <boolean> or <string></dt> <dd> Whether or not the attribute is "write once". Attributes having writeOnce set to true, can only have their values set once, be it through the default configuration, constructor configuration arguments, or by invoking set. The writeOnce attribute can also be set to the string "initOnly", in which case the attribute can only be set during initialization (when used with Base, this means it can only be set during construction) </dd> <dt>setter <Function | String></dt> <dd> The setter function used to massage or normalize the value passed to the set method for the attribute. The value returned by the setter will be the final stored value. Returning <a href="#property_Attribute.INVALID_VALUE">Attribute.INVALID_VALUE</a>, from the setter will prevent the value from being stored. setter can also be set to a string, representing the name of the instance method to be used as the setter function. </dd> <dt>getter <Function | String></dt> <dd> The getter function used to massage or normalize the value returned by the get method for the attribute. The value returned by the getter function is the value which will be returned to the user when they invoke get. getter can also be set to a string, representing the name of the instance method to be used as the getter function. </dd> <dt>validator <Function | String></dt> <dd> The validator function invoked prior to setting the stored value. Returning false from the validator function will prevent the value from being stored. validator can also be set to a string, representing the name of the instance method to be used as the validator function. </dd> <dt>lazyAdd <boolean></dt> <dd>Whether or not to delay initialization of the attribute until the first call to get/set it. This flag can be used to over-ride lazy initialization on a per attribute basis, when adding multiple attributes through the <a href="#method_addAttrs">addAttrs</a> method.</dd> </dl> The setter, getter and validator are invoked with the value and name passed in as the first and second arguments, and with the context ("this") set to the host object. Configuration properties outside of the list mentioned above are considered private properties used internally by attribute, and are not intended for public use.

Parameters:

name String

The name of the attribute.
config Object

An object with attribute configuration property/value pairs, specifying the configuration for the attribute. NOTE: The configuration object is modified when adding an attribute, so if you need to protect the original values, you will need to merge the object.
lazy Boolean

(optional) Whether or not to add this attribute lazily (on the first call to get/set).

Returns:

Object:

A reference to the host object.

`attrAdded`

(

name

)

Boolean

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:319

Checks if the given attribute has been added to the host

Parameters:

name String

The name of the attribute to check.

Returns:

Boolean:

true if an attribute with the given name has been added, false if it hasn't. This method will return true for lazily added attributes.

`get`

(

name

)

Any

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:331

Returns the current value of the attribute. If the attribute has been configured with a 'getter' function, this method will delegate to the 'getter' to obtain the value of the attribute.

Parameters:

name String

The name of the attribute. If the value of the attribute is an Object, dot notation can be used to obtain the value of a property of the object (e.g. <code>get("x.y.z")</code>)

Returns:

Any:

The value of the attribute

`_isLazyAttr`

(

name

)

Boolean private

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:347

Checks whether or not the attribute is one which has been added lazily and still requires initialization.

Parameters:

name String

The name of the attribute

Returns:

Boolean:

true if it's a lazily added attribute, false otherwise.

`_addLazyAttr`

(

name
[lazyCfg]

)

private

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:360

Finishes initializing an attribute which has been lazily added.

Parameters:

name Object

The name of the attribute
[lazyCfg] Object optional

Optional config hash for the attribute. This is added for performance along the critical path, where the calling method has already obtained lazy config from state.

`set`

(

name
value
[opts]

)

Object chainable

Inherited from AttributeObservable but overwritten in yui3/src/attribute/js/AttributeCore.js:388

Sets the value of an attribute.

Parameters:

name String

The name of the attribute. If the current value of the attribute is an Object, dot notation can be used to set the value of a property within the object (e.g. <code>set("x.y.z", 5)</code>).
value Any

The value to set the attribute to.
[opts] Object optional

Optional data providing the circumstances for the change.

Returns:

Object:

A reference to the host object.

`_set`

(

name
val
[opts]

)

Object protected chainable

Inherited from AttributeObservable but overwritten in yui3/src/attribute/js/AttributeCore.js:405

Allows setting of readOnly/writeOnce attributes. See <a href="#method_set">set</a> for argument details.

Parameters:

name String

The name of the attribute.
val Any

The value to set the attribute to.
[opts] Object optional

Optional data providing the circumstances for the change.

Returns:

Object:

A reference to the host object.

`_setAttr`

(

name
value
[opts]
force

)

Object protected chainable

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:421

Provides the common implementation for the public set and protected _set methods. See <a href="#method_set">set</a> for argument details.

Parameters:

name String

The name of the attribute.
value Any

The value to set the attribute to.
[opts] Object optional

Optional data providing the circumstances for the change.
force Boolean

If true, allows the caller to set values for readOnly or writeOnce attributes which have already been set.

Returns:

Object:

A reference to the host object.

`_addOutOfOrder`

(

name
cfg

)

private

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:550

Utility method used by get/set to add attributes encountered out of order when calling addAttrs(). For example, if: <pre><code>this.addAttrs({ foo: { setter: function() { // make sure this bar is available when foo is added this.get("bar"); } }, bar: { value: ... } });</code></pre>

Parameters:

name String

attribute name
cfg Object

attribute configuration

`_getAttr`

(

name

)

Any protected chainable

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:587

Provides the common implementation for the public get method, allowing Attribute hosts to over-ride either method. See <a href="#method_get">get</a> for argument details.

Parameters:

name String

The name of the attribute.

Returns:

Any:

The value of the attribute.

`_getStateVal`

(

name
[cfg]

)

Any private

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:641

Gets the stored value for the attribute, from either the internal state object, or the state proxy if it exits

Parameters:

name String

The name of the attribute
[cfg] Object optional

Optional config hash for the attribute. This is added for performance along the critical path, where the calling method has already obtained the config from state.

Returns:

Any:

The stored value of the attribute

`_setStateVal`

(

name
value

)

private

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:663

Sets the stored value for the attribute, in either the internal state object, or the state proxy if it exits

Parameters:

name String

The name of the attribute
value Any

The value of the attribute

`_setAttrVal`

(

attrName
subAttrName
prevVal
newVal
[opts]
[attrCfg]

)

Boolean private

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:681

Updates the stored value of the attribute in the privately held State object, if validation and setter passes.

Parameters:

attrName String

The attribute name.
subAttrName String

The sub-attribute name, if setting a sub-attribute property ("x.y.z").
prevVal Any

The currently stored value of the attribute.
newVal Any

The value which is going to be stored.
[opts] Object optional

Optional data providing the circumstances for the change.
[attrCfg] Object optional

Optional config hash for the attribute. This is added for performance along the critical path, where the calling method has already obtained the config from state.

Returns:

Boolean:

true if the new attribute value was stored, false if not.

`setAttrs`

(

attrs
[opts]

)

Object chainable

Inherited from AttributeObservable but overwritten in yui3/src/attribute/js/AttributeCore.js:770

Sets multiple attribute values.

Parameters:

attrs Object

An object with attributes name/value pairs.
[opts] Object optional

Optional data providing the circumstances for the change.

Returns:

Object:

A reference to the host object.

`_setAttrs`

(

attrs
[opts]

)

Object protected chainable

Inherited from AttributeObservable but overwritten in yui3/src/attribute/js/AttributeCore.js:783

Implementation behind the public setAttrs method, to set multiple attribute values.

Parameters:

attrs Object

An object with attributes name/value pairs.
[opts] Object optional

Optional data providing the circumstances for the change

Returns:

Object:

A reference to the host object.

`getAttrs`

(

attrs

)

Object

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:803

Gets multiple attribute values.

Parameters:

attrs String | Boolean

Optional. An array of attribute names. If omitted, all attribute values are returned. If set to true, all attributes modified from their initial values are returned.

Returns:

Object:

An object with attribute name/value pairs.

`_getAttrs`

(

attrs

)

Object protected

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:815

Implementation behind the public getAttrs method, to get multiple attribute values.

Parameters:

attrs String | Boolean

Optional. An array of attribute names. If omitted, all attribute values are returned. If set to true, all attributes modified from their initial values are returned.

Returns:

Object:

An object with attribute name/value pairs.

`addAttrs`

(

cfgs
values
lazy

)

Object chainable

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:846

Configures a group of attributes, and sets initial values. NOTE: This method does not isolate the configuration object by merging/cloning. The caller is responsible for merging/cloning the configuration object if required.

Parameters:

cfgs Object

An object with attribute name/configuration pairs.
values Object

An object with attribute name/value pairs, defining the initial values to apply. Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.
lazy Boolean

Whether or not to delay the intialization of these attributes until the first call to get/set. Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. See <a href="#method_addAttr">addAttr</a>.

Returns:

Object:

A reference to the host object.

`_addAttrs`

(

cfgs
values
lazy

)

private

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:877

Implementation behind the public addAttrs method. This method is invoked directly by get if it encounters a scenario in which an attribute's valueFn attempts to obtain the value an attribute in the same group of attributes, which has not yet been added (on demand initialization).

Parameters:

cfgs Object

An object with attribute name/configuration pairs.
values Object

An object with attribute name/value pairs, defining the initial values to apply. Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.
lazy Boolean

Whether or not to delay the intialization of these attributes until the first call to get/set. Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. See <a href="#method_addAttr">addAttr</a>.

`_protectAttrs`

(

attrs

)

Object deprecated protected

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:924

Deprecated: Use `AttributeCore.protectAttrs()` or `Attribute.protectAttrs()` which are the same static utility method.

Utility method to protect an attribute configuration hash, by merging the entire object and the individual attr config objects.

Parameters:

attrs Object

A hash of attribute to configuration object pairs.

Returns:

Object:

A protected version of the attrs argument.

`_normAttrVals`

(

APIs

Dial Class

Constructor

Parameters:

Index

Methods

Properties

Attributes

Events

Methods

_getSrcNode

Returns:

Parameters:

Returns:

_setBorderRadius

_handleCenterButtonEnter

_handleCenterButtonLeave

bindUI

_setTimesWrappedFromValue

Parameters:

_getAngleFromHandleCenter

Parameters:

Returns:

_calculateDialCenter

_handleRingMouseup

_handleCenterButtonMouseup

_handleHandleMousedown

_handleDrag

Parameters:

_handleMousedown

Parameters:

_handleValuesBeyondMinMax

Parameters:

_handleDragStart

Parameters:

_handleDragEnd

_setNodeToFixedRadius

Parameters:

Returns:

syncUI

_setSizes

_renderLabel

_renderRing

_renderMarker

_renderCenterButton

_renderHandle

_setLabelString

Parameters:

_setResetString

Parameters:

_setTooltipString

Parameters:

_onDirectionKey

Parameters:

_onLeftRightKey

Parameters:

_onLeftRightKeyMeta

Parameters:

_incrMinor

_decrMinor

_incrMajor

_decrMajor

_setToMax

_setToMin

_resetDial

_getAngleFromValue

Parameters:

Returns:

_getValueFromAngle

Parameters:

Returns:

_afterValueChange

Parameters:

_valueToDecimalPlaces

Parameters:

Returns:

_uiSetValue

Parameters:

_validateValue

`Dial`

`_getSrcNode`

`_setBorderRadius`

`_handleCenterButtonEnter`

`_handleCenterButtonLeave`

`bindUI`

`_setTimesWrappedFromValue`

`_getAngleFromHandleCenter`

`_calculateDialCenter`

`_handleRingMouseup`

`_handleCenterButtonMouseup`

`_handleHandleMousedown`

`_handleDrag`

`_handleMousedown`

`_handleValuesBeyondMinMax`

`_handleDragStart`

`_handleDragEnd`

`_setNodeToFixedRadius`

`syncUI`

`_setSizes`

`_renderLabel`

`_renderRing`

`_renderMarker`

`_renderCenterButton`

`_renderHandle`

`_setLabelString`

`_setResetString`

`_setTooltipString`

`_onDirectionKey`

`_onLeftRightKey`

`_onLeftRightKeyMeta`

`_incrMinor`

`_decrMinor`

`_incrMajor`

`_decrMajor`

`_setToMax`

`_setToMin`

`_resetDial`

`_getAngleFromValue`

`_getValueFromAngle`

`_afterValueChange`

`_valueToDecimalPlaces`

`_uiSetValue`

`_validateValue`

`getClassName`

`initializer`

`_mapInstance`

`destructor`

`destroy`

`_destroyBox`

`render`

`_defRenderFn`

`renderer`

`hide`

`show`

`focus`

`blur`

`enable`

`disable`

`_uiSizeCB`

`_renderBox`

`_setBB`

`_setCB`

`_defaultBB`

`_defaultCB`

`_setBox`

`_renderUI`

`_renderBoxClassNames`

`_removeLoadingClassNames`

`_bindUI`

`_unbindUI`

`_bindDOM`

`_unbindDOM`

`_syncUI`

`_uiSetHeight`

`_uiSetWidth`

`_uiSetDim`

`_uiSetVisible`

`_uiSetDisabled`

`_uiSetFocused`