For internal use in subclasses.
+ *
+ * @see #currentState
+ */
+ protected function get stateNames():Vector.
+ {
+ return this._stateNames;
+ }
+
+ /**
+ * @private
+ */
+ protected var _currentState:String = STATE_ENABLED;
+
+ /**
+ * The current state of the input.
+ *
+ * For internal use in subclasses.
+ */
+ protected function get currentState():String
+ {
+ return this._currentState;
+ }
+
+ /**
+ * @private
+ */
+ protected function set currentState(value:String):void
+ {
+ if(this._currentState == value)
+ {
+ return;
+ }
+ if(this.stateNames.indexOf(value) < 0)
+ {
+ throw new ArgumentError("Invalid state: " + value + ".");
+ }
+ this._currentState = value;
+ this.invalidate(INVALIDATION_FLAG_STATE);
+ }
+
+ /**
+ * @private
+ */
+ protected var _text:String = "";
+
+ /**
+ * The text displayed by the text input. The text input dispatches
+ * Event.CHANGE when the value of the text
+ * property changes for any reason.
+ *
+ * In the following example, the text input's text is updated:
+ *
+ *
+ * input.text = "Hello World";
+ *
+ * @see #event:change
+ *
+ * @default ""
+ */
+ public function get text():String
+ {
+ return this._text;
+ }
+
+ /**
+ * @private
+ */
+ public function set text(value:String):void
+ {
+ if(!value)
+ {
+ //don't allow null or undefined
+ value = "";
+ }
+ if(this._text == value)
+ {
+ return;
+ }
+ this._text = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ this.dispatchEventWith(Event.CHANGE);
+ }
+
+ /**
+ * The baseline measurement of the text, in pixels.
+ */
+ public function get baseline():Number
+ {
+ if(!this.textEditor)
+ {
+ return 0;
+ }
+ return this.textEditor.y + this.textEditor.baseline;
+ }
+
+ /**
+ * @private
+ */
+ protected var _prompt:String = null;
+
+ /**
+ * The prompt, hint, or description text displayed by the input when the
+ * value of its text is empty.
+ *
+ * In the following example, the text input's prompt is updated:
+ *
+ *
+ * input.prompt = "User Name";
+ *
+ * @default null
+ */
+ public function get prompt():String
+ {
+ return this._prompt;
+ }
+
+ /**
+ * @private
+ */
+ public function set prompt(value:String):void
+ {
+ if(this._prompt == value)
+ {
+ return;
+ }
+ this._prompt = value;
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _typicalText:String;
+
+ /**
+ * The text used to measure the input when the dimensions are not set
+ * explicitly (in addition to using the background skin for measurement).
+ *
+ * In the following example, the text input's typical text is
+ * updated:
+ *
+ *
+ * input.text = "We want to allow the text input to show all of this text";
+ *
+ * @default null
+ */
+ public function get typicalText():String
+ {
+ return this._typicalText;
+ }
+
+ /**
+ * @private
+ */
+ public function set typicalText(value:String):void
+ {
+ if(this._typicalText == value)
+ {
+ return;
+ }
+ this._typicalText = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _maxChars:int = 0;
+
+ /**
+ * The maximum number of characters that may be entered. If 0,
+ * any number of characters may be entered.
+ *
+ * In the following example, the text input's maximum characters is
+ * specified:
+ *
+ *
+ * input.maxChars = 10;
+ *
+ * @default 0
+ */
+ public function get maxChars():int
+ {
+ return this._maxChars;
+ }
+
+ /**
+ * @private
+ */
+ public function set maxChars(value:int):void
+ {
+ if(this._maxChars == value)
+ {
+ return;
+ }
+ this._maxChars = value;
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _restrict:String;
+
+ /**
+ * Limits the set of characters that may be entered.
+ *
+ * In the following example, the text input's allowed characters are
+ * restricted:
+ *
+ *
+ * input.restrict = "0-9";
+ *
+ * @default null
+ */
+ public function get restrict():String
+ {
+ return this._restrict;
+ }
+
+ /**
+ * @private
+ */
+ public function set restrict(value:String):void
+ {
+ if(this._restrict == value)
+ {
+ return;
+ }
+ this._restrict = value;
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _displayAsPassword:Boolean = false;
+
+ /**
+ * Determines if the entered text will be masked so that it cannot be
+ * seen, such as for a password input.
+ *
+ * In the following example, the text input's text is displayed as
+ * a password:
+ *
+ *
+ * input.displayAsPassword = true;
+ *
+ * @default false
+ */
+ public function get displayAsPassword():Boolean
+ {
+ return this._displayAsPassword;
+ }
+
+ /**
+ * @private
+ */
+ public function set displayAsPassword(value:Boolean):void
+ {
+ if(this._displayAsPassword == value)
+ {
+ return;
+ }
+ this._displayAsPassword = value;
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _isEditable:Boolean = true;
+
+ /**
+ * Determines if the text input is editable. If the text input is not
+ * editable, it will still appear enabled.
+ *
+ * In the following example, the text input is not editable:
+ *
+ *
+ * input.isEditable = false;
+ *
+ * @default true
+ */
+ public function get isEditable():Boolean
+ {
+ return this._isEditable;
+ }
+
+ /**
+ * @private
+ */
+ public function set isEditable(value:Boolean):void
+ {
+ if(this._isEditable == value)
+ {
+ return;
+ }
+ this._isEditable = value;
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _textEditorFactory:Function;
+
+ /**
+ * A function used to instantiate the text editor. If null,
+ * FeathersControl.defaultTextEditorFactory is used
+ * instead. The text editor must be an instance of
+ * ITextEditor. This factory can be used to change
+ * properties on the text editor when it is first created. For instance,
+ * if you are skinning Feathers components without a theme, you might
+ * use this factory to set styles on the text editor.
+ *
+ * The factory should have the following function signature:
+ * function():ITextEditor
+ *
+ * In the following example, a custom text editor factory is passed
+ * to the text input:
+ *
+ *
+ * input.textEditorFactory = function():ITextEditor
+ * {
+ * return new TextFieldTextEditor();
+ * };
+ *
+ * @default null
+ *
+ * @see feathers.core.ITextEditor
+ * @see feathers.core.FeathersControl#defaultTextEditorFactory
+ */
+ public function get textEditorFactory():Function
+ {
+ return this._textEditorFactory;
+ }
+
+ /**
+ * @private
+ */
+ public function set textEditorFactory(value:Function):void
+ {
+ if(this._textEditorFactory == value)
+ {
+ return;
+ }
+ this._textEditorFactory = value;
+ this.invalidate(INVALIDATION_FLAG_TEXT_EDITOR);
+ }
+
+ /**
+ * @private
+ */
+ protected var _promptFactory:Function;
+
+ /**
+ * A function used to instantiate the prompt text renderer. If null,
+ * FeathersControl.defaultTextRendererFactory is used
+ * instead. The prompt text renderer must be an instance of
+ * ITextRenderer. This factory can be used to change
+ * properties on the prompt when it is first created. For instance, if
+ * you are skinning Feathers components without a theme, you might use
+ * this factory to set styles on the prompt.
+ *
+ * The factory should have the following function signature:
+ * function():ITextRenderer
+ *
+ * If the prompt property is null, the
+ * prompt text renderer will not be created.
+ *
+ * In the following example, a custom prompt factory is passed to the
+ * text input:
+ *
+ *
+ * input.promptFactory = function():ITextRenderer
+ * {
+ * return new TextFieldTextRenderer();
+ * };
+ *
+ * @default null
+ *
+ * @see #prompt
+ * @see feathers.core.ITextRenderer
+ * @see feathers.core.FeathersControl#defaultTextRendererFactory
+ * @see feathers.controls.text.BitmapFontTextRenderer
+ * @see feathers.controls.text.TextFieldTextRenderer
+ */
+ public function get promptFactory():Function
+ {
+ return this._promptFactory;
+ }
+
+ /**
+ * @private
+ */
+ public function set promptFactory(value:Function):void
+ {
+ if(this._promptFactory == value)
+ {
+ return;
+ }
+ this._promptFactory = value;
+ this.invalidate(INVALIDATION_FLAG_PROMPT_FACTORY);
+ }
+
+ /**
+ * @private
+ */
+ protected var _promptProperties:PropertyProxy;
+
+ /**
+ * A set of key/value pairs to be passed down to the text input's prompt
+ * text renderer. The prompt text renderer is an ITextRenderer
+ * instance that is created by promptFactory. The available
+ * properties depend on which ITextRenderer implementation
+ * is returned by promptFactory. The most common
+ * implementations are BitmapFontTextRenderer and
+ * TextFieldTextRenderer.
+ *
+ * If the subcomponent has its own subcomponents, their properties
+ * can be set too, using attribute @ notation. For example,
+ * to set the skin on the thumb which is in a SimpleScrollBar,
+ * which is in a List, you can use the following syntax:
+ * list.verticalScrollBarProperties.@thumbProperties.defaultSkin = new Image(texture);
+ *
+ * Setting properties in a promptFactory function
+ * instead of using promptProperties will result in
+ * better performance.
+ *
+ * In the following example, the text input's prompt's properties are
+ * updated (this example assumes that the prompt text renderer is a
+ * TextFieldTextRenderer):
+ *
+ *
+ * input.promptProperties.textFormat = new TextFormat( "Source Sans Pro", 16, 0x333333 );
+ * input.promptProperties.embedFonts = true;
+ *
+ * @default null
+ *
+ * @see #prompt
+ * @see #promptFactory
+ * @see feathers.core.ITextRenderer
+ * @see feathers.controls.text.BitmapFontTextRenderer
+ * @see feathers.controls.text.TextFieldTextRenderer
+ */
+ public function get promptProperties():Object
+ {
+ if(!this._promptProperties)
+ {
+ this._promptProperties = new PropertyProxy(childProperties_onChange);
+ }
+ return this._promptProperties;
+ }
+
+ /**
+ * @private
+ */
+ public function set promptProperties(value:Object):void
+ {
+ if(this._promptProperties == value)
+ {
+ return;
+ }
+ if(!value)
+ {
+ value = new PropertyProxy();
+ }
+ if(!(value is PropertyProxy))
+ {
+ var newValue:PropertyProxy = new PropertyProxy();
+ for(var propertyName:String in value)
+ {
+ newValue[propertyName] = value[propertyName];
+ }
+ value = newValue;
+ }
+ if(this._promptProperties)
+ {
+ this._promptProperties.removeOnChangeCallback(childProperties_onChange);
+ }
+ this._promptProperties = PropertyProxy(value);
+ if(this._promptProperties)
+ {
+ this._promptProperties.addOnChangeCallback(childProperties_onChange);
+ }
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ * The width of the first skin that was displayed.
+ */
+ protected var _originalSkinWidth:Number = NaN;
+
+ /**
+ * @private
+ * The height of the first skin that was displayed.
+ */
+ protected var _originalSkinHeight:Number = NaN;
+
+ /**
+ * @private
+ */
+ protected var _skinSelector:StateValueSelector = new StateValueSelector();
+
+ /**
+ * The skin used when no other skin is defined for the current state.
+ * Intended for use when multiple states should use the same skin.
+ *
+ * The following example gives the input a default skin to use for
+ * all states when no specific skin is available:
+ *
+ *
+ * input.backgroundSkin = new Image( texture );
+ *
+ * @default null
+ *
+ * @see #backgroundEnabledSkin
+ * @see #backgroundDisabledSkin
+ * @see #backgroundFocusedSkin
+ */
+ public function get backgroundSkin():DisplayObject
+ {
+ return DisplayObject(this._skinSelector.defaultValue);
+ }
+
+ /**
+ * @private
+ */
+ public function set backgroundSkin(value:DisplayObject):void
+ {
+ if(this._skinSelector.defaultValue == value)
+ {
+ return;
+ }
+ this._skinSelector.defaultValue = value;
+ this.invalidate(INVALIDATION_FLAG_SKIN);
+ }
+
+ /**
+ * The skin used for the input's enabled state. If null,
+ * then backgroundSkin is used instead.
+ *
+ * The following example gives the input a skin for the enabled state:
+ *
+ *
+ * input.backgroundEnabledSkin = new Image( texture );
+ *
+ * @default null
+ *
+ * @see #backgroundSkin
+ * @see #backgroundDisabledSkin
+ */
+ public function get backgroundEnabledSkin():DisplayObject
+ {
+ return DisplayObject(this._skinSelector.getValueForState(STATE_ENABLED));
+ }
+
+ /**
+ * @private
+ */
+ public function set backgroundEnabledSkin(value:DisplayObject):void
+ {
+ if(this._skinSelector.getValueForState(STATE_ENABLED) == value)
+ {
+ return;
+ }
+ this._skinSelector.setValueForState(value, STATE_ENABLED);
+ this.invalidate(INVALIDATION_FLAG_SKIN);
+ }
+
+ /**
+ * The skin used for the input's focused state. If null,
+ * then backgroundSkin is used instead.
+ *
+ * The following example gives the input a skin for the focused state:
+ *
+ *
+ * input.backgroundFocusedSkin = new Image( texture );
+ *
+ * @default null
+ */
+ public function get backgroundFocusedSkin():DisplayObject
+ {
+ return DisplayObject(this._skinSelector.getValueForState(STATE_FOCUSED));
+ }
+
+ /**
+ * @private
+ */
+ public function set backgroundFocusedSkin(value:DisplayObject):void
+ {
+ if(this._skinSelector.getValueForState(STATE_FOCUSED) == value)
+ {
+ return;
+ }
+ this._skinSelector.setValueForState(value, STATE_FOCUSED);
+ this.invalidate(INVALIDATION_FLAG_SKIN);
+ }
+
+ /**
+ * The skin used for the input's disabled state. If null,
+ * then backgroundSkin is used instead.
+ *
+ * The following example gives the input a skin for the disabled state:
+ *
+ *
+ * input.backgroundDisabledSkin = new Image( texture );
+ *
+ * @default null
+ */
+ public function get backgroundDisabledSkin():DisplayObject
+ {
+ return DisplayObject(this._skinSelector.getValueForState(STATE_DISABLED));
+ }
+
+ /**
+ * @private
+ */
+ public function set backgroundDisabledSkin(value:DisplayObject):void
+ {
+ if(this._skinSelector.getValueForState(STATE_DISABLED) == value)
+ {
+ return;
+ }
+ this._skinSelector.setValueForState(value, STATE_DISABLED);
+ this.invalidate(INVALIDATION_FLAG_SKIN);
+ }
+
+ /**
+ * @private
+ */
+ protected var _stateToSkinFunction:Function;
+
+ /**
+ * Returns a skin for the current state.
+ *
+ * The following function signature is expected:
+ * function( target:TextInput, state:Object, oldSkin:DisplayObject = null ):DisplayObject
+ *
+ * @default null
+ */
+ public function get stateToSkinFunction():Function
+ {
+ return this._stateToSkinFunction;
+ }
+
+ /**
+ * @private
+ */
+ public function set stateToSkinFunction(value:Function):void
+ {
+ if(this._stateToSkinFunction == value)
+ {
+ return;
+ }
+ this._stateToSkinFunction = value;
+ this.invalidate(INVALIDATION_FLAG_SKIN);
+ }
+
+ /**
+ * @private
+ */
+ protected var _iconSelector:StateValueSelector = new StateValueSelector();
+
+ /**
+ * The icon used when no other icon is defined for the current state.
+ * Intended for use when multiple states should use the same icon.
+ *
+ * The following example gives the input a default icon to use for
+ * all states when no specific icon is available:
+ *
+ *
+ * input.defaultIcon = new Image( texture );
+ *
+ * @default null
+ *
+ * @see #stateToIconFunction
+ * @see #enabledIcon
+ * @see #disabledIcon
+ * @see #focusedIcon
+ */
+ public function get defaultIcon():DisplayObject
+ {
+ return DisplayObject(this._iconSelector.defaultValue);
+ }
+
+ /**
+ * @private
+ */
+ public function set defaultIcon(value:DisplayObject):void
+ {
+ if(this._iconSelector.defaultValue == value)
+ {
+ return;
+ }
+ this._iconSelector.defaultValue = value;
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * The icon used for the input's enabled state. If null,
+ * then defaultIcon is used instead.
+ *
+ * The following example gives the input an icon for the enabled state:
+ *
+ *
+ * button.enabledIcon = new Image( texture );
+ *
+ * @default null
+ *
+ * @see #defaultIcon
+ * @see #disabledIcon
+ */
+ public function get enabledIcon():DisplayObject
+ {
+ return DisplayObject(this._iconSelector.getValueForState(STATE_ENABLED));
+ }
+
+ /**
+ * @private
+ */
+ public function set enabledIcon(value:DisplayObject):void
+ {
+ if(this._iconSelector.getValueForState(STATE_ENABLED) == value)
+ {
+ return;
+ }
+ this._iconSelector.setValueForState(value, STATE_ENABLED);
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * The icon used for the input's disabled state. If null,
+ * then defaultIcon is used instead.
+ *
+ * The following example gives the input an icon for the disabled state:
+ *
+ *
+ * button.disabledIcon = new Image( texture );
+ *
+ * @default null
+ *
+ * @see #defaultIcon
+ * @see #enabledIcon
+ */
+ public function get disabledIcon():DisplayObject
+ {
+ return DisplayObject(this._iconSelector.getValueForState(STATE_DISABLED));
+ }
+
+ /**
+ * @private
+ */
+ public function set disabledIcon(value:DisplayObject):void
+ {
+ if(this._iconSelector.getValueForState(STATE_DISABLED) == value)
+ {
+ return;
+ }
+ this._iconSelector.setValueForState(value, STATE_DISABLED);
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * The icon used for the input's focused state. If null,
+ * then defaultIcon is used instead.
+ *
+ * The following example gives the input an icon for the focused state:
+ *
+ *
+ * button.focusedIcon = new Image( texture );
+ *
+ * @default null
+ *
+ * @see #defaultIcon
+ * @see #enabledIcon
+ * @see #disabledIcon
+ */
+ public function get focusedIcon():DisplayObject
+ {
+ return DisplayObject(this._iconSelector.getValueForState(STATE_FOCUSED));
+ }
+
+ /**
+ * @private
+ */
+ public function set focusedIcon(value:DisplayObject):void
+ {
+ if(this._iconSelector.getValueForState(STATE_FOCUSED) == value)
+ {
+ return;
+ }
+ this._iconSelector.setValueForState(value, STATE_FOCUSED);
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _stateToIconFunction:Function;
+
+ /**
+ * Returns an icon for the current state.
+ *
+ * The following function signature is expected:
+ * function( target:TextInput, state:Object, oldIcon:DisplayObject = null ):DisplayObject
+ *
+ * @default null
+ */
+ public function get stateToIconFunction():Function
+ {
+ return this._stateToIconFunction;
+ }
+
+ /**
+ * @private
+ */
+ public function set stateToIconFunction(value:Function):void
+ {
+ if(this._stateToIconFunction == value)
+ {
+ return;
+ }
+ this._stateToIconFunction = value;
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _gap:Number = 0;
+
+ /**
+ * The space, in pixels, between the icon and the text editor, if an
+ * icon exists.
+ *
+ * The following example creates a gap of 50 pixels between the icon
+ * and the text editor:
+ *
+ *
+ * button.defaultIcon = new Image( texture );
+ * button.gap = 50;
+ *
+ * @default 0
+ */
+ public function get gap():Number
+ {
+ return this._gap;
+ }
+
+ /**
+ * @private
+ */
+ public function set gap(value:Number):void
+ {
+ if(this._gap == value)
+ {
+ return;
+ }
+ this._gap = value;
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * Quickly sets all padding properties to the same value. The
+ * padding getter always returns the value of
+ * paddingTop, but the other padding values may be
+ * different.
+ *
+ * In the following example, the text input's padding is set to
+ * 20 pixels:
+ *
+ *
+ * input.padding = 20;
+ *
+ * @default 0
+ *
+ * @see #paddingTop
+ * @see #paddingRight
+ * @see #paddingBottom
+ * @see #paddingLeft
+ */
+ public function get padding():Number
+ {
+ return this._paddingTop;
+ }
+
+ /**
+ * @private
+ */
+ public function set padding(value:Number):void
+ {
+ this.paddingTop = value;
+ this.paddingRight = value;
+ this.paddingBottom = value;
+ this.paddingLeft = value;
+ }
+
+ /**
+ * @private
+ */
+ protected var _paddingTop:Number = 0;
+
+ /**
+ * The minimum space, in pixels, between the input's top edge and the
+ * input's content.
+ *
+ * In the following example, the text input's top padding is set to
+ * 20 pixels:
+ *
+ *
+ * input.paddingTop = 20;
+ *
+ * @default 0
+ */
+ public function get paddingTop():Number
+ {
+ return this._paddingTop;
+ }
+
+ /**
+ * @private
+ */
+ public function set paddingTop(value:Number):void
+ {
+ if(this._paddingTop == value)
+ {
+ return;
+ }
+ this._paddingTop = value;
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _paddingRight:Number = 0;
+
+ /**
+ * The minimum space, in pixels, between the input's right edge and the
+ * input's content.
+ *
+ * In the following example, the text input's right padding is set to
+ * 20 pixels:
+ *
+ *
+ * input.paddingRight = 20;
+ *
+ * @default 0
+ */
+ public function get paddingRight():Number
+ {
+ return this._paddingRight;
+ }
+
+ /**
+ * @private
+ */
+ public function set paddingRight(value:Number):void
+ {
+ if(this._paddingRight == value)
+ {
+ return;
+ }
+ this._paddingRight = value;
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _paddingBottom:Number = 0;
+
+ /**
+ * The minimum space, in pixels, between the input's bottom edge and
+ * the input's content.
+ *
+ * In the following example, the text input's bottom padding is set to
+ * 20 pixels:
+ *
+ *
+ * input.paddingBottom = 20;
+ *
+ * @default 0
+ */
+ public function get paddingBottom():Number
+ {
+ return this._paddingBottom;
+ }
+
+ /**
+ * @private
+ */
+ public function set paddingBottom(value:Number):void
+ {
+ if(this._paddingBottom == value)
+ {
+ return;
+ }
+ this._paddingBottom = value;
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _paddingLeft:Number = 0;
+
+ /**
+ * The minimum space, in pixels, between the input's left edge and the
+ * input's content.
+ *
+ * In the following example, the text input's left padding is set to
+ * 20 pixels:
+ *
+ *
+ * input.paddingLeft = 20;
+ *
+ * @default 0
+ */
+ public function get paddingLeft():Number
+ {
+ return this._paddingLeft;
+ }
+
+ /**
+ * @private
+ */
+ public function set paddingLeft(value:Number):void
+ {
+ if(this._paddingLeft == value)
+ {
+ return;
+ }
+ this._paddingLeft = value;
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _verticalAlign:String = VERTICAL_ALIGN_MIDDLE;
+
+ [Inspectable(type="String",enumeration="top,middle,bottom,justify")]
+ /**
+ * The location where the text editor is aligned vertically (on
+ * the y-axis).
+ *
+ * The following example aligns the text editor to the top:
+ *
+ *
+ * input.verticalAlign = TextInput.VERTICAL_ALIGN_TOP;
+ *
+ * @default TextInput.VERTICAL_ALIGN_MIDDLE
+ *
+ * @see #VERTICAL_ALIGN_TOP
+ * @see #VERTICAL_ALIGN_MIDDLE
+ * @see #VERTICAL_ALIGN_BOTTOM
+ * @see #VERTICAL_ALIGN_JUSTIFY
+ */
+ public function get verticalAlign():String
+ {
+ return _verticalAlign;
+ }
+
+ /**
+ * @private
+ */
+ public function set verticalAlign(value:String):void
+ {
+ if(this._verticalAlign == value)
+ {
+ return;
+ }
+ this._verticalAlign = value;
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ * Flag indicating that the text editor should get focus after it is
+ * created.
+ */
+ protected var _isWaitingToSetFocus:Boolean = false;
+
+ /**
+ * @private
+ */
+ protected var _pendingSelectionBeginIndex:int = -1;
+
+ /**
+ * @private
+ */
+ protected var _pendingSelectionEndIndex:int = -1;
+
+ /**
+ * @private
+ */
+ protected var _oldMouseCursor:String = null;
+
+ /**
+ * @private
+ */
+ protected var _textEditorProperties:PropertyProxy;
+
+ /**
+ * A set of key/value pairs to be passed down to the text input's
+ * text editor. The text editor is an ITextEditor instance
+ * that is created by textEditorFactory.
+ *
+ * If the subcomponent has its own subcomponents, their properties
+ * can be set too, using attribute @ notation. For example,
+ * to set the skin on the thumb which is in a SimpleScrollBar,
+ * which is in a List, you can use the following syntax:
+ * list.verticalScrollBarProperties.@thumbProperties.defaultSkin = new Image(texture);
+ *
+ * Setting properties in a textEditorFactory function
+ * instead of using textEditorProperties will result in
+ * better performance.
+ *
+ * In the following example, the text input's text editor properties
+ * are specified (this example assumes that the text editor is a
+ * StageTextTextEditor):
+ *
+ *
+ * input.textEditorProperties.fontName = "Helvetica";
+ * input.textEditorProperties.fontSize = 16;
+ *
+ * @default null
+ *
+ * @see #textEditorFactory
+ * @see feathers.core.ITextEditor
+ */
+ public function get textEditorProperties():Object
+ {
+ if(!this._textEditorProperties)
+ {
+ this._textEditorProperties = new PropertyProxy(childProperties_onChange);
+ }
+ return this._textEditorProperties;
+ }
+
+ /**
+ * @private
+ */
+ public function set textEditorProperties(value:Object):void
+ {
+ if(this._textEditorProperties == value)
+ {
+ return;
+ }
+ if(!value)
+ {
+ value = new PropertyProxy();
+ }
+ if(!(value is PropertyProxy))
+ {
+ var newValue:PropertyProxy = new PropertyProxy();
+ for(var propertyName:String in value)
+ {
+ newValue[propertyName] = value[propertyName];
+ }
+ value = newValue;
+ }
+ if(this._textEditorProperties)
+ {
+ this._textEditorProperties.removeOnChangeCallback(childProperties_onChange);
+ }
+ this._textEditorProperties = PropertyProxy(value);
+ if(this._textEditorProperties)
+ {
+ this._textEditorProperties.addOnChangeCallback(childProperties_onChange);
+ }
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @copy feathers.core.ITextEditor#selectionBeginIndex
+ */
+ public function get selectionBeginIndex():int
+ {
+ if(this._pendingSelectionBeginIndex >= 0)
+ {
+ return this._pendingSelectionBeginIndex;
+ }
+ if(this.textEditor)
+ {
+ return this.textEditor.selectionBeginIndex;
+ }
+ return 0;
+ }
+
+ /**
+ * @copy feathers.core.ITextEditor#selectionEndIndex
+ */
+ public function get selectionEndIndex():int
+ {
+ if(this._pendingSelectionEndIndex >= 0)
+ {
+ return this._pendingSelectionEndIndex;
+ }
+ if(this.textEditor)
+ {
+ return this.textEditor.selectionEndIndex;
+ }
+ return 0;
+ }
+
+ /**
+ * @private
+ */
+ override public function set visible(value:Boolean):void
+ {
+ if(!value)
+ {
+ this._isWaitingToSetFocus = false;
+ if(this._textEditorHasFocus)
+ {
+ this.textEditor.clearFocus();
+ }
+ }
+ super.visible = value;
+ }
+
+ /**
+ * @private
+ */
+ override public function hitTest(localPoint:Point, forTouch:Boolean = false):DisplayObject
+ {
+ if(forTouch && (!this.visible || !this.touchable))
+ {
+ return null;
+ }
+ var clipRect:Rectangle = this.clipRect;
+ if(clipRect && !clipRect.containsPoint(localPoint))
+ {
+ return null;
+ }
+ return this._hitArea.containsPoint(localPoint) ? DisplayObject(this.textEditor) : null;
+ }
+
+ /**
+ * @inheritDoc
+ */
+ override public function showFocus():void
+ {
+ if(!this._focusManager || this._focusManager.focus != this)
+ {
+ return;
+ }
+ this.selectRange(0, this._text.length);
+ super.showFocus();
+ }
+
+ /**
+ * Focuses the text input control so that it may be edited.
+ */
+ public function setFocus():void
+ {
+ //if the text editor has focus, no need to set focus
+ //if this is invisible, it wouldn't make sense to set focus
+ //if there's a touch point ID, we'll be setting focus on our own
+ if(this._textEditorHasFocus || !this.visible || this._touchPointID >= 0)
+ {
+ return;
+ }
+ if(this.textEditor)
+ {
+ this._isWaitingToSetFocus = false;
+ this.textEditor.setFocus();
+ }
+ else
+ {
+ this._isWaitingToSetFocus = true;
+ this.invalidate(INVALIDATION_FLAG_SELECTED);
+ }
+ }
+
+ /**
+ * Manually removes focus from the text input control.
+ */
+ public function clearFocus():void
+ {
+ this._isWaitingToSetFocus = false;
+ if(!this.textEditor || !this._textEditorHasFocus)
+ {
+ return;
+ }
+ this.textEditor.clearFocus();
+ }
+
+ /**
+ * Sets the range of selected characters. If both values are the same,
+ * or the end index is -1, the text insertion position is
+ * changed and nothing is selected.
+ */
+ public function selectRange(beginIndex:int, endIndex:int = -1):void
+ {
+ if(endIndex < 0)
+ {
+ endIndex = beginIndex;
+ }
+ if(beginIndex < 0)
+ {
+ throw new RangeError("Expected start index >= 0. Received " + beginIndex + ".");
+ }
+ if(endIndex > this._text.length)
+ {
+ throw new RangeError("Expected end index <= " + this._text.length + ". Received " + endIndex + ".");
+ }
+
+ //if it's invalid, we need to wait until validation before changing
+ //the selection
+ if(this.textEditor && (this._isValidating || !this.isInvalid()))
+ {
+ this._pendingSelectionBeginIndex = -1;
+ this._pendingSelectionEndIndex = -1;
+ this.textEditor.selectRange(beginIndex, endIndex);
+ }
+ else
+ {
+ this._pendingSelectionBeginIndex = beginIndex;
+ this._pendingSelectionEndIndex = endIndex;
+ this.invalidate(INVALIDATION_FLAG_SELECTED);
+ }
+ }
+
+ /**
+ * @private
+ */
+ override protected function draw():void
+ {
+ var stateInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_STATE);
+ var stylesInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_STYLES);
+ var dataInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_DATA);
+ var skinInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_SKIN);
+ var sizeInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_SIZE);
+ var textEditorInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_TEXT_EDITOR);
+ var promptFactoryInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_PROMPT_FACTORY);
+ var focusInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_FOCUS);
+
+ if(textEditorInvalid)
+ {
+ this.createTextEditor();
+ }
+
+ if(promptFactoryInvalid || (this._prompt !== null && !this.promptTextRenderer))
+ {
+ this.createPrompt();
+ }
+
+ if(textEditorInvalid || stylesInvalid)
+ {
+ this.refreshTextEditorProperties();
+ }
+
+ if(promptFactoryInvalid || stylesInvalid)
+ {
+ this.refreshPromptProperties();
+ }
+
+ if(textEditorInvalid || dataInvalid)
+ {
+ var oldIgnoreTextChanges:Boolean = this._ignoreTextChanges;
+ this._ignoreTextChanges = true;
+ this.textEditor.text = this._text;
+ this._ignoreTextChanges = oldIgnoreTextChanges;
+ }
+
+ if(this.promptTextRenderer)
+ {
+ if(promptFactoryInvalid || dataInvalid || stylesInvalid)
+ {
+ this.promptTextRenderer.visible = this._prompt && this._text.length == 0;
+ }
+
+ if(promptFactoryInvalid || stateInvalid)
+ {
+ this.promptTextRenderer.isEnabled = this._isEnabled;
+ }
+ }
+
+ if(textEditorInvalid || stateInvalid)
+ {
+ this.textEditor.isEnabled = this._isEnabled;
+ if(!this._isEnabled && Mouse.supportsNativeCursor && this._oldMouseCursor)
+ {
+ Mouse.cursor = this._oldMouseCursor;
+ this._oldMouseCursor = null;
+ }
+ }
+
+ if(stateInvalid || skinInvalid)
+ {
+ this.refreshBackgroundSkin();
+ }
+ if(stateInvalid || stylesInvalid)
+ {
+ this.refreshIcon();
+ }
+
+ sizeInvalid = this.autoSizeIfNeeded() || sizeInvalid;
+
+ this.layoutChildren();
+
+ if(sizeInvalid || focusInvalid)
+ {
+ this.refreshFocusIndicator();
+ }
+
+ this.doPendingActions();
+ }
+
+ /**
+ * If the component's dimensions have not been set explicitly, it will
+ * measure its content and determine an ideal size for itself. If the
+ * explicitWidth or explicitHeight member
+ * variables are set, those value will be used without additional
+ * measurement. If one is set, but not the other, the dimension with the
+ * explicit value will not be measured, but the other non-explicit
+ * dimension will still need measurement.
+ *
+ * Calls setSizeInternal() to set up the
+ * actualWidth and actualHeight member
+ * variables used for layout.
+ *
+ * Meant for internal use, and subclasses may override this function
+ * with a custom implementation.
+ */
+ protected function autoSizeIfNeeded():Boolean
+ {
+ var needsWidth:Boolean = this.explicitWidth !== this.explicitWidth; //isNaN
+ var needsHeight:Boolean = this.explicitHeight !== this.explicitHeight; //isNaN
+ if(!needsWidth && !needsHeight)
+ {
+ return false;
+ }
+
+ var typicalTextWidth:Number = 0;
+ var typicalTextHeight:Number = 0;
+ if(this._typicalText)
+ {
+ var oldTextEditorWidth:Number = this.textEditor.width;
+ var oldTextEditorHeight:Number = this.textEditor.height;
+ var oldIgnoreTextChanges:Boolean = this._ignoreTextChanges;
+ this._ignoreTextChanges = true;
+ this.textEditor.setSize(NaN, NaN);
+ this.textEditor.text = this._typicalText;
+ this.textEditor.measureText(HELPER_POINT);
+ this.textEditor.text = this._text;
+ this._ignoreTextChanges = oldIgnoreTextChanges;
+ typicalTextWidth = HELPER_POINT.x;
+ typicalTextHeight = HELPER_POINT.y;
+ }
+ if(this._prompt !== null)
+ {
+ this.promptTextRenderer.setSize(NaN, NaN);
+ this.promptTextRenderer.measureText(HELPER_POINT);
+ typicalTextWidth = Math.max(typicalTextWidth, HELPER_POINT.x);
+ typicalTextHeight = Math.max(typicalTextHeight, HELPER_POINT.y);
+ }
+
+ var newWidth:Number = this.explicitWidth;
+ var newHeight:Number = this.explicitHeight;
+ if(needsWidth)
+ {
+ newWidth = Math.max(this._originalSkinWidth, typicalTextWidth + this._paddingLeft + this._paddingRight);
+ if(newWidth !== newWidth) //isNaN
+ {
+ newWidth = 0;
+ }
+ }
+ if(needsHeight)
+ {
+ newHeight = Math.max(this._originalSkinHeight, typicalTextHeight + this._paddingTop + this._paddingBottom);
+ if(newHeight !== newHeight) //isNaN
+ {
+ newHeight = 0;
+ }
+ }
+
+ var isMultiline:Boolean = this.textEditor is IMultilineTextEditor && IMultilineTextEditor(this.textEditor).multiline;
+ if(this._typicalText && (this._verticalAlign == VERTICAL_ALIGN_JUSTIFY || isMultiline))
+ {
+ this.textEditor.width = oldTextEditorWidth;
+ this.textEditor.height = oldTextEditorHeight;
+ }
+
+ return this.setSizeInternal(newWidth, newHeight, false);
+ }
+
+ /**
+ * Creates and adds the textEditor sub-component and
+ * removes the old instance, if one exists.
+ *
+ * Meant for internal use, and subclasses may override this function
+ * with a custom implementation.
+ *
+ * @see #textEditor
+ * @see #textEditorFactory
+ */
+ protected function createTextEditor():void
+ {
+ if(this.textEditor)
+ {
+ this.removeChild(DisplayObject(this.textEditor), true);
+ this.textEditor.removeEventListener(Event.CHANGE, textEditor_changeHandler);
+ this.textEditor.removeEventListener(FeathersEventType.ENTER, textEditor_enterHandler);
+ this.textEditor.removeEventListener(FeathersEventType.FOCUS_IN, textEditor_focusInHandler);
+ this.textEditor.removeEventListener(FeathersEventType.FOCUS_OUT, textEditor_focusOutHandler);
+ this.textEditor = null;
+ }
+
+ var factory:Function = this._textEditorFactory != null ? this._textEditorFactory : FeathersControl.defaultTextEditorFactory;
+ this.textEditor = ITextEditor(factory());
+ this.textEditor.addEventListener(Event.CHANGE, textEditor_changeHandler);
+ this.textEditor.addEventListener(FeathersEventType.ENTER, textEditor_enterHandler);
+ this.textEditor.addEventListener(FeathersEventType.FOCUS_IN, textEditor_focusInHandler);
+ this.textEditor.addEventListener(FeathersEventType.FOCUS_OUT, textEditor_focusOutHandler);
+ this.addChild(DisplayObject(this.textEditor));
+ }
+
+ /**
+ * @private
+ */
+ protected function createPrompt():void
+ {
+ if(this.promptTextRenderer)
+ {
+ this.removeChild(DisplayObject(this.promptTextRenderer), true);
+ this.promptTextRenderer = null;
+ }
+
+ if(this._prompt === null)
+ {
+ return;
+ }
+
+ var factory:Function = this._promptFactory != null ? this._promptFactory : FeathersControl.defaultTextRendererFactory;
+ this.promptTextRenderer = ITextRenderer(factory());
+ this.addChild(DisplayObject(this.promptTextRenderer));
+ }
+
+ /**
+ * @private
+ */
+ protected function doPendingActions():void
+ {
+ if(this._isWaitingToSetFocus)
+ {
+ this._isWaitingToSetFocus = false;
+ if(!this._textEditorHasFocus)
+ {
+ this.textEditor.setFocus();
+ }
+ }
+ if(this._pendingSelectionBeginIndex >= 0)
+ {
+ var startIndex:int = this._pendingSelectionBeginIndex;
+ var endIndex:int = this._pendingSelectionEndIndex;
+ this._pendingSelectionBeginIndex = -1;
+ this._pendingSelectionEndIndex = -1;
+ if(endIndex >= 0)
+ {
+ var textLength:int = this._text.length;
+ if(endIndex > textLength)
+ {
+ endIndex = textLength;
+ }
+ }
+ this.selectRange(startIndex, endIndex);
+ }
+ }
+
+ /**
+ * @private
+ */
+ protected function refreshTextEditorProperties():void
+ {
+ this.textEditor.displayAsPassword = this._displayAsPassword;
+ this.textEditor.maxChars = this._maxChars;
+ this.textEditor.restrict = this._restrict;
+ this.textEditor.isEditable = this._isEditable;
+ for(var propertyName:String in this._textEditorProperties)
+ {
+ var propertyValue:Object = this._textEditorProperties[propertyName];
+ this.textEditor[propertyName] = propertyValue;
+ }
+ }
+
+ /**
+ * @private
+ */
+ protected function refreshPromptProperties():void
+ {
+ if(!this.promptTextRenderer)
+ {
+ return;
+ }
+ this.promptTextRenderer.text = this._prompt;
+ var displayPrompt:DisplayObject = DisplayObject(this.promptTextRenderer);
+ for(var propertyName:String in this._promptProperties)
+ {
+ var propertyValue:Object = this._promptProperties[propertyName];
+ this.promptTextRenderer[propertyName] = propertyValue;
+ }
+ }
+
+ /**
+ * Sets the currentBackground property.
+ *
+ * For internal use in subclasses.
+ */
+ protected function refreshBackgroundSkin():void
+ {
+ var oldSkin:DisplayObject = this.currentBackground;
+ if(this._stateToSkinFunction != null)
+ {
+ this.currentBackground = DisplayObject(this._stateToSkinFunction(this, this._currentState, oldSkin));
+ }
+ else
+ {
+ this.currentBackground = DisplayObject(this._skinSelector.updateValue(this, this._currentState, this.currentBackground));
+ }
+ if(this.currentBackground != oldSkin)
+ {
+ if(oldSkin)
+ {
+ this.removeChild(oldSkin, false);
+ }
+ if(this.currentBackground)
+ {
+ this.addChildAt(this.currentBackground, 0);
+ }
+ }
+ if(this.currentBackground &&
+ (this._originalSkinWidth !== this._originalSkinWidth || //isNaN
+ this._originalSkinHeight !== this._originalSkinHeight)) //isNaN
+ {
+ if(this.currentBackground is IValidating)
+ {
+ IValidating(this.currentBackground).validate();
+ }
+ this._originalSkinWidth = this.currentBackground.width;
+ this._originalSkinHeight = this.currentBackground.height;
+ }
+ }
+
+ /**
+ * Sets the currentIcon property.
+ *
+ * For internal use in subclasses.
+ */
+ protected function refreshIcon():void
+ {
+ var oldIcon:DisplayObject = this.currentIcon;
+ if(this._stateToIconFunction != null)
+ {
+ this.currentIcon = DisplayObject(this._stateToIconFunction(this, this._currentState, oldIcon));
+ }
+ else
+ {
+ this.currentIcon = DisplayObject(this._iconSelector.updateValue(this, this._currentState, this.currentIcon));
+ }
+ if(this.currentIcon is IFeathersControl)
+ {
+ IFeathersControl(this.currentIcon).isEnabled = this._isEnabled;
+ }
+ if(this.currentIcon != oldIcon)
+ {
+ if(oldIcon)
+ {
+ this.removeChild(oldIcon, false);
+ }
+ if(this.currentIcon)
+ {
+ //we want the icon to appear below the text editor
+ var index:int = this.getChildIndex(DisplayObject(this.textEditor));
+ this.addChildAt(this.currentIcon, index);
+ }
+ }
+ }
+
+ /**
+ * Positions and sizes the text input's children.
+ *
+ * For internal use in subclasses.
+ */
+ protected function layoutChildren():void
+ {
+ if(this.currentBackground)
+ {
+ this.currentBackground.visible = true;
+ this.currentBackground.touchable = true;
+ this.currentBackground.width = this.actualWidth;
+ this.currentBackground.height = this.actualHeight;
+ }
+
+ if(this.currentIcon is IValidating)
+ {
+ IValidating(this.currentIcon).validate();
+ }
+
+ if(this.currentIcon)
+ {
+ this.currentIcon.x = this._paddingLeft;
+ this.textEditor.x = this.currentIcon.x + this.currentIcon.width + this._gap;
+ if(this.promptTextRenderer)
+ {
+ this.promptTextRenderer.x = this.currentIcon.x + this.currentIcon.width + this._gap;
+ }
+ }
+ else
+ {
+ this.textEditor.x = this._paddingLeft;
+ if(this.promptTextRenderer)
+ {
+ this.promptTextRenderer.x = this._paddingLeft;
+ }
+ }
+ this.textEditor.width = this.actualWidth - this._paddingRight - this.textEditor.x;
+ if(this.promptTextRenderer)
+ {
+ this.promptTextRenderer.width = this.actualWidth - this._paddingRight - this.promptTextRenderer.x;
+ }
+
+ var isMultiline:Boolean = this.textEditor is IMultilineTextEditor && IMultilineTextEditor(this.textEditor).multiline;
+ if(isMultiline || this._verticalAlign == VERTICAL_ALIGN_JUSTIFY)
+ {
+ //multiline is treated the same as justify
+ this.textEditor.height = this.actualHeight - this._paddingTop - this._paddingBottom;
+ }
+ else
+ {
+ //clear the height and auto-size instead
+ this.textEditor.height = NaN;
+ }
+ this.textEditor.validate();
+ if(this.promptTextRenderer)
+ {
+ this.promptTextRenderer.validate();
+ }
+
+ var biggerHeight:Number = this.textEditor.height;
+ var biggerBaseline:Number = this.textEditor.baseline;
+ if(this.promptTextRenderer)
+ {
+ var promptBaseline:Number = this.promptTextRenderer.baseline;
+ var promptHeight:Number = this.promptTextRenderer.height;
+ if(promptBaseline > biggerBaseline)
+ {
+ biggerBaseline = promptBaseline;
+ }
+ if(promptHeight > biggerHeight)
+ {
+ biggerHeight = promptHeight;
+ }
+ }
+
+ if(isMultiline)
+ {
+ this.textEditor.y = this._paddingTop + biggerBaseline - this.textEditor.baseline;
+ if(this.promptTextRenderer)
+ {
+ this.promptTextRenderer.y = this._paddingTop + biggerBaseline - promptBaseline;
+ this.promptTextRenderer.height = this.actualHeight - this.promptTextRenderer.y - this._paddingBottom;
+ }
+ if(this.currentIcon)
+ {
+ this.currentIcon.y = this._paddingTop;
+ }
+ }
+ else
+ {
+ switch(this._verticalAlign)
+ {
+ case VERTICAL_ALIGN_JUSTIFY:
+ {
+ this.textEditor.y = this._paddingTop + biggerBaseline - this.textEditor.baseline;
+ if(this.promptTextRenderer)
+ {
+ this.promptTextRenderer.y = this._paddingTop + biggerBaseline - promptBaseline;
+ this.promptTextRenderer.height = this.actualHeight - this.promptTextRenderer.y - this._paddingBottom;
+ }
+ if(this.currentIcon)
+ {
+ this.currentIcon.y = this._paddingTop;
+ }
+ break;
+ }
+ case VERTICAL_ALIGN_TOP:
+ {
+ this.textEditor.y = this._paddingTop + biggerBaseline - this.textEditor.baseline;
+ if(this.promptTextRenderer)
+ {
+ this.promptTextRenderer.y = this._paddingTop + biggerBaseline - promptBaseline;
+ }
+ if(this.currentIcon)
+ {
+ this.currentIcon.y = this._paddingTop;
+ }
+ break;
+ }
+ case VERTICAL_ALIGN_BOTTOM:
+ {
+ this.textEditor.y = this.actualHeight - this._paddingBottom - biggerHeight + biggerBaseline - this.textEditor.baseline;
+ if(this.promptTextRenderer)
+ {
+ this.promptTextRenderer.y = this.actualHeight - this._paddingBottom - biggerHeight + biggerBaseline - promptBaseline;
+ }
+ if(this.currentIcon)
+ {
+ this.currentIcon.y = this.actualHeight - this._paddingBottom - this.currentIcon.height;
+ }
+ break;
+ }
+ default: //middle
+ {
+ this.textEditor.y = biggerBaseline - this.textEditor.baseline + this._paddingTop + (this.actualHeight - this._paddingTop - this._paddingBottom - biggerHeight) / 2;
+ if(this.promptTextRenderer)
+ {
+ this.promptTextRenderer.y = biggerBaseline - promptBaseline + this._paddingTop + (this.actualHeight - this._paddingTop - this._paddingBottom - biggerHeight) / 2;
+ }
+ if(this.currentIcon)
+ {
+ this.currentIcon.y = this._paddingTop + (this.actualHeight - this._paddingTop - this._paddingBottom - this.currentIcon.height) / 2;
+ }
+ }
+ }
+ }
+ }
+
+ /**
+ * @private
+ */
+ protected function setFocusOnTextEditorWithTouch(touch:Touch):void
+ {
+ if(!this.isFocusEnabled)
+ {
+ return;
+ }
+ touch.getLocation(this.stage, HELPER_POINT);
+ var isInBounds:Boolean = this.contains(this.stage.hitTest(HELPER_POINT, true));
+ if(isInBounds && !this._textEditorHasFocus)
+ {
+ this.textEditor.globalToLocal(HELPER_POINT, HELPER_POINT);
+ this._isWaitingToSetFocus = false;
+ this.textEditor.setFocus(HELPER_POINT);
+ }
+ }
+
+ /**
+ * @private
+ */
+ protected function childProperties_onChange(proxy:PropertyProxy, name:Object):void
+ {
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected function textInput_removedFromStageHandler(event:Event):void
+ {
+ if(!this._focusManager && this._textEditorHasFocus)
+ {
+ this.clearFocus();
+ }
+ this._textEditorHasFocus = false;
+ this._isWaitingToSetFocus = false;
+ this._touchPointID = -1;
+ if(Mouse.supportsNativeCursor && this._oldMouseCursor)
+ {
+ Mouse.cursor = this._oldMouseCursor;
+ this._oldMouseCursor = null;
+ }
+ }
+
+ /**
+ * @private
+ */
+ protected function textInput_touchHandler(event:TouchEvent):void
+ {
+ if(!this._isEnabled || !this._isEditable)
+ {
+ this._touchPointID = -1;
+ return;
+ }
+
+ if(this._touchPointID >= 0)
+ {
+ var touch:Touch = event.getTouch(this, TouchPhase.ENDED, this._touchPointID);
+ if(!touch)
+ {
+ return;
+ }
+ this._touchPointID = -1;
+ if(this.textEditor.setTouchFocusOnEndedPhase)
+ {
+ this.setFocusOnTextEditorWithTouch(touch);
+ }
+ }
+ else
+ {
+ touch = event.getTouch(this, TouchPhase.BEGAN);
+ if(touch)
+ {
+ this._touchPointID = touch.id;
+ if(!this.textEditor.setTouchFocusOnEndedPhase)
+ {
+ this.setFocusOnTextEditorWithTouch(touch);
+ }
+ return;
+ }
+ touch = event.getTouch(this, TouchPhase.HOVER);
+ if(touch)
+ {
+ if(Mouse.supportsNativeCursor && !this._oldMouseCursor)
+ {
+ this._oldMouseCursor = Mouse.cursor;
+ Mouse.cursor = MouseCursor.IBEAM;
+ }
+ return;
+ }
+
+ //end hover
+ if(Mouse.supportsNativeCursor && this._oldMouseCursor)
+ {
+ Mouse.cursor = this._oldMouseCursor;
+ this._oldMouseCursor = null;
+ }
+ }
+ }
+
+ /**
+ * @private
+ */
+ override protected function focusInHandler(event:Event):void
+ {
+ if(!this._focusManager)
+ {
+ return;
+ }
+ super.focusInHandler(event);
+ this.setFocus();
+ }
+
+ /**
+ * @private
+ */
+ override protected function focusOutHandler(event:Event):void
+ {
+ if(!this._focusManager)
+ {
+ return;
+ }
+ super.focusOutHandler(event);
+ this.textEditor.clearFocus();
+ }
+
+ /**
+ * @private
+ */
+ protected function textEditor_changeHandler(event:Event):void
+ {
+ if(this._ignoreTextChanges)
+ {
+ return;
+ }
+ this.text = this.textEditor.text;
+ }
+
+ /**
+ * @private
+ */
+ protected function textEditor_enterHandler(event:Event):void
+ {
+ this.dispatchEventWith(FeathersEventType.ENTER);
+ }
+
+ /**
+ * @private
+ */
+ protected function textEditor_focusInHandler(event:Event):void
+ {
+ if(!this.visible)
+ {
+ this.textEditor.clearFocus();
+ return;
+ }
+ this._textEditorHasFocus = true;
+ this.currentState = STATE_FOCUSED;
+ if(this._focusManager && this._isFocusEnabled)
+ {
+ this._focusManager.focus = this;
+ }
+ else
+ {
+ this.dispatchEventWith(FeathersEventType.FOCUS_IN);
+ }
+ }
+
+ /**
+ * @private
+ */
+ protected function textEditor_focusOutHandler(event:Event):void
+ {
+ this._textEditorHasFocus = false;
+ this.currentState = this._isEnabled ? STATE_ENABLED : STATE_DISABLED;
+ if(this._focusManager && this._isFocusEnabled)
+ {
+ if(this._focusManager.focus == this)
+ {
+ this._focusManager.focus = null;
+ }
+ }
+ else
+ {
+ this.dispatchEventWith(FeathersEventType.FOCUS_OUT);
+ }
+ }
+ }
+}
diff --git a/source/feathers/controls/ToggleButton.as b/source/feathers/controls/ToggleButton.as
new file mode 100644
index 0000000000..10ed9d3dcf
--- /dev/null
+++ b/source/feathers/controls/ToggleButton.as
@@ -0,0 +1,862 @@
+/*
+Feathers
+Copyright 2012-2014 Joshua Tynjala. All Rights Reserved.
+
+This program is free software. You can redistribute and/or modify it in
+accordance with the terms of the accompanying license agreement.
+*/
+package feathers.controls
+{
+ import feathers.core.IToggle;
+ import feathers.core.PropertyProxy;
+ import feathers.skins.IStyleProvider;
+
+ import starling.display.DisplayObject;
+ import starling.events.Event;
+
+ /**
+ * Dispatched when the button is selected or deselected either
+ * programmatically or as a result of user interaction. The value of the
+ * isSelected property indicates whether the button is selected
+ * or not. Use interaction may only change selection when the
+ * isToggle property is set to true.
+ *
+ * The properties of the event object have the following values:
+ *
+ * | Property | Value |
|---|
+ * bubbles | false |
+ * currentTarget | The Object that defines the
+ * event listener that handles the event. For example, if you use
+ * myButton.addEventListener() to register an event listener,
+ * myButton is the value of the currentTarget. |
+ * data | null |
+ * target | The Object that dispatched the event;
+ * it is not always the Object listening for the event. Use the
+ * currentTarget property to always access the Object
+ * listening for the event. |
+ *
+ *
+ * @eventType starling.events.Event.CHANGE
+ *
+ * @see #isSelected
+ * @see #isToggle
+ */
+ [Event(name="change",type="starling.events.Event")]
+
+ /**
+ * A button that may be selected and deselected when triggered.
+ *
+ * The following example creates a toggle button, and listens for when
+ * its selection changes:
+ *
+ *
+ * var button:ToggleButton = new ToggleButton();
+ * button.label = "Click Me";
+ * button.addEventListener( Event.CHANGE, button_changeHandler );
+ * this.addChild( button );
+ *
+ * @see ../../../help/toggle-button.html How to use the Feathers ToggleButton component
+ */
+ public class ToggleButton extends Button implements IToggle
+ {
+ /**
+ * The default IStyleProvider for all ToggleButton
+ * components. If null, falls back to using
+ * Button.globalStyleProvider instead.
+ *
+ * @default null
+ * @see feathers.core.FeathersControl#styleProvider
+ * @see feathers.controls.Button#globalStyleProvider
+ */
+ public static var globalStyleProvider:IStyleProvider;
+
+ /**
+ * Constructor.
+ */
+ public function ToggleButton()
+ {
+ super();
+ }
+
+ /**
+ * @private
+ */
+ override protected function get defaultStyleProvider():IStyleProvider
+ {
+ if(ToggleButton.globalStyleProvider)
+ {
+ return ToggleButton.globalStyleProvider;
+ }
+ return Button.globalStyleProvider;
+ }
+
+ /**
+ * @private
+ */
+ protected var _isToggle:Boolean = true;
+
+ /**
+ * Determines if the button may be selected or deselected as a result of
+ * user interaction. If true, the value of the
+ * isSelected property will be toggled when the button is
+ * triggered.
+ *
+ * The following example disables the ability to toggle:
+ *
+ *
+ * button.isToggle = false;
+ *
+ * @default true
+ *
+ * @see #isSelected
+ * @see #event:triggered Event.TRIGGERED
+ */
+ public function get isToggle():Boolean
+ {
+ return this._isToggle;
+ }
+
+ /**
+ * @private
+ */
+ public function set isToggle(value:Boolean):void
+ {
+ this._isToggle = value;
+ }
+
+ /**
+ * @private
+ */
+ protected var _isSelected:Boolean = false;
+
+ /**
+ * Indicates if the button is selected or not. The button may be
+ * selected programmatically, even if isToggle is false,
+ * but generally, isToggle should be set to true
+ * to allow the user to select and deselect it by triggering the button
+ * with a click or tap. If focus management is enabled, a button may
+ * also be triggered with the spacebar when the button has focus.
+ *
+ * The following example enables the button to toggle and selects it
+ * automatically:
+ *
+ *
+ * button.isToggle = true;
+ * button.isSelected = true;
+ *
+ * @default false
+ *
+ * @see #event:change Event.CHANGE
+ * @see #isToggle
+ */
+ public function get isSelected():Boolean
+ {
+ return this._isSelected;
+ }
+
+ /**
+ * @private
+ */
+ public function set isSelected(value:Boolean):void
+ {
+ if(this._isSelected == value)
+ {
+ return;
+ }
+ this._isSelected = value;
+ this.invalidate(INVALIDATION_FLAG_SELECTED);
+ this.invalidate(INVALIDATION_FLAG_STATE);
+ this.dispatchEventWith(Event.CHANGE);
+ }
+
+ /**
+ * The skin used when no other skin is defined for the current state
+ * when the button is selected. Has a higher priority than
+ * defaultSkin, but a lower priority than other selected
+ * skins.
+ *
+ * This property will be ignored if a function is passed to the
+ * stateToSkinFunction property.
+ *
+ * The following example gives the button a default skin to use for
+ * all selected states when no specific skin is available:
+ *
+ *
+ * button.defaultSelectedSkin = new Image( texture );
+ *
+ * @default null
+ *
+ * @see #defaultSkin
+ * @see #selectedUpSkin
+ * @see #selectedDownSkin
+ * @see #selectedHoverSkin
+ * @see #selectedDisabledSkin
+ */
+ public function get defaultSelectedSkin():DisplayObject
+ {
+ return DisplayObject(this._skinSelector.defaultSelectedValue);
+ }
+
+ /**
+ * @private
+ */
+ public function set defaultSelectedSkin(value:DisplayObject):void
+ {
+ if(this._skinSelector.defaultSelectedValue == value)
+ {
+ return;
+ }
+ this._skinSelector.defaultSelectedValue = value;
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * The skin used for the button's up state when the button is selected.
+ * If null, then defaultSelectedSkin is used
+ * instead. If defaultSelectedSkin is also
+ * null, then defaultSkin is used.
+ *
+ * This property will be ignored if a function is passed to the
+ * stateToSkinFunction property.
+ *
+ * The following example gives the button a skin for the selected up state:
+ *
+ *
+ * button.selectedUpSkin = new Image( texture );
+ *
+ * @default null
+ *
+ * @see #defaultSkin
+ * @see #defaultSelectedSkin
+ */
+ public function get selectedUpSkin():DisplayObject
+ {
+ return DisplayObject(this._skinSelector.getValueForState(STATE_UP, true));
+ }
+
+ /**
+ * @private
+ */
+ public function set selectedUpSkin(value:DisplayObject):void
+ {
+ if(this._skinSelector.getValueForState(STATE_UP, true) == value)
+ {
+ return;
+ }
+ this._skinSelector.setValueForState(value, STATE_UP, true);
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * The skin used for the button's down state when the button is
+ * selected. If null, then defaultSelectedSkin
+ * is used instead. If defaultSelectedSkin is also
+ * null, then defaultSkin is used.
+ *
+ * This property will be ignored if a function is passed to the
+ * stateToSkinFunction property.
+ *
+ * The following example gives the button a skin for the selected down state:
+ *
+ *
+ * button.selectedDownSkin = new Image( texture );
+ *
+ * @default null
+ *
+ * @see #defaultSkin
+ * @see #defaultSelectedSkin
+ */
+ public function get selectedDownSkin():DisplayObject
+ {
+ return DisplayObject(this._skinSelector.getValueForState(STATE_DOWN, true));
+ }
+
+ /**
+ * @private
+ */
+ public function set selectedDownSkin(value:DisplayObject):void
+ {
+ if(this._skinSelector.getValueForState(STATE_DOWN, true) == value)
+ {
+ return;
+ }
+ this._skinSelector.setValueForState(value, STATE_DOWN, true);
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * The skin used for the button's hover state when the button is
+ * selected. If null, then defaultSelectedSkin
+ * is used instead. If defaultSelectedSkin is also
+ * null, then defaultSkin is used.
+ *
+ * This property will be ignored if a function is passed to the
+ * stateToSkinFunction property.
+ *
+ * The following example gives the button a skin for the selected hover state:
+ *
+ *
+ * button.selectedHoverSkin = new Image( texture );
+ *
+ * @default null
+ *
+ * @see #defaultSkin
+ * @see #defaultSelectedSkin
+ */
+ public function get selectedHoverSkin():DisplayObject
+ {
+ return DisplayObject(this._skinSelector.getValueForState(STATE_HOVER, true));
+ }
+
+ /**
+ * @private
+ */
+ public function set selectedHoverSkin(value:DisplayObject):void
+ {
+ if(this._skinSelector.getValueForState(STATE_HOVER, true) == value)
+ {
+ return;
+ }
+ this._skinSelector.setValueForState(value, STATE_HOVER, true);
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * The skin used for the button's disabled state when the button is
+ * selected. If null, then defaultSelectedSkin
+ * is used instead. If defaultSelectedSkin is also
+ * null, then defaultSkin is used.
+ *
+ * This property will be ignored if a function is passed to the
+ * stateToSkinFunction property.
+ *
+ * The following example gives the button a skin for the selected disabled state:
+ *
+ *
+ * button.selectedDisabledSkin = new Image( texture );
+ *
+ * @default null
+ *
+ * @see #defaultSkin
+ * @see #defaultSelectedSkin
+ */
+ public function get selectedDisabledSkin():DisplayObject
+ {
+ return DisplayObject(this._skinSelector.getValueForState(STATE_DISABLED, true));
+ }
+
+ /**
+ * @private
+ */
+ public function set selectedDisabledSkin(value:DisplayObject):void
+ {
+ if(this._skinSelector.getValueForState(STATE_DISABLED, true) == value)
+ {
+ return;
+ }
+ this._skinSelector.setValueForState(value, STATE_DISABLED, true);
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * The default selected label properties are a set of key/value pairs to
+ * be passed down ot the button's label text renderer, and it is used
+ * when the button is selected and no specific properties are defined
+ * for the button's current state. If null, then
+ * defaultLabelProperties is used instead. The label
+ * text renderer is an ITextRenderer instance. The
+ * available properties depend on which ITextRenderer
+ * implementation is returned by labelFactory. The most
+ * common implementations are BitmapFontTextRenderer and
+ * TextFieldTextRenderer.
+ *
+ * The following example gives the button default label properties to
+ * use for all selected states when no specific label properties are
+ * available:
+ *
+ *
+ * button.defaultSelectedLabelProperties.textFormat = new BitmapFontTextFormat( bitmapFont );
+ * button.defaultSelectedLabelProperties.wordWrap = true;
+ *
+ * @default null
+ *
+ * @see feathers.core.ITextRenderer
+ * @see feathers.controls.text.BitmapFontTextRenderer
+ * @see feathers.controls.text.TextFieldTextRenderer
+ * @see #defaultLabelProperties
+ */
+ public function get defaultSelectedLabelProperties():Object
+ {
+ var value:PropertyProxy = PropertyProxy(this._labelPropertiesSelector.defaultSelectedValue);
+ if(!value)
+ {
+ value = new PropertyProxy(childProperties_onChange);
+ this._labelPropertiesSelector.defaultSelectedValue = value;
+ }
+ return value;
+ }
+
+ /**
+ * @private
+ */
+ public function set defaultSelectedLabelProperties(value:Object):void
+ {
+ if(!(value is PropertyProxy))
+ {
+ value = PropertyProxy.fromObject(value);
+ }
+ var oldValue:PropertyProxy = PropertyProxy(this._labelPropertiesSelector.defaultSelectedValue);
+ if(oldValue)
+ {
+ oldValue.removeOnChangeCallback(childProperties_onChange);
+ }
+ this._labelPropertiesSelector.defaultSelectedValue = value;
+ if(value)
+ {
+ PropertyProxy(value).addOnChangeCallback(childProperties_onChange);
+ }
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * A set of key/value pairs to be passed down ot the button's label
+ * text renderer when the button is in the up state and is selected. If
+ * null, then defaultSelectedLabelProperties
+ * is used instead. If defaultSelectedLabelProperties is also
+ * null, then defaultLabelProperties is used.
+ * The label text renderer is an ITextRenderer instance.
+ * The available properties depend on which ITextRenderer
+ * implementation is returned by labelFactory. The most
+ * common implementations are BitmapFontTextRenderer and
+ * TextFieldTextRenderer.
+ *
+ * The following example gives the button label properties for the
+ * selected up state:
+ *
+ *
+ * button.selectedUpLabelProperties.textFormat = new BitmapFontTextFormat( bitmapFont );
+ *
+ * @default null
+ *
+ * @see feathers.core.ITextRenderer
+ * @see feathers.controls.text.BitmapFontTextRenderer
+ * @see feathers.controls.text.TextFieldTextRenderer
+ * @see #defaultLabelProperties
+ * @see #defaultSelectedLabelProperties
+ * @see #upLabelProperties
+ */
+ public function get selectedUpLabelProperties():Object
+ {
+ var value:PropertyProxy = PropertyProxy(this._labelPropertiesSelector.getValueForState(STATE_UP, true));
+ if(!value)
+ {
+ value = new PropertyProxy(childProperties_onChange);
+ this._labelPropertiesSelector.setValueForState(value, STATE_UP, true);
+ }
+ return value;
+ }
+
+ /**
+ * @private
+ */
+ public function set selectedUpLabelProperties(value:Object):void
+ {
+ if(!(value is PropertyProxy))
+ {
+ value = PropertyProxy.fromObject(value);
+ }
+ var oldValue:PropertyProxy = PropertyProxy(this._labelPropertiesSelector.getValueForState(STATE_UP, true));
+ if(oldValue)
+ {
+ oldValue.removeOnChangeCallback(childProperties_onChange);
+ }
+ this._labelPropertiesSelector.setValueForState(value, STATE_UP, true);
+ if(value)
+ {
+ PropertyProxy(value).addOnChangeCallback(childProperties_onChange);
+ }
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * A set of key/value pairs to be passed down ot the button's label
+ * text renderer when the button is in the down state and is selected.
+ * If null, then defaultSelectedLabelProperties
+ * is used instead. If defaultSelectedLabelProperties is also
+ * null, then defaultLabelProperties is used.
+ * The label text renderer is an ITextRenderer instance.
+ * The available properties depend on which ITextRenderer
+ * implementation is returned by labelFactory. The most
+ * common implementations are BitmapFontTextRenderer and
+ * TextFieldTextRenderer.
+ *
+ * The following example gives the button label properties for the
+ * selected down state:
+ *
+ *
+ * button.selectedDownLabelProperties.textFormat = new BitmapFontTextFormat( bitmapFont );
+ *
+ * @default null
+ *
+ * @see feathers.core.ITextRenderer
+ * @see feathers.controls.text.BitmapFontTextRenderer
+ * @see feathers.controls.text.TextFieldTextRenderer
+ * @see #defaultLabelProperties
+ * @see #defaultSelectedLabelProperties
+ * @see #downLabelProperties
+ */
+ public function get selectedDownLabelProperties():Object
+ {
+ var value:PropertyProxy = PropertyProxy(this._labelPropertiesSelector.getValueForState(STATE_DOWN, true));
+ if(!value)
+ {
+ value = new PropertyProxy(childProperties_onChange);
+ this._labelPropertiesSelector.setValueForState(value, STATE_DOWN, true);
+ }
+ return value;
+ }
+
+ /**
+ * @private
+ */
+ public function set selectedDownLabelProperties(value:Object):void
+ {
+ if(!(value is PropertyProxy))
+ {
+ value = PropertyProxy.fromObject(value);
+ }
+ var oldValue:PropertyProxy = PropertyProxy(this._labelPropertiesSelector.getValueForState(STATE_DOWN, true));
+ if(oldValue)
+ {
+ oldValue.removeOnChangeCallback(childProperties_onChange);
+ }
+ this._labelPropertiesSelector.setValueForState(value, STATE_DOWN, true);
+ if(value)
+ {
+ PropertyProxy(value).addOnChangeCallback(childProperties_onChange);
+ }
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * A set of key/value pairs to be passed down ot the button's label
+ * text renderer when the button is in the hover state and is selected.
+ * If null, then defaultSelectedLabelProperties
+ * is used instead. If defaultSelectedLabelProperties is also
+ * null, then defaultLabelProperties is used.
+ * The label text renderer is an ITextRenderer instance.
+ * The available properties depend on which ITextRenderer
+ * implementation is returned by labelFactory. The most
+ * common implementations are BitmapFontTextRenderer and
+ * TextFieldTextRenderer.
+ *
+ * The following example gives the button label properties for the
+ * selected hover state:
+ *
+ *
+ * button.selectedHoverLabelProperties.textFormat = new BitmapFontTextFormat( bitmapFont );
+ *
+ * @default null
+ *
+ * @see feathers.core.ITextRenderer
+ * @see feathers.controls.text.BitmapFontTextRenderer
+ * @see feathers.controls.text.TextFieldTextRenderer
+ * @see #defaultLabelProperties
+ * @see #defaultSelectedLabelProperties
+ * @see #hoverLabelProperties
+ */
+ public function get selectedHoverLabelProperties():Object
+ {
+ var value:PropertyProxy = PropertyProxy(this._labelPropertiesSelector.getValueForState(STATE_HOVER, true));
+ if(!value)
+ {
+ value = new PropertyProxy(childProperties_onChange);
+ this._labelPropertiesSelector.setValueForState(value, STATE_HOVER, true);
+ }
+ return value;
+ }
+
+ /**
+ * @private
+ */
+ public function set selectedHoverLabelProperties(value:Object):void
+ {
+ if(!(value is PropertyProxy))
+ {
+ value = PropertyProxy.fromObject(value);
+ }
+ var oldValue:PropertyProxy = PropertyProxy(this._labelPropertiesSelector.getValueForState(STATE_HOVER, true));
+ if(oldValue)
+ {
+ oldValue.removeOnChangeCallback(childProperties_onChange);
+ }
+ this._labelPropertiesSelector.setValueForState(value, STATE_HOVER, true);
+ if(value)
+ {
+ PropertyProxy(value).addOnChangeCallback(childProperties_onChange);
+ }
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * A set of key/value pairs to be passed down ot the button's label
+ * text renderer when the button is in the disabled state and is
+ * selected. If null, then defaultSelectedLabelProperties
+ * is used instead. If defaultSelectedLabelProperties is also
+ * null, then defaultLabelProperties is used.
+ * The label text renderer is an ITextRenderer instance.
+ * The available properties depend on which ITextRenderer
+ * implementation is returned by labelFactory. The most
+ * common implementations are BitmapFontTextRenderer and
+ * TextFieldTextRenderer.
+ *
+ * The following example gives the button label properties for the
+ * selected disabled state:
+ *
+ *
+ * button.selectedDisabledLabelProperties.textFormat = new BitmapFontTextFormat( bitmapFont );
+ *
+ * @default null
+ *
+ * @see feathers.core.ITextRenderer
+ * @see feathers.controls.text.BitmapFontTextRenderer
+ * @see feathers.controls.text.TextFieldTextRenderer
+ * @see #defaultLabelProperties
+ * @see #defaultSelectedLabelProperties
+ * @see #disabledLabelProperties
+ */
+ public function get selectedDisabledLabelProperties():Object
+ {
+ var value:PropertyProxy = PropertyProxy(this._labelPropertiesSelector.getValueForState(STATE_DISABLED, true));
+ if(!value)
+ {
+ value = new PropertyProxy(childProperties_onChange);
+ this._labelPropertiesSelector.setValueForState(value, STATE_DISABLED, true);
+ }
+ return value;
+ }
+
+ /**
+ * @private
+ */
+ public function set selectedDisabledLabelProperties(value:Object):void
+ {
+ if(!(value is PropertyProxy))
+ {
+ value = PropertyProxy.fromObject(value);
+ }
+ var oldValue:PropertyProxy = PropertyProxy(this._labelPropertiesSelector.getValueForState(STATE_DISABLED, true));
+ if(oldValue)
+ {
+ oldValue.removeOnChangeCallback(childProperties_onChange);
+ }
+ this._labelPropertiesSelector.setValueForState(value, STATE_DISABLED, true);
+ if(value)
+ {
+ PropertyProxy(value).addOnChangeCallback(childProperties_onChange);
+ }
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * The icon used when no other icon is defined for the current state
+ * when the button is selected. Has a higher priority than
+ * defaultIcon, but a lower priority than other selected
+ * icons.
+ *
+ * This property will be ignored if a function is passed to the
+ * stateToIconFunction property.
+ *
+ * The following example gives the button a default icon to use for
+ * all selected states when no specific icon is available:
+ *
+ *
+ * button.defaultSelectedIcon = new Image( texture );
+ *
+ * @default null
+ *
+ * @see #defaultIcon
+ * @see #selectedUpIcon
+ * @see #selectedDownIcon
+ * @see #selectedHoverIcon
+ * @see #selectedDisabledIcon
+ */
+ public function get defaultSelectedIcon():DisplayObject
+ {
+ return DisplayObject(this._iconSelector.defaultSelectedValue);
+ }
+
+ /**
+ * @private
+ */
+ public function set defaultSelectedIcon(value:DisplayObject):void
+ {
+ if(this._iconSelector.defaultSelectedValue == value)
+ {
+ return;
+ }
+ this._iconSelector.defaultSelectedValue = value;
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * The icon used for the button's up state when the button is
+ * selected. If null, then defaultSelectedIcon
+ * is used instead. If defaultSelectedIcon is also
+ * null, then defaultIcon is used.
+ *
+ * This property will be ignored if a function is passed to the
+ * stateToIconFunction property.
+ *
+ * The following example gives the button an icon for the selected up state:
+ *
+ *
+ * button.selectedUpIcon = new Image( texture );
+ *
+ * @default null
+ *
+ * @see #defaultIcon
+ * @see #defaultSelectedIcon
+ */
+ public function get selectedUpIcon():DisplayObject
+ {
+ return DisplayObject(this._iconSelector.getValueForState(STATE_UP, true));
+ }
+
+ /**
+ * @private
+ */
+ public function set selectedUpIcon(value:DisplayObject):void
+ {
+ if(this._iconSelector.getValueForState(STATE_UP, true) == value)
+ {
+ return;
+ }
+ this._iconSelector.setValueForState(value, STATE_UP, true);
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * The icon used for the button's down state when the button is
+ * selected. If null, then defaultSelectedIcon
+ * is used instead. If defaultSelectedIcon is also
+ * null, then defaultIcon is used.
+ *
+ * This property will be ignored if a function is passed to the
+ * stateToIconFunction property.
+ *
+ * The following example gives the button an icon for the selected down state:
+ *
+ *
+ * button.selectedDownIcon = new Image( texture );
+ *
+ * @default null
+ *
+ * @see #defaultIcon
+ * @see #defaultSelectedIcon
+ */
+ public function get selectedDownIcon():DisplayObject
+ {
+ return DisplayObject(this._iconSelector.getValueForState(STATE_DOWN, true));
+ }
+
+ /**
+ * @private
+ */
+ public function set selectedDownIcon(value:DisplayObject):void
+ {
+ if(this._iconSelector.getValueForState(STATE_DOWN, true) == value)
+ {
+ return;
+ }
+ this._iconSelector.setValueForState(value, STATE_DOWN, true);
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * The icon used for the button's hover state when the button is
+ * selected. If null, then defaultSelectedIcon
+ * is used instead. If defaultSelectedIcon is also
+ * null, then defaultIcon is used.
+ *
+ * This property will be ignored if a function is passed to the
+ * stateToIconFunction property.
+ *
+ * The following example gives the button an icon for the selected hover state:
+ *
+ *
+ * button.selectedHoverIcon = new Image( texture );
+ *
+ * @default null
+ *
+ * @see #defaultIcon
+ * @see #defaultSelectedIcon
+ */
+ public function get selectedHoverIcon():DisplayObject
+ {
+ return DisplayObject(this._iconSelector.getValueForState(STATE_HOVER, true));
+ }
+
+ /**
+ * @private
+ */
+ public function set selectedHoverIcon(value:DisplayObject):void
+ {
+ if(this._iconSelector.getValueForState(STATE_HOVER, true) == value)
+ {
+ return;
+ }
+ this._iconSelector.setValueForState(value, STATE_HOVER, true);
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * The icon used for the button's disabled state when the button is
+ * selected. If null, then defaultSelectedIcon
+ * is used instead. If defaultSelectedIcon is also
+ * null, then defaultIcon is used.
+ *
+ * This property will be ignored if a function is passed to the
+ * stateToIconFunction property.
+ *
+ * The following example gives the button an icon for the selected disabled state:
+ *
+ *
+ * button.selectedDisabledIcon = new Image( texture );
+ *
+ * @default null
+ *
+ * @see #defaultIcon
+ * @see #defaultSelectedIcon
+ */
+ public function get selectedDisabledIcon():DisplayObject
+ {
+ return DisplayObject(this._iconSelector.getValueForState(STATE_DISABLED, true));
+ }
+
+ /**
+ * @private
+ */
+ public function set selectedDisabledIcon(value:DisplayObject):void
+ {
+ if(this._iconSelector.getValueForState(STATE_DISABLED, true) == value)
+ {
+ return;
+ }
+ this._iconSelector.setValueForState(value, STATE_DISABLED, true);
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ override protected function trigger():void
+ {
+ super.trigger();
+ if(this._isToggle)
+ {
+ this.isSelected = !this._isSelected;
+ }
+ }
+ }
+}
diff --git a/source/feathers/controls/ToggleSwitch.as b/source/feathers/controls/ToggleSwitch.as
new file mode 100644
index 0000000000..c8017bb6d7
--- /dev/null
+++ b/source/feathers/controls/ToggleSwitch.as
@@ -0,0 +1,2714 @@
+/*
+Feathers
+Copyright 2012-2014 Joshua Tynjala. All Rights Reserved.
+
+This program is free software. You can redistribute and/or modify it in
+accordance with the terms of the accompanying license agreement.
+*/
+package feathers.controls
+{
+ import feathers.core.FeathersControl;
+ import feathers.core.IFocusDisplayObject;
+ import feathers.core.ITextRenderer;
+ import feathers.core.IToggle;
+ import feathers.core.PropertyProxy;
+ import feathers.skins.IStyleProvider;
+ import feathers.system.DeviceCapabilities;
+
+ import flash.geom.Point;
+ import flash.geom.Rectangle;
+ import flash.ui.Keyboard;
+
+ import starling.animation.Transitions;
+ import starling.animation.Tween;
+ import starling.core.Starling;
+ import starling.display.DisplayObject;
+ import starling.events.Event;
+ import starling.events.KeyboardEvent;
+ import starling.events.Touch;
+ import starling.events.TouchEvent;
+ import starling.events.TouchPhase;
+ import starling.utils.SystemUtil;
+
+ /**
+ * @copy feathers.core.IToggle#event:change
+ */
+ [Event(name="change",type="starling.events.Event")]
+
+ /**
+ * Similar to a light switch with on and off states. Generally considered an
+ * alternative to a check box.
+ *
+ * The following example programmatically selects a toggle switch and
+ * listens for when the selection changes:
+ *
+ *
+ * var toggle:ToggleSwitch = new ToggleSwitch();
+ * toggle.isSelected = true;
+ * toggle.addEventListener( Event.CHANGE, toggle_changeHandler );
+ * this.addChild( toggle );
+ *
+ * @see ../../../help/toggle-switch.html How to use the Feathers ToggleSwitch component
+ * @see feathers.controls.Check
+ */
+ public class ToggleSwitch extends FeathersControl implements IToggle, IFocusDisplayObject
+ {
+ /**
+ * @private
+ */
+ private static const HELPER_POINT:Point = new Point();
+
+ /**
+ * @private
+ * The minimum physical distance (in inches) that a touch must move
+ * before the scroller starts scrolling.
+ */
+ private static const MINIMUM_DRAG_DISTANCE:Number = 0.04;
+
+ /**
+ * @private
+ */
+ protected static const INVALIDATION_FLAG_THUMB_FACTORY:String = "thumbFactory";
+
+ /**
+ * @private
+ */
+ protected static const INVALIDATION_FLAG_ON_TRACK_FACTORY:String = "onTrackFactory";
+
+ /**
+ * @private
+ */
+ protected static const INVALIDATION_FLAG_OFF_TRACK_FACTORY:String = "offTrackFactory";
+
+ /**
+ * The ON and OFF labels will be aligned to the middle vertically,
+ * based on the full character height of the font.
+ *
+ * @see #labelAlign
+ */
+ public static const LABEL_ALIGN_MIDDLE:String = "middle";
+
+ /**
+ * The ON and OFF labels will be aligned to the middle vertically,
+ * based on only the baseline value of the font.
+ *
+ * @see #labelAlign
+ */
+ public static const LABEL_ALIGN_BASELINE:String = "baseline";
+
+ /**
+ * The toggle switch has only one track skin, stretching to fill the
+ * full length of switch. In this layout mode, the on track is
+ * displayed and fills the entire length of the toggle switch. The off
+ * track will not exist.
+ *
+ * @see #trackLayoutMode
+ */
+ public static const TRACK_LAYOUT_MODE_SINGLE:String = "single";
+
+ /**
+ * The toggle switch has two tracks, stretching to fill each side of the
+ * scroll bar with the thumb in the middle. The tracks will be resized
+ * as the thumb moves. This layout mode is designed for toggle switches
+ * where the two sides of the track may be colored differently to better
+ * differentiate between the on state and the off state.
+ *
+ * Since the width and height of the tracks will change, consider
+ * using a special display object such as a Scale9Image,
+ * Scale3Image or a TiledImage that is
+ * designed to be resized dynamically.
+ *
+ * @see #trackLayoutMode
+ * @see feathers.display.Scale9Image
+ * @see feathers.display.Scale3Image
+ * @see feathers.display.TiledImage
+ */
+ public static const TRACK_LAYOUT_MODE_ON_OFF:String = "onOff";
+
+ /**
+ * The default value added to the styleNameList of the off label.
+ *
+ * @see feathers.core.FeathersControl#styleNameList
+ */
+ public static const DEFAULT_CHILD_STYLE_NAME_OFF_LABEL:String = "feathers-toggle-switch-off-label";
+
+ /**
+ * DEPRECATED: Replaced by ToggleSwitch.DEFAULT_CHILD_STYLE_NAME_OFF_LABEL.
+ *
+ * DEPRECATION WARNING: This property is deprecated
+ * starting with Feathers 2.1. It will be removed in a future version of
+ * Feathers according to the standard
+ * Feathers deprecation policy.
+ *
+ * @see ToggleSwitch#DEFAULT_CHILD_STYLE_NAME_OFF_LABEL
+ */
+ public static const DEFAULT_CHILD_NAME_OFF_LABEL:String = DEFAULT_CHILD_STYLE_NAME_OFF_LABEL;
+
+ /**
+ * The default value added to the styleNameList of the on label.
+ *
+ * @see feathers.core.FeathersControl#styleNameList
+ */
+ public static const DEFAULT_CHILD_STYLE_NAME_ON_LABEL:String = "feathers-toggle-switch-on-label";
+
+ /**
+ * DEPRECATED: Replaced by ToggleSwitch.DEFAULT_CHILD_STYLE_NAME_ON_LABEL.
+ *
+ * DEPRECATION WARNING: This property is deprecated
+ * starting with Feathers 2.1. It will be removed in a future version of
+ * Feathers according to the standard
+ * Feathers deprecation policy.
+ *
+ * @see ToggleSwitch#DEFAULT_CHILD_STYLE_NAME_ON_LABEL
+ */
+ public static const DEFAULT_CHILD_NAME_ON_LABEL:String = DEFAULT_CHILD_STYLE_NAME_ON_LABEL;
+
+ /**
+ * The default value added to the styleNameList of the off track.
+ *
+ * @see feathers.core.FeathersControl#styleNameList
+ */
+ public static const DEFAULT_CHILD_STYLE_NAME_OFF_TRACK:String = "feathers-toggle-switch-off-track";
+
+ /**
+ * DEPRECATED: Replaced by ToggleSwitch.DEFAULT_CHILD_STYLE_NAME_OFF_TRACK.
+ *
+ * DEPRECATION WARNING: This property is deprecated
+ * starting with Feathers 2.1. It will be removed in a future version of
+ * Feathers according to the standard
+ * Feathers deprecation policy.
+ *
+ * @see ToggleSwitch#DEFAULT_CHILD_STYLE_NAME_OFF_TRACK
+ */
+ public static const DEFAULT_CHILD_NAME_OFF_TRACK:String = DEFAULT_CHILD_STYLE_NAME_OFF_TRACK;
+
+ /**
+ * The default value added to the styleNameList of the on track.
+ *
+ * @see feathers.core.FeathersControl#styleNameList
+ */
+ public static const DEFAULT_CHILD_STYLE_NAME_ON_TRACK:String = "feathers-toggle-switch-on-track";
+
+ /**
+ * DEPRECATED: Replaced by ToggleSwitch.DEFAULT_CHILD_STYLE_NAME_ON_TRACK.
+ *
+ * DEPRECATION WARNING: This property is deprecated
+ * starting with Feathers 2.1. It will be removed in a future version of
+ * Feathers according to the standard
+ * Feathers deprecation policy.
+ *
+ * @see ToggleSwitch#DEFAULT_CHILD_STYLE_NAME_ON_TRACK
+ */
+ public static const DEFAULT_CHILD_NAME_ON_TRACK:String = DEFAULT_CHILD_STYLE_NAME_ON_TRACK;
+
+ /**
+ * The default value added to the styleNameList of the thumb.
+ *
+ * @see feathers.core.FeathersControl#styleNameList
+ */
+ public static const DEFAULT_CHILD_STYLE_NAME_THUMB:String = "feathers-toggle-switch-thumb";
+
+ /**
+ * DEPRECATED: Replaced by ToggleSwitch.DEFAULT_CHILD_STYLE_NAME_THUMB.
+ *
+ * DEPRECATION WARNING: This property is deprecated
+ * starting with Feathers 2.1. It will be removed in a future version of
+ * Feathers according to the standard
+ * Feathers deprecation policy.
+ *
+ * @see ToggleSwitch#DEFAULT_CHILD_STYLE_NAME_THUMB
+ */
+ public static const DEFAULT_CHILD_NAME_THUMB:String = DEFAULT_CHILD_STYLE_NAME_THUMB;
+
+ /**
+ * The default IStyleProvider for all ToggleSwitch
+ * components.
+ *
+ * @default null
+ * @see feathers.core.FeathersControl#styleProvider
+ */
+ public static var globalStyleProvider:IStyleProvider;
+
+ /**
+ * @private
+ */
+ protected static function defaultThumbFactory():Button
+ {
+ return new Button();
+ }
+
+ /**
+ * @private
+ */
+ protected static function defaultOnTrackFactory():Button
+ {
+ return new Button();
+ }
+
+ /**
+ * @private
+ */
+ protected static function defaultOffTrackFactory():Button
+ {
+ return new Button();
+ }
+
+ /**
+ * Constructor.
+ */
+ public function ToggleSwitch()
+ {
+ super();
+ this.addEventListener(TouchEvent.TOUCH, toggleSwitch_touchHandler);
+ this.addEventListener(Event.REMOVED_FROM_STAGE, toggleSwitch_removedFromStageHandler);
+ }
+
+ /**
+ * The value added to the styleNameList of the off label
+ * text renderer. This variable is protected so that
+ * sub-classes can customize the on label text renderer style name in
+ * their constructors instead of using the default style name defined by
+ * DEFAULT_CHILD_STYLE_NAME_ON_LABEL.
+ *
+ * @see feathers.core.FeathersControl#styleNameList
+ */
+ protected var onLabelStyleName:String = DEFAULT_CHILD_STYLE_NAME_ON_LABEL;
+
+ /**
+ * DEPRECATED: Replaced by onLabelStyleName.
+ *
+ * DEPRECATION WARNING: This property is deprecated
+ * starting with Feathers 2.1. It will be removed in a future version of
+ * Feathers according to the standard
+ * Feathers deprecation policy.
+ *
+ * @see #onLabelStyleName
+ */
+ protected function get onLabelName():String
+ {
+ return this.onLabelStyleName;
+ }
+
+ /**
+ * @private
+ */
+ protected function set onLabelName(value:String):void
+ {
+ this.onLabelStyleName = value;
+ }
+
+ /**
+ * The value added to the styleNameList of the off label
+ * text renderer. This variable is protected so that
+ * sub-classes can customize the off label text renderer style name in
+ * their constructors instead of using the default style name defined by
+ * DEFAULT_CHILD_STYLE_NAME_OFF_LABEL.
+ *
+ * @see feathers.core.FeathersControl#styleNameList
+ */
+ protected var offLabelStyleName:String = DEFAULT_CHILD_STYLE_NAME_OFF_LABEL;
+
+ /**
+ * DEPRECATED: Replaced by offLabelStyleName.
+ *
+ * DEPRECATION WARNING: This property is deprecated
+ * starting with Feathers 2.1. It will be removed in a future version of
+ * Feathers according to the standard
+ * Feathers deprecation policy.
+ *
+ * @see #offLabelStyleName
+ */
+ protected function get offLabelName():String
+ {
+ return this.offLabelStyleName;
+ }
+
+ /**
+ * @private
+ */
+ protected function set offLabelName(value:String):void
+ {
+ this.offLabelStyleName = value;
+ }
+
+ /**
+ * The value added to the styleNameList of the on track.
+ * This variable is protected so that sub-classes can
+ * customize the on track style name in their constructors instead of
+ * using the default style name defined by
+ * DEFAULT_CHILD_STYLE_NAME_ON_TRACK.
+ *
+ * To customize the on track style name without subclassing, see
+ * customOnTrackStyleName.
+ *
+ * @see #customOnTrackStyleName
+ * @see feathers.core.FeathersControl#styleNameList
+ */
+ protected var onTrackStyleName:String = DEFAULT_CHILD_STYLE_NAME_ON_TRACK;
+
+ /**
+ * DEPRECATED: Replaced by onTrackStyleName.
+ *
+ * DEPRECATION WARNING: This property is deprecated
+ * starting with Feathers 2.1. It will be removed in a future version of
+ * Feathers according to the standard
+ * Feathers deprecation policy.
+ *
+ * @see #onTrackStyleName
+ */
+ protected function get onTrackName():String
+ {
+ return this.onTrackStyleName;
+ }
+
+ /**
+ * @private
+ */
+ protected function set onTrackName(value:String):void
+ {
+ this.onTrackStyleName = value;
+ }
+
+ /**
+ * The value added to the styleNameList of the off track.
+ * This variable is protected so that sub-classes can
+ * customize the off track style name in their constructors instead of
+ * using the default style name defined by
+ * DEFAULT_CHILD_STYLE_NAME_OFF_TRACK.
+ *
+ * To customize the off track style name without subclassing, see
+ * customOffTrackStyleName.
+ *
+ * @see #customOffTrackStyleName
+ * @see feathers.core.FeathersControl#styleNameList
+ */
+ protected var offTrackStyleName:String = DEFAULT_CHILD_STYLE_NAME_OFF_TRACK;
+
+ /**
+ * DEPRECATED: Replaced by offTrackStyleName.
+ *
+ * DEPRECATION WARNING: This property is deprecated
+ * starting with Feathers 2.1. It will be removed in a future version of
+ * Feathers according to the standard
+ * Feathers deprecation policy.
+ *
+ * @see #offTrackStyleName
+ */
+ protected function get offTrackName():String
+ {
+ return this.offTrackStyleName;
+ }
+
+ /**
+ * @private
+ */
+ protected function set offTrackName(value:String):void
+ {
+ this.offTrackStyleName = value;
+ }
+
+ /**
+ * The value added to the styleNameList of the thumb. This
+ * variable is protected so that sub-classes can customize
+ * the thumb style name in their constructors instead of using the
+ * default stylename defined by DEFAULT_CHILD_STYLE_NAME_THUMB.
+ *
+ * To customize the thumb style name without subclassing, see
+ * customThumbStyleName.
+ *
+ * @see #customThumbStyleName
+ * @see feathers.core.FeathersControl#styleNameList
+ */
+ protected var thumbStyleName:String = DEFAULT_CHILD_STYLE_NAME_THUMB;
+
+ /**
+ * DEPRECATED: Replaced by tabStyleName.
+ *
+ * DEPRECATION WARNING: This property is deprecated
+ * starting with Feathers 2.1. It will be removed in a future version of
+ * Feathers according to the standard
+ * Feathers deprecation policy.
+ *
+ * @see #tabStyleName
+ */
+ protected function get thumbName():String
+ {
+ return this.thumbStyleName;
+ }
+
+ /**
+ * @private
+ */
+ protected function set thumbName(value:String):void
+ {
+ this.thumbStyleName = value;
+ }
+
+ /**
+ * The thumb sub-component.
+ *
+ * For internal use in subclasses.
+ *
+ * @see #thumbFactory
+ * @see #createThumb()
+ */
+ protected var thumb:Button;
+
+ /**
+ * The "on" text renderer sub-component.
+ *
+ * @see #labelFactory
+ */
+ protected var onTextRenderer:ITextRenderer;
+
+ /**
+ * The "off" text renderer sub-component.
+ *
+ * For internal use in subclasses.
+ *
+ * @see #labelFactory
+ */
+ protected var offTextRenderer:ITextRenderer;
+
+ /**
+ * The "on" track sub-component.
+ *
+ * For internal use in subclasses.
+ *
+ * @see #onTrackFactory
+ * @see #createOnTrack()
+ */
+ protected var onTrack:Button;
+
+ /**
+ * The "off" track sub-component.
+ *
+ * For internal use in subclasses.
+ *
+ * @see #offTrackFactory
+ * @see #createOffTrack()
+ */
+ protected var offTrack:Button;
+
+ /**
+ * @private
+ */
+ override protected function get defaultStyleProvider():IStyleProvider
+ {
+ return ToggleSwitch.globalStyleProvider;
+ }
+
+ /**
+ * @private
+ */
+ protected var _paddingRight:Number = 0;
+
+ /**
+ * The minimum space, in pixels, between the switch's right edge and the
+ * switch's content.
+ *
+ * In the following example, the toggle switch's right padding is
+ * set to 20 pixels:
+ *
+ *
+ * toggle.paddingRight = 20;
+ *
+ * @default 0
+ */
+ public function get paddingRight():Number
+ {
+ return this._paddingRight;
+ }
+
+ /**
+ * @private
+ */
+ public function set paddingRight(value:Number):void
+ {
+ if(this._paddingRight == value)
+ {
+ return;
+ }
+ this._paddingRight = value;
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _paddingLeft:Number = 0;
+
+ /**
+ * The minimum space, in pixels, between the switch's left edge and the
+ * switch's content.
+ *
+ * In the following example, the toggle switch's left padding is
+ * set to 20 pixels:
+ *
+ *
+ *
+ *
+ *
+ * toggle.customOnTrackName = "my-custom-on-track";.paddingLeft = 20;
+ *
+ * @default 0
+ */
+ public function get paddingLeft():Number
+ {
+ return this._paddingLeft;
+ }
+
+ /**
+ * @private
+ */
+ public function set paddingLeft(value:Number):void
+ {
+ if(this._paddingLeft == value)
+ {
+ return;
+ }
+ this._paddingLeft = value;
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _showLabels:Boolean = true;
+
+ /**
+ * Determines if the labels should be drawn. The onTrackSkin and
+ * offTrackSkin backgrounds may include the text instead.
+ *
+ * In the following example, the toggle switch's labels are hidden:
+ *
+ *
+ * toggle.showLabels = false;
+ *
+ * @default true
+ */
+ public function get showLabels():Boolean
+ {
+ return _showLabels;
+ }
+
+ /**
+ * @private
+ */
+ public function set showLabels(value:Boolean):void
+ {
+ if(this._showLabels == value)
+ {
+ return;
+ }
+ this._showLabels = value;
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _showThumb:Boolean = true;
+
+ /**
+ * Determines if the thumb should be displayed. This stops interaction
+ * while still displaying the background.
+ *
+ * In the following example, the toggle switch's thumb is hidden:
+ *
+ *
+ * toggle.showThumb = false;
+ *
+ * @default true
+ */
+ public function get showThumb():Boolean
+ {
+ return this._showThumb;
+ }
+
+ /**
+ * @private
+ */
+ public function set showThumb(value:Boolean):void
+ {
+ if(this._showThumb == value)
+ {
+ return;
+ }
+ this._showThumb = value;
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _trackLayoutMode:String = TRACK_LAYOUT_MODE_SINGLE;
+
+ [Inspectable(type="String",enumeration="single,onOff")]
+ /**
+ * Determines how the on and off track skins are positioned and sized.
+ *
+ * In the following example, the toggle switch's track layout mode is
+ * updated to use two tracks:
+ *
+ *
+ * toggle.trackLayoutMode = ToggleSwitch.TRACK_LAYOUT_MODE_ON_OFF;
+ *
+ * @default ToggleSwitch.TRACK_LAYOUT_MODE_SINGLE
+ *
+ * @see #TRACK_LAYOUT_MODE_SINGLE
+ * @see #TRACK_LAYOUT_MODE_ON_OFF
+ */
+ public function get trackLayoutMode():String
+ {
+ return this._trackLayoutMode;
+ }
+
+ /**
+ * @private
+ */
+ public function set trackLayoutMode(value:String):void
+ {
+ if(this._trackLayoutMode == value)
+ {
+ return;
+ }
+ this._trackLayoutMode = value;
+ this.invalidate(INVALIDATION_FLAG_LAYOUT);
+ }
+
+ /**
+ * @private
+ */
+ protected var _defaultLabelProperties:PropertyProxy;
+
+ /**
+ * The default label properties are a set of key/value pairs to be
+ * passed down to the toggle switch's label text renderers, and it is
+ * used when no specific properties are defined for a specific label
+ * text renderer's current state. The label text renderers are ITextRenderer
+ * instances. The available properties depend on which ITextRenderer
+ * implementation is returned by labelFactory. The most
+ * common implementations are BitmapFontTextRenderer and
+ * TextFieldTextRenderer.
+ *
+ * In the following example, the toggle switch's default label
+ * properties are updated (this example assumes that the label text
+ * renderers are of type TextFieldTextRenderer):
+ *
+ *
+ * toggle.defaultLabelProperties.textFormat = new TextFormat( "Source Sans Pro", 16, 0x333333 );
+ * toggle.defaultLabelProperties.embedFonts = true;
+ *
+ * @default null
+ *
+ * @see #labelFactory
+ * @see feathers.core.ITextRenderer
+ * @see feathers.controls.text.BitmapFontTextRenderer
+ * @see feathers.controls.text.TextFieldTextRenderer
+ * @see #onLabelProperties
+ * @see #offLabelProperties
+ * @see #disabledLabelProperties
+ */
+ public function get defaultLabelProperties():Object
+ {
+ if(!this._defaultLabelProperties)
+ {
+ this._defaultLabelProperties = new PropertyProxy(childProperties_onChange);
+ }
+ return this._defaultLabelProperties;
+ }
+
+ /**
+ * @private
+ */
+ public function set defaultLabelProperties(value:Object):void
+ {
+ if(!(value is PropertyProxy))
+ {
+ value = PropertyProxy.fromObject(value);
+ }
+ if(this._defaultLabelProperties)
+ {
+ this._defaultLabelProperties.removeOnChangeCallback(childProperties_onChange);
+ }
+ this._defaultLabelProperties = PropertyProxy(value);
+ if(this._defaultLabelProperties)
+ {
+ this._defaultLabelProperties.addOnChangeCallback(childProperties_onChange);
+ }
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _disabledLabelProperties:PropertyProxy;
+
+ /**
+ * A set of key/value pairs to be passed down to the toggle switch's
+ * label text renderers when the toggle switch is disabled. The label
+ * text renderers are ITextRenderer instances. The
+ * available properties depend on which ITextRenderer
+ * implementation is returned by labelFactory. The most
+ * common implementations are BitmapFontTextRenderer and
+ * TextFieldTextRenderer.
+ *
+ * In the following example, the toggle switch's disabled label
+ * properties are updated (this example assumes that the label text
+ * renderers are of type TextFieldTextRenderer):
+ *
+ *
+ * toggle.disabledLabelProperties.textFormat = new TextFormat( "Source Sans Pro", 16, 0x333333 );
+ * toggle.disabledLabelProperties.embedFonts = true;
+ *
+ * @default null
+ *
+ * @see #labelFactory
+ * @see feathers.core.ITextRenderer
+ * @see feathers.controls.text.BitmapFontTextRenderer
+ * @see feathers.controls.text.TextFieldTextRenderer
+ * @see #defaultLabelProperties
+ */
+ public function get disabledLabelProperties():Object
+ {
+ if(!this._disabledLabelProperties)
+ {
+ this._disabledLabelProperties = new PropertyProxy(childProperties_onChange);
+ }
+ return this._disabledLabelProperties;
+ }
+
+ /**
+ * @private
+ */
+ public function set disabledLabelProperties(value:Object):void
+ {
+ if(!(value is PropertyProxy))
+ {
+ value = PropertyProxy.fromObject(value);
+ }
+ if(this._disabledLabelProperties)
+ {
+ this._disabledLabelProperties.removeOnChangeCallback(childProperties_onChange);
+ }
+ this._disabledLabelProperties = PropertyProxy(value);
+ if(this._disabledLabelProperties)
+ {
+ this._disabledLabelProperties.addOnChangeCallback(childProperties_onChange);
+ }
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _onLabelProperties:PropertyProxy;
+
+ /**
+ * A set of key/value pairs to be passed down to the toggle switch's
+ * ON label text renderer. If null, then
+ * defaultLabelProperties is used instead. The label text
+ * renderers are ITextRenderer instances. The available
+ * properties depend on which ITextRenderer implementation
+ * is returned by labelFactory. The most common
+ * implementations are BitmapFontTextRenderer and
+ * TextFieldTextRenderer.
+ *
+ * In the following example, the toggle switch's on label properties
+ * are updated (this example assumes that the on label text renderer is a
+ * TextFieldTextRenderer):
+ *
+ *
+ * toggle.onLabelProperties.textFormat = new TextFormat( "Source Sans Pro", 16, 0x333333 );
+ * toggle.onLabelProperties.embedFonts = true;
+ *
+ * @default null
+ *
+ * @see #labelFactory
+ * @see feathers.core.ITextRenderer
+ * @see feathers.controls.text.BitmapFontTextRenderer
+ * @see feathers.controls.text.TextFieldTextRenderer
+ * @see #defaultLabelProperties
+ */
+ public function get onLabelProperties():Object
+ {
+ if(!this._onLabelProperties)
+ {
+ this._onLabelProperties = new PropertyProxy(childProperties_onChange);
+ }
+ return this._onLabelProperties;
+ }
+
+ /**
+ * @private
+ */
+ public function set onLabelProperties(value:Object):void
+ {
+ if(!(value is PropertyProxy))
+ {
+ value = PropertyProxy.fromObject(value);
+ }
+ if(this._onLabelProperties)
+ {
+ this._onLabelProperties.removeOnChangeCallback(childProperties_onChange);
+ }
+ this._onLabelProperties = PropertyProxy(value);
+ if(this._onLabelProperties)
+ {
+ this._onLabelProperties.addOnChangeCallback(childProperties_onChange);
+ }
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _offLabelProperties:PropertyProxy;
+
+ /**
+ * A set of key/value pairs to be passed down to the toggle switch's
+ * OFF label text renderer. If null, then
+ * defaultLabelProperties is used instead. The label text
+ * renderers are ITextRenderer instances. The available
+ * properties depend on which ITextRenderer implementation
+ * is returned by labelFactory. The most common
+ * implementations are BitmapFontTextRenderer and
+ * TextFieldTextRenderer.
+ *
+ * In the following example, the toggle switch's off label properties
+ * are updated (this example assumes that the off label text renderer is a
+ * TextFieldTextRenderer):
+ *
+ *
+ * toggle.offLabelProperties.textFormat = new TextFormat( "Source Sans Pro", 16, 0x333333 );
+ * toggle.offLabelProperties.embedFonts = true;
+ *
+ * @default null
+ *
+ * @see #labelFactory
+ * @see feathers.core.ITextRenderer
+ * @see feathers.controls.text.BitmapFontTextRenderer
+ * @see feathers.controls.text.TextFieldTextRenderer
+ * @see #defaultLabelProperties
+ */
+ public function get offLabelProperties():Object
+ {
+ if(!this._offLabelProperties)
+ {
+ this._offLabelProperties = new PropertyProxy(childProperties_onChange);
+ }
+ return this._offLabelProperties;
+ }
+
+ /**
+ * @private
+ */
+ public function set offLabelProperties(value:Object):void
+ {
+ if(!(value is PropertyProxy))
+ {
+ value = PropertyProxy.fromObject(value);
+ }
+ if(this._offLabelProperties)
+ {
+ this._offLabelProperties.removeOnChangeCallback(childProperties_onChange);
+ }
+ this._offLabelProperties = PropertyProxy(value);
+ if(this._offLabelProperties)
+ {
+ this._offLabelProperties.addOnChangeCallback(childProperties_onChange);
+ }
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _labelAlign:String = LABEL_ALIGN_BASELINE;
+
+ [Inspectable(type="String",enumeration="baseline,middle")]
+ /**
+ * The vertical alignment of the label.
+ *
+ * In the following example, the toggle switch's label alignment is
+ * updated:
+ *
+ *
+ * toggle.labelAlign = ToggleSwitch.LABEL_ALIGN_MIDDLE;
+ *
+ * @default ToggleSwitch.LABEL_ALIGN_BASELINE
+ *
+ * @see #LABEL_ALIGN_BASELINE
+ * @see #LABEL_ALIGN_MIDDLE
+ */
+ public function get labelAlign():String
+ {
+ return this._labelAlign;
+ }
+
+ /**
+ * @private
+ */
+ public function set labelAlign(value:String):void
+ {
+ if(this._labelAlign == value)
+ {
+ return;
+ }
+ this._labelAlign = value;
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _labelFactory:Function;
+
+ /**
+ * A function used to instantiate the toggle switch's label text
+ * renderer sub-components, if specific factories for those label text
+ * renderers are not provided. The label text renderers must be
+ * instances of ITextRenderer. This factory can be used to
+ * change properties of the label text renderers when they are first
+ * created. For instance, if you are skinning Feathers components
+ * without a theme, you might use this factory to style the label text
+ * renderers.
+ *
+ * The factory should have the following function signature:
+ * function():ITextRenderer
+ *
+ * In the following example, the toggle switch uses a custom label
+ * factory:
+ *
+ *
+ * toggle.labelFactory = function():ITextRenderer
+ * {
+ * return new TextFieldTextRenderer();
+ * }
+ *
+ * @default null
+ *
+ * @see #onLabelFactory
+ * @see #offLabelFactory
+ * @see feathers.core.ITextRenderer
+ * @see feathers.core.FeathersControl#defaultTextRendererFactory
+ */
+ public function get labelFactory():Function
+ {
+ return this._labelFactory;
+ }
+
+ /**
+ * @private
+ */
+ public function set labelFactory(value:Function):void
+ {
+ if(this._labelFactory == value)
+ {
+ return;
+ }
+ this._labelFactory = value;
+ this.invalidate(INVALIDATION_FLAG_TEXT_RENDERER);
+ }
+
+ /**
+ * @private
+ */
+ protected var _onLabelFactory:Function;
+
+ /**
+ * A function used to instantiate the toggle switch's on label text
+ * renderer sub-component. The on label text renderer must be an
+ * instance of ITextRenderer. This factory can be used to
+ * change properties of the on label text renderer when it is first
+ * created. For instance, if you are skinning Feathers components
+ * without a theme, you might use this factory to style the on label
+ * text renderer.
+ *
+ * If an onLabelFactory is not provided, the default
+ * labelFactory will be used.
+ *
+ * The factory should have the following function signature:
+ * function():ITextRenderer
+ *
+ * In the following example, the toggle switch uses a custom on label
+ * factory:
+ *
+ *
+ * toggle.onLabelFactory = function():ITextRenderer
+ * {
+ * return new TextFieldTextRenderer();
+ * }
+ *
+ * @default null
+ *
+ * @see #labelFactory
+ * @see #offLabelFactory
+ * @see feathers.core.ITextRenderer
+ * @see feathers.core.FeathersControl#defaultTextRendererFactory
+ */
+ public function get onLabelFactory():Function
+ {
+ return this._onLabelFactory;
+ }
+
+ /**
+ * @private
+ */
+ public function set onLabelFactory(value:Function):void
+ {
+ if(this._onLabelFactory == value)
+ {
+ return;
+ }
+ this._onLabelFactory = value;
+ this.invalidate(INVALIDATION_FLAG_TEXT_RENDERER);
+ }
+
+ /**
+ * @private
+ */
+ protected var _offLabelFactory:Function;
+
+ /**
+ * A function used to instantiate the toggle switch's off label text
+ * renderer sub-component. The off label text renderer must be an
+ * instance of ITextRenderer. This factory can be used to
+ * change properties of the off label text renderer when it is first
+ * created. For instance, if you are skinning Feathers components
+ * without a theme, you might use this factory to style the off label
+ * text renderer.
+ *
+ * If an offLabelFactory is not provided, the default
+ * labelFactory will be used.
+ *
+ * The factory should have the following function signature:
+ * function():ITextRenderer
+ *
+ * In the following example, the toggle switch uses a custom on label
+ * factory:
+ *
+ *
+ * toggle.offLabelFactory = function():ITextRenderer
+ * {
+ * return new TextFieldTextRenderer();
+ * }
+ *
+ * @default null
+ *
+ * @see #labelFactory
+ * @see #onLabelFactory
+ * @see feathers.core.ITextRenderer
+ * @see feathers.core.FeathersControl#defaultTextRendererFactory
+ */
+ public function get offLabelFactory():Function
+ {
+ return this._offLabelFactory;
+ }
+
+ /**
+ * @private
+ */
+ public function set offLabelFactory(value:Function):void
+ {
+ if(this._offLabelFactory == value)
+ {
+ return;
+ }
+ this._offLabelFactory = value;
+ this.invalidate(INVALIDATION_FLAG_TEXT_RENDERER);
+ }
+
+ /**
+ * @private
+ */
+ protected var onTrackSkinOriginalWidth:Number = NaN;
+
+ /**
+ * @private
+ */
+ protected var onTrackSkinOriginalHeight:Number = NaN;
+
+ /**
+ * @private
+ */
+ protected var offTrackSkinOriginalWidth:Number = NaN;
+
+ /**
+ * @private
+ */
+ protected var offTrackSkinOriginalHeight:Number = NaN;
+
+ /**
+ * @private
+ */
+ protected var _isSelected:Boolean = false;
+
+ /**
+ * Indicates if the toggle switch is selected (ON) or not (OFF).
+ *
+ * In the following example, the toggle switch is selected:
+ *
+ *
+ * toggle.isSelected = true;
+ *
+ * @default false
+ *
+ * @see #setSelectionWithAnimation()
+ */
+ public function get isSelected():Boolean
+ {
+ return this._isSelected;
+ }
+
+ /**
+ * @private
+ */
+ public function set isSelected(value:Boolean):void
+ {
+ this._animateSelectionChange = false;
+ if(this._isSelected == value)
+ {
+ return;
+ }
+ this._isSelected = value;
+ this.invalidate(INVALIDATION_FLAG_SELECTED);
+ this.dispatchEventWith(Event.CHANGE);
+ }
+
+ /**
+ * @private
+ */
+ protected var _toggleThumbSelection:Boolean = false;
+
+ /**
+ * Determines if the isSelected property of the thumb
+ * is updated to match the isSelected property of the
+ * toggle switch, if the class used to create the thumb implements the
+ * IToggle interface. Useful for skinning to provide a
+ * different appearance for the thumb based on whether the toggle switch
+ * is selected or not.
+ *
+ * In the following example, the thumb selection is toggled:
+ *
+ *
+ * toggle.toggleThumbSelection = true;
+ *
+ * @default false
+ *
+ * @see feathers.core.IToggle
+ * @see feathers.controls.ToggleButton
+ */
+ public function get toggleThumbSelection():Boolean
+ {
+ return this._toggleThumbSelection;
+ }
+
+ /**
+ * @private
+ */
+ public function set toggleThumbSelection(value:Boolean):void
+ {
+ if(this._toggleThumbSelection == value)
+ {
+ return;
+ }
+ this._toggleThumbSelection = value;
+ this.invalidate(INVALIDATION_FLAG_SELECTED);
+ }
+
+ /**
+ * @private
+ */
+ protected var _toggleDuration:Number = 0.15;
+
+ /**
+ * The duration, in seconds, of the animation when the toggle switch
+ * is toggled and animates the position of the thumb.
+ *
+ * In the following example, the duration of the toggle switch thumb
+ * animation is updated:
+ *
+ *
+ * toggle.toggleDuration = 0.5;
+ *
+ * @default 0.15
+ */
+ public function get toggleDuration():Number
+ {
+ return this._toggleDuration;
+ }
+
+ /**
+ * @private
+ */
+ public function set toggleDuration(value:Number):void
+ {
+ this._toggleDuration = value;
+ }
+
+ /**
+ * @private
+ */
+ protected var _toggleEase:Object = Transitions.EASE_OUT;
+
+ /**
+ * The easing function used for toggle animations.
+ *
+ * In the following example, the easing function used by the toggle
+ * switch's thumb animation is updated:
+ *
+ *
+ * toggle.toggleEase = Transitions.EASE_IN_OUT;
+ *
+ * @default starling.animation.Transitions.EASE_OUT
+ *
+ * @see http://doc.starling-framework.org/core/starling/animation/Transitions.html starling.animation.Transitions
+ */
+ public function get toggleEase():Object
+ {
+ return this._toggleEase;
+ }
+
+ /**
+ * @private
+ */
+ public function set toggleEase(value:Object):void
+ {
+ this._toggleEase = value;
+ }
+
+ /**
+ * @private
+ */
+ protected var _onText:String = "ON";
+
+ /**
+ * The text to display in the ON label.
+ *
+ * In the following example, the toggle switch's on label text is
+ * updated:
+ *
+ *
+ * toggle.onText = "on";
+ *
+ * @default "ON"
+ */
+ public function get onText():String
+ {
+ return this._onText;
+ }
+
+ /**
+ * @private
+ */
+ public function set onText(value:String):void
+ {
+ if(value === null)
+ {
+ value = "";
+ }
+ if(this._onText == value)
+ {
+ return;
+ }
+ this._onText = value;
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _offText:String = "OFF";
+
+ /**
+ * The text to display in the OFF label.
+ *
+ * In the following example, the toggle switch's off label text is
+ * updated:
+ *
+ *
+ * toggle.offText = "off";
+ *
+ * @default "OFF"
+ */
+ public function get offText():String
+ {
+ return this._offText;
+ }
+
+ /**
+ * @private
+ */
+ public function set offText(value:String):void
+ {
+ if(value === null)
+ {
+ value = "";
+ }
+ if(this._offText == value)
+ {
+ return;
+ }
+ this._offText = value;
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _toggleTween:Tween;
+
+ /**
+ * @private
+ */
+ protected var _ignoreTapHandler:Boolean = false;
+
+ /**
+ * @private
+ */
+ protected var _touchPointID:int = -1;
+
+ /**
+ * @private
+ */
+ protected var _thumbStartX:Number;
+
+ /**
+ * @private
+ */
+ protected var _touchStartX:Number;
+
+ /**
+ * @private
+ */
+ protected var _animateSelectionChange:Boolean = false;
+
+ /**
+ * @private
+ */
+ protected var _onTrackFactory:Function;
+
+ /**
+ * A function used to generate the toggle switch's on track
+ * sub-component. The on track must be an instance of Button.
+ * This factory can be used to change properties on the on track when it
+ * is first created. For instance, if you are skinning Feathers
+ * components without a theme, you might use this factory to set skins
+ * and other styles on the on track.
+ *
+ * The function should have the following signature:
+ * function():Button
+ *
+ * In the following example, a custom on track factory is passed to
+ * the toggle switch:
+ *
+ *
+ * toggle.onTrackFactory = function():Button
+ * {
+ * var onTrack:Button = new Button();
+ * onTrack.defaultSkin = new Image( texture );
+ * return onTrack;
+ * };
+ *
+ * @default null
+ *
+ * @see feathers.controls.Button
+ * @see #onTrackProperties
+ */
+ public function get onTrackFactory():Function
+ {
+ return this._onTrackFactory;
+ }
+
+ /**
+ * @private
+ */
+ public function set onTrackFactory(value:Function):void
+ {
+ if(this._onTrackFactory == value)
+ {
+ return;
+ }
+ this._onTrackFactory = value;
+ this.invalidate(INVALIDATION_FLAG_ON_TRACK_FACTORY);
+ }
+
+ /**
+ * @private
+ */
+ protected var _customOnTrackStyleName:String;
+
+ /**
+ * A style name to add to the toggle switch's on track sub-component.
+ * Typically used by a theme to provide different styles to different
+ * toggle switches.
+ *
+ * In the following example, a custom on track style name is passed to
+ * the toggle switch:
+ *
+ *
+ * toggle.customOnTrackStyleName = "my-custom-on-track";
+ *
+ * In your theme, you can target this sub-component style name to
+ * provide different styles than the default:
+ *
+ *
+ * getStyleProviderForClass( Button ).setFunctionForStyleName( "my-custom-on-track", setCustomOnTrackStyles );
+ *
+ * @default null
+ *
+ * @see #DEFAULT_CHILD_STYLE_NAME_ON_TRACK
+ * @see feathers.core.FeathersControl#styleNameList
+ * @see #onTrackFactory
+ * @see #onTrackProperties
+ */
+ public function get customOnTrackStyleName():String
+ {
+ return this._customOnTrackStyleName;
+ }
+
+ /**
+ * @private
+ */
+ public function set customOnTrackStyleName(value:String):void
+ {
+ if(this._customOnTrackStyleName == value)
+ {
+ return;
+ }
+ this._customOnTrackStyleName = value;
+ this.invalidate(INVALIDATION_FLAG_ON_TRACK_FACTORY);
+ }
+
+ /**
+ * DEPRECATED: Replaced by customOnTrackStyleName.
+ *
+ * DEPRECATION WARNING: This property is deprecated
+ * starting with Feathers 2.1. It will be removed in a future version of
+ * Feathers according to the standard
+ * Feathers deprecation policy.
+ *
+ * @see #customOnTrackStyleName
+ */
+ public function get customOnTrackName():String
+ {
+ return this.customOnTrackStyleName;
+ }
+
+ /**
+ * @private
+ */
+ public function set customOnTrackName(value:String):void
+ {
+ this.customOnTrackStyleName = value;
+ }
+
+ /**
+ * @private
+ */
+ protected var _onTrackProperties:PropertyProxy;
+
+ /**
+ * A set of key/value pairs to be passed down to the toggle switch's on
+ * track sub-component. The on track is a
+ * feathers.controls.Button instance.
+ *
+ * If the subcomponent has its own subcomponents, their properties
+ * can be set too, using attribute @ notation. For example,
+ * to set the skin on the thumb which is in a SimpleScrollBar,
+ * which is in a List, you can use the following syntax:
+ * list.verticalScrollBarProperties.@thumbProperties.defaultSkin = new Image(texture);
+ *
+ * Setting properties in a onTrackFactory function
+ * instead of using onTrackProperties will result in
+ * better performance.
+ *
+ * In the following example, the toggle switch's on track properties
+ * are updated:
+ *
+ *
+ * toggle.onTrackProperties.defaultSkin = new Image( texture );
+ *
+ * @default null
+ *
+ * @see feathers.controls.Button
+ * @see #onTrackFactory
+ */
+ public function get onTrackProperties():Object
+ {
+ if(!this._onTrackProperties)
+ {
+ this._onTrackProperties = new PropertyProxy(childProperties_onChange);
+ }
+ return this._onTrackProperties;
+ }
+
+ /**
+ * @private
+ */
+ public function set onTrackProperties(value:Object):void
+ {
+ if(this._onTrackProperties == value)
+ {
+ return;
+ }
+ if(!value)
+ {
+ value = new PropertyProxy();
+ }
+ if(!(value is PropertyProxy))
+ {
+ var newValue:PropertyProxy = new PropertyProxy();
+ for(var propertyName:String in value)
+ {
+ newValue[propertyName] = value[propertyName];
+ }
+ value = newValue;
+ }
+ if(this._onTrackProperties)
+ {
+ this._onTrackProperties.removeOnChangeCallback(childProperties_onChange);
+ }
+ this._onTrackProperties = PropertyProxy(value);
+ if(this._onTrackProperties)
+ {
+ this._onTrackProperties.addOnChangeCallback(childProperties_onChange);
+ }
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _offTrackFactory:Function;
+
+ /**
+ * A function used to generate the toggle switch's off track
+ * sub-component. The off track must be an instance of Button.
+ * This factory can be used to change properties on the off track when it
+ * is first created. For instance, if you are skinning Feathers
+ * components without a theme, you might use this factory to set skins
+ * and other styles on the off track.
+ *
+ * The function should have the following signature:
+ * function():Button
+ *
+ * In the following example, a custom off track factory is passed to
+ * the toggle switch:
+ *
+ *
+ * toggle.offTrackFactory = function():Button
+ * {
+ * var offTrack:Button = new Button();
+ * offTrack.defaultSkin = new Image( texture );
+ * return offTrack;
+ * };
+ *
+ * @default null
+ *
+ * @see feathers.controls.Button
+ * @see #offTrackProperties
+ */
+ public function get offTrackFactory():Function
+ {
+ return this._offTrackFactory;
+ }
+
+ /**
+ * @private
+ */
+ public function set offTrackFactory(value:Function):void
+ {
+ if(this._offTrackFactory == value)
+ {
+ return;
+ }
+ this._offTrackFactory = value;
+ this.invalidate(INVALIDATION_FLAG_OFF_TRACK_FACTORY);
+ }
+
+ /**
+ * @private
+ */
+ protected var _customOffTrackStyleName:String;
+
+ /**
+ * A style name to add to the toggle switch's off track sub-component.
+ * Typically used by a theme to provide different styles to different
+ * toggle switches.
+ *
+ * In the following example, a custom off track style name is passed
+ * to the toggle switch:
+ *
+ *
+ * toggle.customOffTrackStyleName = "my-custom-off-track";
+ *
+ * In your theme, you can target this sub-component style name to
+ * provide different styles than the default:
+ *
+ *
+ * getStyleProviderForClass( Button ).setFunctionForStyleName( "my-custom-off-track", setCustomOffTrackStyles );
+ *
+ * @default null
+ *
+ * @see #DEFAULT_CHILD_STYLE_NAME_OFF_TRACK
+ * @see feathers.core.FeathersControl#styleNameList
+ * @see #offTrackFactory
+ * @see #offTrackProperties
+ */
+ public function get customOffTrackStyleName():String
+ {
+ return this._customOffTrackStyleName;
+ }
+
+ /**
+ * @private
+ */
+ public function set customOffTrackStyleName(value:String):void
+ {
+ if(this._customOffTrackStyleName == value)
+ {
+ return;
+ }
+ this._customOffTrackStyleName = value;
+ this.invalidate(INVALIDATION_FLAG_OFF_TRACK_FACTORY);
+ }
+
+ /**
+ * DEPRECATED: Replaced by customOffTrackStyleName.
+ *
+ * DEPRECATION WARNING: This property is deprecated
+ * starting with Feathers 2.1. It will be removed in a future version of
+ * Feathers according to the standard
+ * Feathers deprecation policy.
+ *
+ * @see #customOffTrackStyleName
+ */
+ public function get customOffTrackName():String
+ {
+ return this.customOffTrackStyleName;
+ }
+
+ /**
+ * @private
+ */
+ public function set customOffTrackName(value:String):void
+ {
+ this.customOffTrackStyleName = value;
+ }
+
+ /**
+ * @private
+ */
+ protected var _offTrackProperties:PropertyProxy;
+
+ /**
+ * A set of key/value pairs to be passed down to the toggle switch's off
+ * track sub-component. The off track is a
+ * feathers.controls.Button instance.
+ *
+ * If the subcomponent has its own subcomponents, their properties
+ * can be set too, using attribute @ notation. For example,
+ * to set the skin on the thumb which is in a SimpleScrollBar,
+ * which is in a List, you can use the following syntax:
+ * list.verticalScrollBarProperties.@thumbProperties.defaultSkin = new Image(texture);
+ *
+ * Setting properties in a offTrackFactory function
+ * instead of using offTrackProperties will result in
+ * better performance.
+ *
+ * In the following example, the toggle switch's off track properties
+ * are updated:
+ *
+ *
+ * toggle.offTrackProperties.defaultSkin = new Image( texture );
+ *
+ * @default null
+ *
+ * @see feathers.controls.Button
+ * @see #offTrackFactory
+ */
+ public function get offTrackProperties():Object
+ {
+ if(!this._offTrackProperties)
+ {
+ this._offTrackProperties = new PropertyProxy(childProperties_onChange);
+ }
+ return this._offTrackProperties;
+ }
+
+ /**
+ * @private
+ */
+ public function set offTrackProperties(value:Object):void
+ {
+ if(this._offTrackProperties == value)
+ {
+ return;
+ }
+ if(!value)
+ {
+ value = new PropertyProxy();
+ }
+ if(!(value is PropertyProxy))
+ {
+ var newValue:PropertyProxy = new PropertyProxy();
+ for(var propertyName:String in value)
+ {
+ newValue[propertyName] = value[propertyName];
+ }
+ value = newValue;
+ }
+ if(this._offTrackProperties)
+ {
+ this._offTrackProperties.removeOnChangeCallback(childProperties_onChange);
+ }
+ this._offTrackProperties = PropertyProxy(value);
+ if(this._offTrackProperties)
+ {
+ this._offTrackProperties.addOnChangeCallback(childProperties_onChange);
+ }
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _thumbFactory:Function;
+
+ /**
+ * A function used to generate the toggle switch's thumb sub-component.
+ * This can be used to change properties on the thumb when it is first
+ * created. For instance, if you are skinning Feathers components
+ * without a theme, you might use thumbFactory to set
+ * skins and text styles on the thumb.
+ *
+ * The function should have the following signature:
+ * function():Button
+ *
+ * In the following example, a custom thumb factory is passed to the
+ * toggle switch:
+ *
+ *
+ * toggle.thumbFactory = function():Button
+ * {
+ * var button:Button = new Button();
+ * button.defaultSkin = new Image( texture );
+ * return button;
+ * };
+ *
+ * @default null
+ *
+ * @see #thumbProperties
+ */
+ public function get thumbFactory():Function
+ {
+ return this._thumbFactory;
+ }
+
+ /**
+ * @private
+ */
+ public function set thumbFactory(value:Function):void
+ {
+ if(this._thumbFactory == value)
+ {
+ return;
+ }
+ this._thumbFactory = value;
+ this.invalidate(INVALIDATION_FLAG_THUMB_FACTORY);
+ }
+
+ /**
+ * @private
+ */
+ protected var _customThumbStyleName:String;
+
+ /**
+ * A style name to add to the toggle switch's thumb sub-component.
+ * Typically used by a theme to provide different styles to different
+ * toggle switches.
+ *
+ * In the following example, a custom thumb style name is passed to
+ * the toggle switch:
+ *
+ *
+ * toggle.customThumbStyleName = "my-custom-thumb";
+ *
+ * In your theme, you can target this sub-component style name to
+ * provide different styles than the default:
+ *
+ *
+ * getStyleProviderForClass( Button ).setFunctionForStyleName( "my-custom-thumb", setCustomThumbStyles );
+ *
+ * @default null
+ *
+ * @see #DEFAULT_CHILD_STYLE_NAME_THUMB
+ * @see feathers.core.FeathersControl#styleNameList
+ * @see #thumbFactory
+ * @see #thumbProperties
+ */
+ public function get customThumbStyleName():String
+ {
+ return this._customThumbStyleName;
+ }
+
+ /**
+ * @private
+ */
+ public function set customThumbStyleName(value:String):void
+ {
+ if(this._customThumbStyleName == value)
+ {
+ return;
+ }
+ this._customThumbStyleName = value;
+ this.invalidate(INVALIDATION_FLAG_THUMB_FACTORY);
+ }
+
+ /**
+ * DEPRECATED: Replaced by customThumbStyleName.
+ *
+ * DEPRECATION WARNING: This property is deprecated
+ * starting with Feathers 2.1. It will be removed in a future version of
+ * Feathers according to the standard
+ * Feathers deprecation policy.
+ *
+ * @see #customThumbStyleName
+ */
+ public function get customThumbName():String
+ {
+ return this.customThumbStyleName;
+ }
+
+ /**
+ * @private
+ */
+ public function set customThumbName(value:String):void
+ {
+ this.customThumbStyleName = value;
+ }
+
+ /**
+ * @private
+ */
+ protected var _thumbProperties:PropertyProxy;
+
+ /**
+ * A set of key/value pairs to be passed down to the toggle switch's
+ * thumb sub-component. The thumb is a
+ * feathers.controls.Button instance.
+ *
+ * If the subcomponent has its own subcomponents, their properties
+ * can be set too, using attribute @ notation. For example,
+ * to set the skin on the thumb which is in a SimpleScrollBar,
+ * which is in a List, you can use the following syntax:
+ * list.verticalScrollBarProperties.@thumbProperties.defaultSkin = new Image(texture);
+ *
+ * Setting properties in a thumbFactory function instead
+ * of using thumbProperties will result in better
+ * performance.
+ *
+ * In the following example, the toggle switch's thumb properties
+ * are updated:
+ *
+ *
+ * toggle.thumbProperties.defaultSkin = new Image( texture );
+ *
+ * @default null
+ *
+ * @see feathers.controls.Button
+ * @see #thumbFactory
+ */
+ public function get thumbProperties():Object
+ {
+ if(!this._thumbProperties)
+ {
+ this._thumbProperties = new PropertyProxy(childProperties_onChange);
+ }
+ return this._thumbProperties;
+ }
+
+ /**
+ * @private
+ */
+ public function set thumbProperties(value:Object):void
+ {
+ if(this._thumbProperties == value)
+ {
+ return;
+ }
+ if(!value)
+ {
+ value = new PropertyProxy();
+ }
+ if(!(value is PropertyProxy))
+ {
+ var newValue:PropertyProxy = new PropertyProxy();
+ for(var propertyName:String in value)
+ {
+ newValue[propertyName] = value[propertyName];
+ }
+ value = newValue;
+ }
+ if(this._thumbProperties)
+ {
+ this._thumbProperties.removeOnChangeCallback(childProperties_onChange);
+ }
+ this._thumbProperties = PropertyProxy(value);
+ if(this._thumbProperties)
+ {
+ this._thumbProperties.addOnChangeCallback(childProperties_onChange);
+ }
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * Changes the isSelected property, but animates the thumb
+ * to the new position, as if the user tapped the toggle switch.
+ *
+ * @see #isSelected
+ */
+ public function setSelectionWithAnimation(isSelected:Boolean):void
+ {
+ if(this._isSelected == isSelected)
+ {
+ return;
+ }
+ this.isSelected = isSelected;
+ this._animateSelectionChange = true;
+ }
+
+ /**
+ * @private
+ */
+ override protected function draw():void
+ {
+ var selectionInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_SELECTED);
+ var stylesInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_STYLES);
+ var sizeInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_SIZE);
+ var stateInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_STATE);
+ var focusInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_FOCUS);
+ var layoutInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_LAYOUT);
+ var textRendererInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_TEXT_RENDERER);
+ var thumbFactoryInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_THUMB_FACTORY);
+ var onTrackFactoryInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_ON_TRACK_FACTORY);
+ var offTrackFactoryInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_OFF_TRACK_FACTORY);
+
+ if(thumbFactoryInvalid)
+ {
+ this.createThumb();
+ }
+
+ if(onTrackFactoryInvalid)
+ {
+ this.createOnTrack();
+ }
+
+ if(offTrackFactoryInvalid || layoutInvalid)
+ {
+ this.createOffTrack();
+ }
+
+ if(textRendererInvalid)
+ {
+ this.createLabels();
+ }
+
+ if(textRendererInvalid || stylesInvalid || stateInvalid)
+ {
+ this.refreshOnLabelStyles();
+ this.refreshOffLabelStyles();
+ }
+
+ if(thumbFactoryInvalid || stylesInvalid)
+ {
+ this.refreshThumbStyles();
+ }
+ if(onTrackFactoryInvalid || stylesInvalid)
+ {
+ this.refreshOnTrackStyles();
+ }
+ if((offTrackFactoryInvalid || layoutInvalid || stylesInvalid) && this.offTrack)
+ {
+ this.refreshOffTrackStyles();
+ }
+
+ if(thumbFactoryInvalid || stateInvalid)
+ {
+ this.thumb.isEnabled = this._isEnabled;
+ }
+ if(onTrackFactoryInvalid || stateInvalid)
+ {
+ this.onTrack.isEnabled = this._isEnabled;
+ }
+ if((offTrackFactoryInvalid || layoutInvalid || stateInvalid) && this.offTrack)
+ {
+ this.offTrack.isEnabled = this._isEnabled;
+ }
+ if(textRendererInvalid || stateInvalid)
+ {
+ this.onTextRenderer.isEnabled = this._isEnabled;
+ this.offTextRenderer.isEnabled = this._isEnabled;
+ }
+
+ sizeInvalid = this.autoSizeIfNeeded() || sizeInvalid;
+
+ if(sizeInvalid || stylesInvalid || selectionInvalid)
+ {
+ this.updateSelection();
+ }
+
+ this.layoutChildren();
+
+ if(sizeInvalid || focusInvalid)
+ {
+ this.refreshFocusIndicator();
+ }
+ }
+
+ /**
+ * If the component's dimensions have not been set explicitly, it will
+ * measure its content and determine an ideal size for itself. If the
+ * explicitWidth or explicitHeight member
+ * variables are set, those value will be used without additional
+ * measurement. If one is set, but not the other, the dimension with the
+ * explicit value will not be measured, but the other non-explicit
+ * dimension will still need measurement.
+ *
+ * Calls setSizeInternal() to set up the
+ * actualWidth and actualHeight member
+ * variables used for layout.
+ *
+ * Meant for internal use, and subclasses may override this function
+ * with a custom implementation.
+ */
+ protected function autoSizeIfNeeded():Boolean
+ {
+ if(this.onTrackSkinOriginalWidth !== this.onTrackSkinOriginalWidth || //isNaN
+ this.onTrackSkinOriginalHeight !== this.onTrackSkinOriginalHeight) //isNaN
+ {
+ this.onTrack.validate();
+ this.onTrackSkinOriginalWidth = this.onTrack.width;
+ this.onTrackSkinOriginalHeight = this.onTrack.height;
+ }
+ if(this.offTrack)
+ {
+ if(this.offTrackSkinOriginalWidth !== this.offTrackSkinOriginalWidth || //isNaN
+ this.offTrackSkinOriginalHeight !== this.offTrackSkinOriginalHeight) //isNaN
+ {
+ this.offTrack.validate();
+ this.offTrackSkinOriginalWidth = this.offTrack.width;
+ this.offTrackSkinOriginalHeight = this.offTrack.height;
+ }
+ }
+
+ var needsWidth:Boolean = this.explicitWidth !== this.explicitWidth; //isNaN
+ var needsHeight:Boolean = this.explicitHeight !== this.explicitHeight; //isNaN
+ if(!needsWidth && !needsHeight)
+ {
+ return false;
+ }
+ this.thumb.validate();
+ var newWidth:Number = this.explicitWidth;
+ var newHeight:Number = this.explicitHeight;
+ if(needsWidth)
+ {
+ if(this.offTrack)
+ {
+ newWidth = Math.min(this.onTrackSkinOriginalWidth, this.offTrackSkinOriginalWidth) + this.thumb.width / 2;
+ }
+ else
+ {
+ newWidth = this.onTrackSkinOriginalWidth;
+ }
+ }
+ if(needsHeight)
+ {
+ if(this.offTrack)
+ {
+ newHeight = Math.max(this.onTrackSkinOriginalHeight, this.offTrackSkinOriginalHeight);
+ }
+ else
+ {
+ newHeight = this.onTrackSkinOriginalHeight;
+ }
+ }
+ return this.setSizeInternal(newWidth, newHeight, false);
+ }
+
+ /**
+ * Creates and adds the thumb sub-component and
+ * removes the old instance, if one exists.
+ *
+ * Meant for internal use, and subclasses may override this function
+ * with a custom implementation.
+ *
+ * @see #thumb
+ * @see #thumbFactory
+ * @see #customThumbStyleName
+ */
+ protected function createThumb():void
+ {
+ if(this.thumb)
+ {
+ this.thumb.removeFromParent(true);
+ this.thumb = null;
+ }
+
+ var factory:Function = this._thumbFactory != null ? this._thumbFactory : defaultThumbFactory;
+ var thumbStyleName:String = this._customThumbStyleName != null ? this._customThumbStyleName : this.thumbStyleName;
+ this.thumb = Button(factory());
+ this.thumb.styleNameList.add(thumbStyleName);
+ this.thumb.keepDownStateOnRollOut = true;
+ this.thumb.addEventListener(TouchEvent.TOUCH, thumb_touchHandler);
+ this.addChild(this.thumb);
+ }
+
+ /**
+ * Creates and adds the onTrack sub-component and
+ * removes the old instance, if one exists.
+ *
+ * Meant for internal use, and subclasses may override this function
+ * with a custom implementation.
+ *
+ * @see #onTrack
+ * @see #onTrackFactory
+ * @see #customOnTrackStyleName
+ */
+ protected function createOnTrack():void
+ {
+ if(this.onTrack)
+ {
+ this.onTrack.removeFromParent(true);
+ this.onTrack = null;
+ }
+
+ var factory:Function = this._onTrackFactory != null ? this._onTrackFactory : defaultOnTrackFactory;
+ var onTrackStyleName:String = this._customOnTrackStyleName != null ? this._customOnTrackStyleName : this.onTrackStyleName;
+ this.onTrack = Button(factory());
+ this.onTrack.styleNameList.add(onTrackStyleName);
+ this.onTrack.keepDownStateOnRollOut = true;
+ this.addChildAt(this.onTrack, 0);
+ }
+
+ /**
+ * Creates and adds the offTrack sub-component and
+ * removes the old instance, if one exists. If the off track is not
+ * needed, it will not be created.
+ *
+ * Meant for internal use, and subclasses may override this function
+ * with a custom implementation.
+ *
+ * @see #offTrack
+ * @see #offTrackFactory
+ * @see #customOffTrackStyleName
+ */
+ protected function createOffTrack():void
+ {
+ if(this._trackLayoutMode == TRACK_LAYOUT_MODE_ON_OFF)
+ {
+ if(this.offTrack)
+ {
+ this.offTrack.removeFromParent(true);
+ this.offTrack = null;
+ }
+ var factory:Function = this._offTrackFactory != null ? this._offTrackFactory : defaultOffTrackFactory;
+ var offTrackStyleName:String = this._customOffTrackStyleName != null ? this._customOffTrackStyleName : this.offTrackStyleName;
+ this.offTrack = Button(factory());
+ this.offTrack.styleNameList.add(offTrackStyleName);
+ this.offTrack.keepDownStateOnRollOut = true;
+ this.addChildAt(this.offTrack, 1);
+ }
+ else if(this.offTrack) //single
+ {
+ this.offTrack.removeFromParent(true);
+ this.offTrack = null;
+ }
+ }
+
+ /**
+ * @private
+ */
+ protected function createLabels():void
+ {
+ if(this.offTextRenderer)
+ {
+ this.removeChild(DisplayObject(this.offTextRenderer), true);
+ this.offTextRenderer = null;
+ }
+ if(this.onTextRenderer)
+ {
+ this.removeChild(DisplayObject(this.onTextRenderer), true);
+ this.onTextRenderer = null;
+ }
+
+ var index:int = this.getChildIndex(this.thumb);
+ var offLabelFactory:Function = this._offLabelFactory;
+ if(offLabelFactory == null)
+ {
+ offLabelFactory = this._labelFactory;
+ }
+ if(offLabelFactory == null)
+ {
+ offLabelFactory = FeathersControl.defaultTextRendererFactory;
+ }
+ this.offTextRenderer = ITextRenderer(offLabelFactory());
+ this.offTextRenderer.styleNameList.add(this.offLabelName);
+ this.offTextRenderer.clipRect = new Rectangle();
+ this.addChildAt(DisplayObject(this.offTextRenderer), index);
+
+ var onLabelFactory:Function = this._onLabelFactory;
+ if(onLabelFactory == null)
+ {
+ onLabelFactory = this._labelFactory;
+ }
+ if(onLabelFactory == null)
+ {
+ onLabelFactory = FeathersControl.defaultTextRendererFactory;
+ }
+ this.onTextRenderer = ITextRenderer(onLabelFactory());
+ this.onTextRenderer.styleNameList.add(this.onLabelName);
+ this.onTextRenderer.clipRect = new Rectangle();
+ this.addChildAt(DisplayObject(this.onTextRenderer), index);
+ }
+
+ /**
+ * @private
+ */
+ protected function layoutChildren():void
+ {
+ this.thumb.validate();
+ this.thumb.y = (this.actualHeight - this.thumb.height) / 2;
+
+ var maxLabelWidth:Number = Math.max(0, this.actualWidth - this.thumb.width - this._paddingLeft - this._paddingRight);
+ var totalLabelHeight:Number = Math.max(this.onTextRenderer.height, this.offTextRenderer.height);
+ var labelHeight:Number;
+ if(this._labelAlign == LABEL_ALIGN_MIDDLE)
+ {
+ labelHeight = totalLabelHeight;
+ }
+ else //baseline
+ {
+ labelHeight = Math.max(this.onTextRenderer.baseline, this.offTextRenderer.baseline);
+ }
+
+ var clipRect:Rectangle = this.onTextRenderer.clipRect;
+ clipRect.width = maxLabelWidth;
+ clipRect.height = totalLabelHeight;
+ this.onTextRenderer.clipRect = clipRect;
+
+ this.onTextRenderer.y = (this.actualHeight - labelHeight) / 2;
+
+ clipRect = this.offTextRenderer.clipRect;
+ clipRect.width = maxLabelWidth;
+ clipRect.height = totalLabelHeight;
+ this.offTextRenderer.clipRect = clipRect;
+
+ this.offTextRenderer.y = (this.actualHeight - labelHeight) / 2;
+
+ this.layoutTracks();
+ }
+
+ /**
+ * @private
+ */
+ protected function layoutTracks():void
+ {
+ var maxLabelWidth:Number = Math.max(0, this.actualWidth - this.thumb.width - this._paddingLeft - this._paddingRight);
+ var thumbOffset:Number = this.thumb.x - this._paddingLeft;
+
+ var onScrollOffset:Number = maxLabelWidth - thumbOffset - (maxLabelWidth - this.onTextRenderer.width) / 2;
+ var currentClipRect:Rectangle = this.onTextRenderer.clipRect;
+ currentClipRect.x = onScrollOffset
+ this.onTextRenderer.clipRect = currentClipRect;
+ this.onTextRenderer.x = this._paddingLeft - onScrollOffset;
+
+ var offScrollOffset:Number = -thumbOffset - (maxLabelWidth - this.offTextRenderer.width) / 2;
+ currentClipRect = this.offTextRenderer.clipRect;
+ currentClipRect.x = offScrollOffset
+ this.offTextRenderer.clipRect = currentClipRect;
+ this.offTextRenderer.x = this.actualWidth - this._paddingRight - maxLabelWidth - offScrollOffset;
+
+ if(this._trackLayoutMode == TRACK_LAYOUT_MODE_ON_OFF)
+ {
+ this.layoutTrackWithOnOff();
+ }
+ else
+ {
+ this.layoutTrackWithSingle();
+ }
+ }
+
+ /**
+ * @private
+ */
+ protected function updateSelection():void
+ {
+ if(this.thumb is IToggle)
+ {
+ var toggleThumb:IToggle = IToggle(this.thumb);
+ if(this._toggleThumbSelection)
+ {
+ toggleThumb.isSelected = this._isSelected;
+ }
+ else
+ {
+ toggleThumb.isSelected = false;
+ }
+ }
+ this.thumb.validate();
+
+ var xPosition:Number = this._paddingLeft;
+ if(this._isSelected)
+ {
+ xPosition = this.actualWidth - this.thumb.width - this._paddingRight;
+ }
+
+ //stop the tween, no matter what
+ if(this._toggleTween)
+ {
+ Starling.juggler.remove(this._toggleTween);
+ this._toggleTween = null;
+ }
+
+ if(this._animateSelectionChange)
+ {
+ this._toggleTween = new Tween(this.thumb, this._toggleDuration, this._toggleEase);
+ this._toggleTween.animate("x", xPosition);
+ this._toggleTween.onUpdate = selectionTween_onUpdate;
+ this._toggleTween.onComplete = selectionTween_onComplete;
+ Starling.juggler.add(this._toggleTween);
+ }
+ else
+ {
+ this.thumb.x = xPosition;
+ }
+ this._animateSelectionChange = false;
+ }
+
+ /**
+ * @private
+ */
+ protected function refreshOnLabelStyles():void
+ {
+ //no need to style the label field if there's no text to display
+ if(!this._showLabels || !this._showThumb)
+ {
+ this.onTextRenderer.visible = false;
+ return;
+ }
+
+ var properties:PropertyProxy;
+ if(!this._isEnabled)
+ {
+ properties = this._disabledLabelProperties;
+ }
+ if(!properties && this._onLabelProperties)
+ {
+ properties = this._onLabelProperties;
+ }
+ if(!properties)
+ {
+ properties = this._defaultLabelProperties;
+ }
+
+ this.onTextRenderer.text = this._onText;
+ if(properties)
+ {
+ var displayRenderer:DisplayObject = DisplayObject(this.onTextRenderer);
+ for(var propertyName:String in properties)
+ {
+ var propertyValue:Object = properties[propertyName];
+ displayRenderer[propertyName] = propertyValue;
+ }
+ }
+ this.onTextRenderer.validate();
+ this.onTextRenderer.visible = true;
+ }
+
+ /**
+ * @private
+ */
+ protected function refreshOffLabelStyles():void
+ {
+ //no need to style the label field if there's no text to display
+ if(!this._showLabels || !this._showThumb)
+ {
+ this.offTextRenderer.visible = false;
+ return;
+ }
+
+ var properties:PropertyProxy;
+ if(!this._isEnabled)
+ {
+ properties = this._disabledLabelProperties;
+ }
+ if(!properties && this._offLabelProperties)
+ {
+ properties = this._offLabelProperties;
+ }
+ if(!properties)
+ {
+ properties = this._defaultLabelProperties;
+ }
+
+ this.offTextRenderer.text = this._offText;
+ if(properties)
+ {
+ var displayRenderer:DisplayObject = DisplayObject(this.offTextRenderer);
+ for(var propertyName:String in properties)
+ {
+ var propertyValue:Object = properties[propertyName];
+ displayRenderer[propertyName] = propertyValue;
+ }
+ }
+ this.offTextRenderer.validate();
+ this.offTextRenderer.visible = true;
+ }
+
+ /**
+ * @private
+ */
+ protected function refreshThumbStyles():void
+ {
+ for(var propertyName:String in this._thumbProperties)
+ {
+ var propertyValue:Object = this._thumbProperties[propertyName];
+ this.thumb[propertyName] = propertyValue;
+ }
+ this.thumb.visible = this._showThumb;
+ }
+
+ /**
+ * @private
+ */
+ protected function refreshOnTrackStyles():void
+ {
+ for(var propertyName:String in this._onTrackProperties)
+ {
+ var propertyValue:Object = this._onTrackProperties[propertyName];
+ this.onTrack[propertyName] = propertyValue;
+ }
+ }
+
+ /**
+ * @private
+ */
+ protected function refreshOffTrackStyles():void
+ {
+ if(!this.offTrack)
+ {
+ return;
+ }
+ for(var propertyName:String in this._offTrackProperties)
+ {
+ var propertyValue:Object = this._offTrackProperties[propertyName];
+ this.offTrack[propertyName] = propertyValue;
+ }
+ }
+
+ /**
+ * @private
+ */
+ protected function layoutTrackWithOnOff():void
+ {
+ this.onTrack.x = 0;
+ this.onTrack.y = 0;
+ this.onTrack.width = this.thumb.x + this.thumb.width / 2;
+ this.onTrack.height = this.actualHeight;
+
+ this.offTrack.x = this.onTrack.width;
+ this.offTrack.y = 0;
+ this.offTrack.width = this.actualWidth - this.offTrack.x;
+ this.offTrack.height = this.actualHeight;
+
+ //final validation to avoid juggler next frame issues
+ this.onTrack.validate();
+ this.offTrack.validate();
+ }
+
+ /**
+ * @private
+ */
+ protected function layoutTrackWithSingle():void
+ {
+ this.onTrack.x = 0;
+ this.onTrack.y = 0;
+ this.onTrack.width = this.actualWidth;
+ this.onTrack.height = this.actualHeight;
+
+ //final validation to avoid juggler next frame issues
+ this.onTrack.validate();
+ }
+
+ /**
+ * @private
+ */
+ protected function childProperties_onChange(proxy:PropertyProxy, name:Object):void
+ {
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected function toggleSwitch_removedFromStageHandler(event:Event):void
+ {
+ this._touchPointID = -1;
+ }
+
+ /**
+ * @private
+ */
+ override protected function focusInHandler(event:Event):void
+ {
+ super.focusInHandler(event);
+ this.stage.addEventListener(KeyboardEvent.KEY_DOWN, stage_keyDownHandler);
+ this.stage.addEventListener(KeyboardEvent.KEY_UP, stage_keyUpHandler);
+ }
+
+ /**
+ * @private
+ */
+ override protected function focusOutHandler(event:Event):void
+ {
+ super.focusOutHandler(event);
+ this.stage.removeEventListener(KeyboardEvent.KEY_DOWN, stage_keyDownHandler);
+ this.stage.removeEventListener(KeyboardEvent.KEY_UP, stage_keyUpHandler);
+ }
+
+ /**
+ * @private
+ */
+ protected function toggleSwitch_touchHandler(event:TouchEvent):void
+ {
+ if(this._ignoreTapHandler)
+ {
+ this._ignoreTapHandler = false;
+ return;
+ }
+ if(!this._isEnabled)
+ {
+ this._touchPointID = -1;
+ return;
+ }
+
+ var touch:Touch = event.getTouch(this, TouchPhase.ENDED);
+ if(!touch)
+ {
+ return;
+ }
+ this._touchPointID = -1;
+ touch.getLocation(this.stage, HELPER_POINT);
+ var isInBounds:Boolean = this.contains(this.stage.hitTest(HELPER_POINT, true));
+ if(isInBounds)
+ {
+ this.setSelectionWithAnimation(!this._isSelected);
+ }
+ }
+
+ /**
+ * @private
+ */
+ protected function thumb_touchHandler(event:TouchEvent):void
+ {
+ if(!this._isEnabled)
+ {
+ this._touchPointID = -1;
+ return;
+ }
+
+ if(this._touchPointID >= 0)
+ {
+ var touch:Touch = event.getTouch(this.thumb, null, this._touchPointID);
+ if(!touch)
+ {
+ return;
+ }
+ touch.getLocation(this, HELPER_POINT);
+ var trackScrollableWidth:Number = this.actualWidth - this._paddingLeft - this._paddingRight - this.thumb.width;
+ if(touch.phase == TouchPhase.MOVED)
+ {
+ var xOffset:Number = HELPER_POINT.x - this._touchStartX;
+ var xPosition:Number = Math.min(Math.max(this._paddingLeft, this._thumbStartX + xOffset), this._paddingLeft + trackScrollableWidth);
+ this.thumb.x = xPosition;
+ this.layoutTracks();
+ }
+ else if(touch.phase == TouchPhase.ENDED)
+ {
+ var pixelsMoved:Number = Math.abs(HELPER_POINT.x - this._touchStartX);
+ var inchesMoved:Number = pixelsMoved / DeviceCapabilities.dpi;
+ if(inchesMoved > MINIMUM_DRAG_DISTANCE || (SystemUtil.isDesktop && pixelsMoved >= 1))
+ {
+ this._touchPointID = -1;
+ this._ignoreTapHandler = true;
+ this.setSelectionWithAnimation(this.thumb.x > (this._paddingLeft + trackScrollableWidth / 2));
+ //we still need to invalidate, even if there's no change
+ //because the thumb may be in the middle!
+ this.invalidate(INVALIDATION_FLAG_SELECTED);
+ }
+ }
+ }
+ else
+ {
+ touch = event.getTouch(this.thumb, TouchPhase.BEGAN);
+ if(!touch)
+ {
+ return;
+ }
+ touch.getLocation(this, HELPER_POINT);
+ this._touchPointID = touch.id;
+ this._thumbStartX = this.thumb.x;
+ this._touchStartX = HELPER_POINT.x;
+ }
+ }
+
+ /**
+ * @private
+ */
+ protected function stage_keyDownHandler(event:KeyboardEvent):void
+ {
+ if(event.keyCode == Keyboard.ESCAPE)
+ {
+ this._touchPointID = -1;
+ }
+ if(this._touchPointID >= 0 || event.keyCode != Keyboard.SPACE)
+ {
+ return;
+ }
+ this._touchPointID = int.MAX_VALUE;
+ }
+
+ /**
+ * @private
+ */
+ protected function stage_keyUpHandler(event:KeyboardEvent):void
+ {
+ if(this._touchPointID != int.MAX_VALUE || event.keyCode != Keyboard.SPACE)
+ {
+ return;
+ }
+ this._touchPointID = -1;
+ this.setSelectionWithAnimation(!this._isSelected);
+ }
+
+ /**
+ * @private
+ */
+ protected function selectionTween_onUpdate():void
+ {
+ this.layoutTracks();
+ }
+
+ /**
+ * @private
+ */
+ protected function selectionTween_onComplete():void
+ {
+ this._toggleTween = null;
+ }
+ }
+}
\ No newline at end of file
diff --git a/source/feathers/controls/WebView.as b/source/feathers/controls/WebView.as
new file mode 100644
index 0000000000..af725ae967
--- /dev/null
+++ b/source/feathers/controls/WebView.as
@@ -0,0 +1,540 @@
+/*
+Feathers
+Copyright 2012-2014 Joshua Tynjala. All Rights Reserved.
+
+This program is free software. You can redistribute and/or modify it in
+accordance with the terms of the accompanying license agreement.
+*/
+package feathers.controls
+{
+ import feathers.core.FeathersControl;
+ import feathers.events.FeathersEventType;
+ import feathers.utils.geom.matrixToScaleX;
+ import feathers.utils.geom.matrixToScaleY;
+
+ import flash.errors.IllegalOperationError;
+ import flash.events.ErrorEvent;
+ import flash.geom.Matrix;
+ import flash.geom.Point;
+ import flash.geom.Rectangle;
+ import flash.utils.getDefinitionByName;
+
+ import starling.core.RenderSupport;
+ import starling.core.Starling;
+ import starling.display.DisplayObject;
+ import starling.events.Event;
+ import starling.utils.MatrixUtil;
+
+ /**
+ * Dispatched when a URL has finished loading with loadURL() or a
+ * string has finished loading with loadString().
+ *
+ * The properties of the event object have the following values:
+ *
+ * | Property | Value |
|---|
+ * bubbles | false |
+ * currentTarget | The Object that defines the
+ * event listener that handles the event. For example, if you use
+ * myButton.addEventListener() to register an event listener,
+ * myButton is the value of the currentTarget. |
+ * data | null |
+ * target | The Object that dispatched the event;
+ * it is not always the Object listening for the event. Use the
+ * currentTarget property to always access the Object
+ * listening for the event. |
+ *
+ *
+ * @eventType starling.events.Event.COMPLETE
+ *
+ * @see #loadURL()
+ * @see #loadString()
+ */
+ [Event(name="complete",type="starling.events.Event")]
+
+ /**
+ * Indicates that the location property has changed.
+ *
+ * The properties of the event object have the following values:
+ *
+ * | Property | Value |
|---|
+ * bubbles | false |
+ * currentTarget | The Object that defines the
+ * event listener that handles the event. For example, if you use
+ * myButton.addEventListener() to register an event listener,
+ * myButton is the value of the currentTarget. |
+ * data | null |
+ * target | The Object that dispatched the event;
+ * it is not always the Object listening for the event. Use the
+ * currentTarget property to always access the Object
+ * listening for the event. |
+ *
+ *
+ * @see #location
+ */
+ [Event(name="locationChange",type="starling.events.Event")]
+
+ /**
+ * Indicates that an error occurred in the StageWebView.
+ *
+ * The properties of the event object have the following values:
+ *
+ * | Property | Value |
|---|
+ * bubbles | false |
+ * currentTarget | The Object that defines the
+ * event listener that handles the event. For example, if you use
+ * myButton.addEventListener() to register an event listener,
+ * myButton is the value of the currentTarget. |
+ * data | The flash.events.ErrorEvent
+ * dispatched by the StageWebView. |
+ * target | The Object that dispatched the event;
+ * it is not always the Object listening for the event. Use the
+ * currentTarget property to always access the Object
+ * listening for the event. |
+ *
+ *
+ * @eventType feathers.events.FeathersEventType.ERROR
+ */
+ [Event(name="error",type="starling.events.Event")]
+
+ /**
+ * A Feathers component that displays a web browser in Adobe AIR, using the
+ * flash.media.StageWebView class.
+ *
+ * Warning: This component is only compatible with Adobe AIR. It cannot
+ * be used with Adobe Flash Player in a web browser.
+ *
+ * Beta Component: This is a new component, and its APIs
+ * may need some changes between now and the next version of Feathers to
+ * account for overlooked requirements or other issues. Upgrading to future
+ * versions of Feathers may involve manual changes to your code that uses
+ * this component. The
+ * Feathers deprecation policy
+ * will not go into effect until this component's status is upgraded from
+ * beta to stable.
+ *
+ * @see ../../../help/web-view.html How to use the Feathers WebView component
+ */
+ public class WebView extends FeathersControl
+ {
+ /**
+ * @private
+ */
+ private static const HELPER_MATRIX:Matrix = new Matrix();
+
+ /**
+ * @private
+ */
+ private static const HELPER_POINT:Point = new Point();
+
+ /**
+ * @private
+ */
+ protected static const STAGE_WEB_VIEW_NOT_SUPPORTED_ERROR:String = "Feathers WebView is only supported in Adobe AIR. It cannot be used in Adobe Flash Player.";
+
+ /**
+ * @private
+ */
+ protected static const USE_NATIVE_ERROR:String = "The useNative property may only be set before the WebView component validates for the first time.";
+
+ /**
+ * @private
+ */
+ protected static const DEFAULT_SIZE:Number = 320;
+
+ /**
+ * @private
+ */
+ protected static const STAGE_WEB_VIEW_FULLY_QUALIFIED_CLASS_NAME:String = "flash.media.StageWebView";
+
+ /**
+ * @private
+ */
+ protected static var STAGE_WEB_VIEW_CLASS:Class;
+
+ /**
+ * Indicates if this component is supported on the current platform.
+ */
+ public static function get isSupported():Boolean
+ {
+ if(!STAGE_WEB_VIEW_CLASS)
+ {
+ try
+ {
+ STAGE_WEB_VIEW_CLASS = Class(getDefinitionByName(STAGE_WEB_VIEW_FULLY_QUALIFIED_CLASS_NAME));
+ }
+ catch(error:Error)
+ {
+ return false;
+ }
+ }
+ return STAGE_WEB_VIEW_CLASS.isSupported;
+ }
+
+ /**
+ * Constructor.
+ */
+ public function WebView()
+ {
+ this.addEventListener(Event.ADDED_TO_STAGE, webView_addedToStageHandler);
+ this.addEventListener(Event.REMOVED_FROM_STAGE, webView_removedFromStageHandler);
+ }
+
+ /**
+ * @private
+ */
+ protected var stageWebView:Object;
+
+ /**
+ * @private
+ */
+ protected var _useNative:Boolean = false;
+
+ /**
+ * Determines if the system native web browser control is used or if
+ * Adobe AIR's embedded version of the WebKit engine is used.
+ *
+ * Note: Although it is not prohibited, with some content, failures can occur when the same process uses both the embedded and the system WebKit, so it is recommended that all StageWebViews in a given application be constructed with the same value for useNative. In addition, as HTMLLoader depends on the embedded WebKit, applications using HTMLLoader should only construct StageWebViews with useNative set to false.
+ */
+ public function get useNative():Boolean
+ {
+ return this._useNative;
+ }
+
+ /**
+ * @private
+ */
+ public function set useNative(value:Boolean):void
+ {
+ if(this.isCreated)
+ {
+ throw new IllegalOperationError(USE_NATIVE_ERROR);
+ }
+ this._useNative = value;
+ }
+
+ /**
+ * The URL of the currently loaded page.
+ *
+ * @see http://help.adobe.com/en_US/FlashPlatform/reference/actionscript/3/flash/media/StageWebView.html#location Full description of flash.media.StageWebView.location in Adobe's Flash Platform API Reference
+ */
+ public function get location():String
+ {
+ if(this.stageWebView)
+ {
+ return this.stageWebView.location;
+ }
+ return null;
+ }
+
+ /**
+ * The title of the currently loaded page.
+ *
+ * @see http://help.adobe.com/en_US/FlashPlatform/reference/actionscript/3/flash/media/StageWebView.html#title Full description of flash.media.StageWebView.title in Adobe's Flash Platform API Reference
+ */
+ public function get title():String
+ {
+ if(this.stageWebView)
+ {
+ return this.stageWebView.title;
+ }
+ return null;
+ }
+
+ /**
+ * Indicates if the web view can navigate back in its history.
+ *
+ * @see http://help.adobe.com/en_US/FlashPlatform/reference/actionscript/3/flash/media/StageWebView.html#isHistoryBackEnabled Full description of flash.media.StageWebView.isHistoryBackEnabled in Adobe's Flash Platform API Reference
+ */
+ public function get isHistoryBackEnabled():Boolean
+ {
+ if(this.stageWebView)
+ {
+ return this.stageWebView.isHistoryBackEnabled;
+ }
+ return false;
+ }
+
+ /**
+ * Indicates if the web view can navigate forward in its history.
+ *
+ * @see http://help.adobe.com/en_US/FlashPlatform/reference/actionscript/3/flash/media/StageWebView.html#isHistoryForwardEnabled Full description of flash.media.StageWebView.isHistoryForwardEnabled in Adobe's Flash Platform API Reference
+ */
+ public function get isHistoryForwardEnabled():Boolean
+ {
+ if(this.stageWebView)
+ {
+ return this.stageWebView.isHistoryForwardEnabled;
+ }
+ return false;
+ }
+
+ /**
+ * @private
+ */
+ override public function dispose():void
+ {
+ if(this.stageWebView)
+ {
+ this.stageWebView.stage = null;
+ this.stageWebView.dispose();
+ this.stageWebView = null;
+ }
+ super.dispose();
+ }
+
+ /**
+ * @private
+ */
+ override public function render(support:RenderSupport, parentAlpha:Number):void
+ {
+ this.refreshViewPort();
+ super.render(support, parentAlpha);
+ }
+
+ /**
+ * Loads the specified URL.
+ *
+ * @see http://help.adobe.com/en_US/FlashPlatform/reference/actionscript/3/flash/media/StageWebView.html#loadURL() Full description of flash.media.StageWebView.loadURL() in Adobe's Flash Platform API Reference
+ */
+ public function loadURL(url:String):void
+ {
+ this.validate();
+ this.stageWebView.loadURL(url);
+ }
+
+ /**
+ * Renders the specified HTML or XHTML string.
+ *
+ * @see http://help.adobe.com/en_US/FlashPlatform/reference/actionscript/3/flash/media/StageWebView.html#loadString() Full description of flash.media.StageWebView.loadString() in Adobe's Flash Platform API Reference
+ */
+ public function loadString(text:String, mimeType:String = "text/html"):void
+ {
+ this.validate();
+ this.stageWebView.loadString(text, mimeType);
+ }
+
+ /**
+ * Stops the current page from loading.
+ *
+ * @see http://help.adobe.com/en_US/FlashPlatform/reference/actionscript/3/flash/media/StageWebView.html#stop() Full description of flash.media.StageWebView.stop() in Adobe's Flash Platform API Reference
+ */
+ public function stop():void
+ {
+ this.validate();
+ this.stageWebView.stop();
+ }
+
+ /**
+ * Reloads the currently loaded page.
+ *
+ * @see http://help.adobe.com/en_US/FlashPlatform/reference/actionscript/3/flash/media/StageWebView.html#reload() Full description of flash.media.StageWebView.reload() in Adobe's Flash Platform API Reference
+ */
+ public function reload():void
+ {
+ this.validate();
+ this.stageWebView.reload();
+ }
+
+ /**
+ * Navigates to the previous page in the browsing history.
+ *
+ * @see http://help.adobe.com/en_US/FlashPlatform/reference/actionscript/3/flash/media/StageWebView.html#historyBack() Full description of flash.media.StageWebView.historyBack() in Adobe's Flash Platform API Reference
+ * @see #isHistoryBackEnabled
+ */
+ public function historyBack():void
+ {
+ this.validate();
+ this.stageWebView.historyBack();
+ }
+
+ /**
+ * Navigates to the next page in the browsing history.
+ *
+ * @see http://help.adobe.com/en_US/FlashPlatform/reference/actionscript/3/flash/media/StageWebView.html#historyForward() Full description of flash.media.StageWebView.historyForward() in Adobe's Flash Platform API Reference
+ * @see #isHistoryForwardEnabled
+ */
+ public function historyForward():void
+ {
+ this.validate();
+ this.stageWebView.historyForward();
+ }
+
+ /**
+ * @private
+ */
+ override protected function initialize():void
+ {
+ this.createStageWebView();
+ }
+
+ /**
+ * @private
+ */
+ override protected function draw():void
+ {
+ var dataInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_DATA);
+ var sizeInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_SIZE);
+ sizeInvalid = this.autoSizeIfNeeded() || sizeInvalid;
+ if(sizeInvalid)
+ {
+ this.refreshViewPort();
+ }
+ }
+
+ /**
+ * If the component's dimensions have not been set explicitly, it will
+ * measure its content and determine an ideal size for itself. If the
+ * explicitWidth or explicitHeight member
+ * variables are set, those value will be used without additional
+ * measurement. If one is set, but not the other, the dimension with the
+ * explicit value will not be measured, but the other non-explicit
+ * dimension will still need measurement.
+ *
+ * Calls setSizeInternal() to set up the
+ * actualWidth and actualHeight member
+ * variables used for layout.
+ *
+ * Meant for internal use, and subclasses may override this function
+ * with a custom implementation.
+ */
+ protected function autoSizeIfNeeded():Boolean
+ {
+ var needsWidth:Boolean = this.explicitWidth !== this.explicitWidth; //isNaN
+ var needsHeight:Boolean = this.explicitHeight !== this.explicitHeight; //isNaN
+ if(!needsWidth && !needsHeight)
+ {
+ return false;
+ }
+ var newWidth:Number = this.explicitWidth;
+ if(needsWidth)
+ {
+ newWidth = DEFAULT_SIZE;
+ }
+ var newHeight:Number = this.explicitWidth;
+ if(needsHeight)
+ {
+ newHeight = DEFAULT_SIZE;
+ }
+ return this.setSizeInternal(newWidth, newHeight, false);
+ }
+
+ /**
+ * Creates the StageWebView instance.
+ *
+ * Meant for internal use, and subclasses may override this function
+ * with a custom implementation.
+ */
+ protected function createStageWebView():void
+ {
+ if(isSupported)
+ {
+ this.stageWebView = new STAGE_WEB_VIEW_CLASS(this._useNative);
+ }
+ else
+ {
+ throw new IllegalOperationError(STAGE_WEB_VIEW_NOT_SUPPORTED_ERROR);
+ }
+ this.stageWebView.addEventListener(ErrorEvent.ERROR, stageWebView_errorHandler);
+ this.stageWebView.addEventListener("locationChange", stageWebViewHandler);
+ this.stageWebView.addEventListener(flash.events.Event.COMPLETE, stageWebViewHandler);
+ }
+
+ /**
+ * @private
+ */
+ protected function refreshViewPort():void
+ {
+ var starlingViewPort:Rectangle = Starling.current.viewPort;
+ var stageWebViewViewPort:Rectangle = this.stageWebView.viewPort;
+ if(!stageWebViewViewPort)
+ {
+ stageWebViewViewPort = new Rectangle();
+ }
+
+ HELPER_POINT.x = HELPER_POINT.y = 0;
+ this.getTransformationMatrix(this.stage, HELPER_MATRIX);
+ var globalScaleX:Number = matrixToScaleX(HELPER_MATRIX);
+ var globalScaleY:Number = matrixToScaleY(HELPER_MATRIX);
+ MatrixUtil.transformCoords(HELPER_MATRIX, 0, 0, HELPER_POINT);
+ var nativeScaleFactor:Number = 1;
+ if(Starling.current.supportHighResolutions)
+ {
+ nativeScaleFactor = Starling.current.nativeStage.contentsScaleFactor;
+ }
+ var scaleFactor:Number = Starling.contentScaleFactor / nativeScaleFactor;
+ stageWebViewViewPort.x = Math.round(starlingViewPort.x + HELPER_POINT.x * scaleFactor);
+ stageWebViewViewPort.y = Math.round(starlingViewPort.y + HELPER_POINT.y * scaleFactor);
+ var viewPortWidth:Number = Math.round(this.actualWidth * scaleFactor * globalScaleX);
+ if(viewPortWidth < 1 ||
+ viewPortWidth !== viewPortWidth) //isNaN
+ {
+ viewPortWidth = 1;
+ }
+ var viewPortHeight:Number = Math.round(this.actualHeight * scaleFactor * globalScaleY);
+ if(viewPortHeight < 1 ||
+ viewPortHeight !== viewPortHeight) //isNaN
+ {
+ viewPortHeight = 1;
+ }
+ stageWebViewViewPort.width = viewPortWidth;
+ stageWebViewViewPort.height = viewPortHeight;
+ this.stageWebView.viewPort = stageWebViewViewPort;
+ }
+
+ /**
+ * @private
+ */
+ protected function webView_addedToStageHandler(event:Event):void
+ {
+ this.stageWebView.stage = Starling.current.nativeStage;
+ this.addEventListener(Event.ENTER_FRAME, webView_enterFrameHandler);
+ }
+
+ /**
+ * @private
+ */
+ protected function webView_removedFromStageHandler(event:Event):void
+ {
+ if(this.stageWebView)
+ {
+ this.stageWebView.stage = null;
+ }
+ this.removeEventListener(Event.ENTER_FRAME, webView_enterFrameHandler);
+ }
+
+ /**
+ * @private
+ */
+ protected function webView_enterFrameHandler(event:Event):void
+ {
+ var target:DisplayObject = this;
+ do
+ {
+ if(!target.hasVisibleArea)
+ {
+ this.stageWebView.stage = null;
+ return;
+ }
+ target = target.parent;
+ }
+ while(target)
+ this.stageWebView.stage = Starling.current.nativeStage;
+ }
+
+ /**
+ * @private
+ */
+ protected function stageWebView_errorHandler(event:ErrorEvent):void
+ {
+ this.dispatchEventWith(FeathersEventType.ERROR, false, event);
+ }
+
+ /**
+ * @private
+ */
+ protected function stageWebViewHandler(event:flash.events.Event):void
+ {
+ this.dispatchEventWith(event.type);
+ }
+ }
+}
diff --git a/source/feathers/controls/popups/CalloutPopUpContentManager.as b/source/feathers/controls/popups/CalloutPopUpContentManager.as
new file mode 100644
index 0000000000..77eb47dfad
--- /dev/null
+++ b/source/feathers/controls/popups/CalloutPopUpContentManager.as
@@ -0,0 +1,169 @@
+/*
+Feathers
+Copyright 2012-2014 Joshua Tynjala. All Rights Reserved.
+
+This program is free software. You can redistribute and/or modify it in
+accordance with the terms of the accompanying license agreement.
+*/
+package feathers.controls.popups
+{
+ import feathers.controls.Callout;
+
+ import flash.errors.IllegalOperationError;
+
+ import starling.display.DisplayObject;
+ import starling.events.Event;
+ import starling.events.EventDispatcher;
+
+ /**
+ * @inheritDoc
+ */
+ [Event(name="open",type="starling.events.Event")]
+
+ /**
+ * @inheritDoc
+ */
+ [Event(name="close",type="starling.events.Event")]
+
+ /**
+ * Displays pop-up content (such as the List in a PickerList) in a Callout.
+ *
+ * @see feathers.controls.PickerList
+ * @see feathers.controls.Callout
+ */
+ public class CalloutPopUpContentManager extends EventDispatcher implements IPopUpContentManager
+ {
+ /**
+ * Constructor.
+ */
+ public function CalloutPopUpContentManager()
+ {
+ }
+
+ /**
+ * The factory used to create the Callout instance. If
+ * null, Callout.calloutFactory() will be used.
+ *
+ * Note: If you change this value while a callout is open, the new
+ * value will not go into effect until the callout is closed and a new
+ * callout is opened.
+ *
+ * @see feathers.controls.Callout#calloutFactory
+ *
+ * @default null
+ */
+ public var calloutFactory:Function;
+
+ /**
+ * The direction of the callout.
+ *
+ * Note: If you change this value while a callout is open, the new
+ * value will not go into effect until the callout is closed and a new
+ * callout is opened.
+ *
+ * In the following example, the callout direction is restricted to down:
+ *
+ *
+ * manager.direction = Callout.DIRECTION_DOWN;
+ *
+ * @see feathers.controls.Callout#DIRECTION_ANY
+ * @see feathers.controls.Callout#DIRECTION_UP
+ * @see feathers.controls.Callout#DIRECTION_DOWN
+ * @see feathers.controls.Callout#DIRECTION_LEFT
+ * @see feathers.controls.Callout#DIRECTION_RIGHT
+ *
+ * @default Callout.DIRECTION_ANY
+ */
+ public var direction:String = Callout.DIRECTION_ANY;
+
+ /**
+ * Determines if the callout will be modal or not.
+ *
+ * Note: If you change this value while a callout is open, the new
+ * value will not go into effect until the callout is closed and a new
+ * callout is opened.
+ *
+ * In the following example, the callout is not modal:
+ *
+ *
+ * manager.isModal = false;
+ *
+ * @default true
+ */
+ public var isModal:Boolean = true;
+
+ /**
+ * @private
+ */
+ protected var content:DisplayObject;
+
+ /**
+ * @private
+ */
+ protected var callout:Callout;
+
+ /**
+ * @inheritDoc
+ */
+ public function get isOpen():Boolean
+ {
+ return this.content !== null;
+ }
+
+ /**
+ * @inheritDoc
+ */
+ public function open(content:DisplayObject, source:DisplayObject):void
+ {
+ if(this.isOpen)
+ {
+ throw new IllegalOperationError("Pop-up content is already open. Close the previous content before opening new content.");
+ }
+
+ this.content = content;
+ this.callout = Callout.show(content, source, this.direction, this.isModal, this.calloutFactory);
+ this.callout.addEventListener(Event.REMOVED_FROM_STAGE, callout_removedFromStageHandler);
+ this.dispatchEventWith(Event.OPEN);
+ }
+
+ /**
+ * @inheritDoc
+ */
+ public function close():void
+ {
+ if(!this.isOpen)
+ {
+ return;
+ }
+ this.callout.close();
+ }
+
+ /**
+ * @inheritDoc
+ */
+ public function dispose():void
+ {
+ this.close();
+ }
+
+ /**
+ * @private
+ */
+ protected function cleanup():void
+ {
+ this.content = null;
+ this.callout.content = null;
+ this.callout.removeEventListener(Event.REMOVED_FROM_STAGE, callout_removedFromStageHandler);
+ this.callout = null;
+ }
+
+ /**
+ * @private
+ */
+ protected function callout_removedFromStageHandler(event:Event):void
+ {
+ this.cleanup();
+ this.dispatchEventWith(Event.CLOSE);
+ }
+ }
+}
diff --git a/source/feathers/controls/popups/DropDownPopUpContentManager.as b/source/feathers/controls/popups/DropDownPopUpContentManager.as
new file mode 100644
index 0000000000..9d300e19ff
--- /dev/null
+++ b/source/feathers/controls/popups/DropDownPopUpContentManager.as
@@ -0,0 +1,355 @@
+/*
+Feathers
+Copyright 2012-2014 Joshua Tynjala. All Rights Reserved.
+
+This program is free software. You can redistribute and/or modify it in
+accordance with the terms of the accompanying license agreement.
+*/
+package feathers.controls.popups
+{
+ import feathers.core.IFeathersControl;
+ import feathers.core.IValidating;
+ import feathers.core.PopUpManager;
+ import feathers.core.ValidationQueue;
+ import feathers.events.FeathersEventType;
+ import feathers.utils.display.getDisplayObjectDepthFromStage;
+
+ import flash.errors.IllegalOperationError;
+ import flash.events.KeyboardEvent;
+ import flash.geom.Rectangle;
+ import flash.ui.Keyboard;
+
+ import starling.core.Starling;
+ import starling.display.DisplayObject;
+ import starling.display.DisplayObjectContainer;
+ import starling.display.Stage;
+ import starling.events.Event;
+ import starling.events.EventDispatcher;
+ import starling.events.ResizeEvent;
+ import starling.events.Touch;
+ import starling.events.TouchEvent;
+ import starling.events.TouchPhase;
+
+ /**
+ * @inheritDoc
+ */
+ [Event(name="open",type="starling.events.Event")]
+
+ /**
+ * @inheritDoc
+ */
+ [Event(name="close",type="starling.events.Event")]
+
+ /**
+ * Displays pop-up content as a desktop-style drop-down.
+ */
+ public class DropDownPopUpContentManager extends EventDispatcher implements IPopUpContentManager
+ {
+ /**
+ * Constructor.
+ */
+ public function DropDownPopUpContentManager()
+ {
+ }
+
+ /**
+ * @private
+ */
+ protected var content:DisplayObject;
+
+ /**
+ * @private
+ */
+ protected var source:DisplayObject;
+
+ /**
+ * @inheritDoc
+ */
+ public function get isOpen():Boolean
+ {
+ return this.content !== null;
+ }
+
+ /**
+ * @private
+ */
+ protected var _gap:Number = 0;
+
+ /**
+ * The space, in pixels, between the source and the pop-up.
+ */
+ public function get gap():Number
+ {
+ return this._gap;
+ }
+
+ /**
+ * @private
+ */
+ public function set gap(value:Number):void
+ {
+ this._gap = value;
+ }
+
+ /**
+ * @inheritDoc
+ */
+ public function open(content:DisplayObject, source:DisplayObject):void
+ {
+ if(this.isOpen)
+ {
+ throw new IllegalOperationError("Pop-up content is already open. Close the previous content before opening new content.");
+ }
+
+ this.content = content;
+ this.source = source;
+ PopUpManager.addPopUp(this.content, false, false);
+ if(this.content is IFeathersControl)
+ {
+ this.content.addEventListener(FeathersEventType.RESIZE, content_resizeHandler);
+ }
+ this.content.addEventListener(Event.REMOVED_FROM_STAGE, content_removedFromStageHandler);
+ this.layout();
+ var stage:Stage = Starling.current.stage;
+ stage.addEventListener(TouchEvent.TOUCH, stage_touchHandler);
+ stage.addEventListener(ResizeEvent.RESIZE, stage_resizeHandler);
+
+ //using priority here is a hack so that objects higher up in the
+ //display list have a chance to cancel the event first.
+ var priority:int = -getDisplayObjectDepthFromStage(this.content);
+ Starling.current.nativeStage.addEventListener(KeyboardEvent.KEY_DOWN, nativeStage_keyDownHandler, false, priority, true);
+ this.dispatchEventWith(Event.OPEN);
+ }
+
+ /**
+ * @inheritDoc
+ */
+ public function close():void
+ {
+ if(!this.isOpen)
+ {
+ return;
+ }
+ var content:DisplayObject = this.content;
+ this.content = null;
+ this.source = null;
+ var stage:Stage = Starling.current.stage;
+ stage.removeEventListener(TouchEvent.TOUCH, stage_touchHandler);
+ stage.removeEventListener(ResizeEvent.RESIZE, stage_resizeHandler);
+ Starling.current.nativeStage.removeEventListener(KeyboardEvent.KEY_DOWN, nativeStage_keyDownHandler);
+ if(content is IFeathersControl)
+ {
+ content.removeEventListener(FeathersEventType.RESIZE, content_resizeHandler);
+ }
+ content.removeEventListener(Event.REMOVED_FROM_STAGE, content_removedFromStageHandler);
+ if(content.parent)
+ {
+ content.removeFromParent(false);
+ }
+ this.dispatchEventWith(Event.CLOSE);
+ }
+
+ /**
+ * @inheritDoc
+ */
+ public function dispose():void
+ {
+ this.close();
+ }
+
+ /**
+ * @private
+ */
+ protected function layout():void
+ {
+ var stage:Stage = Starling.current.stage;
+ var globalOrigin:Rectangle = this.source.getBounds(stage);
+
+ if(this.source is IValidating)
+ {
+ IValidating(this.source).validate();
+ if(!this.isOpen)
+ {
+ //it's possible that the source will close its pop-up during
+ //validation, so we should check for that.
+ return;
+ }
+ }
+
+ var sourceWidth:Number = this.source.width;
+ var hasSetBounds:Boolean = false;
+ var uiContent:IFeathersControl = this.content as IFeathersControl;
+ if(uiContent && uiContent.minWidth < sourceWidth)
+ {
+ uiContent.minWidth = sourceWidth;
+ hasSetBounds = true;
+ }
+ if(this.content is IValidating)
+ {
+ uiContent.validate();
+ }
+ if(!hasSetBounds && this.content.width < sourceWidth)
+ {
+ this.content.width = sourceWidth;
+ }
+
+ //we need to be sure that the source is properly positioned before
+ //positioning the content relative to it.
+ var validationQueue:ValidationQueue = ValidationQueue.forStarling(Starling.current)
+ if(validationQueue && !validationQueue.isValidating)
+ {
+ //force a COMPLETE validation of everything
+ //but only if we're not already doing that...
+ validationQueue.advanceTime(0);
+ }
+
+ var downSpace:Number = (stage.stageHeight - this.content.height) - (globalOrigin.y + globalOrigin.height + this._gap);
+ if(downSpace >= 0)
+ {
+ layoutBelow(globalOrigin);
+ return;
+ }
+
+ var upSpace:Number = globalOrigin.y - this._gap - this.content.height;
+ if(upSpace >= 0)
+ {
+ layoutAbove(globalOrigin);
+ return;
+ }
+
+ //worst case: pick the side that has the most available space
+ if(upSpace >= downSpace)
+ {
+ layoutAbove(globalOrigin);
+ }
+ else
+ {
+ layoutBelow(globalOrigin);
+ }
+
+ //the content is too big for the space, so we need to adjust it to
+ //fit properly
+ var newMaxHeight:Number = stage.stageHeight - (globalOrigin.y + globalOrigin.height);
+ if(uiContent)
+ {
+ if(uiContent.maxHeight > newMaxHeight)
+ {
+ uiContent.maxHeight = newMaxHeight;
+ }
+ }
+ else if(this.content.height > newMaxHeight)
+ {
+ this.content.height = newMaxHeight;
+ }
+ }
+
+ /**
+ * @private
+ */
+ protected function layoutAbove(globalOrigin:Rectangle):void
+ {
+ var idealXPosition:Number = globalOrigin.x + (globalOrigin.width - this.content.width) / 2;
+ var xPosition:Number = Starling.current.stage.stageWidth - this.content.width;
+ if(xPosition > idealXPosition)
+ {
+ xPosition = idealXPosition;
+ }
+ if(xPosition < 0)
+ {
+ xPosition = 0;
+ }
+ this.content.x = xPosition;
+ this.content.y = globalOrigin.y - this.content.height - this._gap;
+ }
+
+ /**
+ * @private
+ */
+ protected function layoutBelow(globalOrigin:Rectangle):void
+ {
+ var idealXPosition:Number = globalOrigin.x;
+ var xPosition:Number = Starling.current.stage.stageWidth - this.content.width;
+ if(xPosition > idealXPosition)
+ {
+ xPosition = idealXPosition;
+ }
+ if(xPosition < 0)
+ {
+ xPosition = 0;
+ }
+ this.content.x = xPosition;
+ this.content.y = globalOrigin.y + globalOrigin.height + this._gap;
+ }
+
+ /**
+ * @private
+ */
+ protected function content_resizeHandler(event:Event):void
+ {
+ this.layout();
+ }
+
+ /**
+ * @private
+ */
+ protected function content_removedFromStageHandler(event:Event):void
+ {
+ this.close();
+ }
+
+ /**
+ * @private
+ */
+ protected function nativeStage_keyDownHandler(event:KeyboardEvent):void
+ {
+ if(event.isDefaultPrevented())
+ {
+ //someone else already handled this one
+ return;
+ }
+ if(event.keyCode != Keyboard.BACK && event.keyCode != Keyboard.ESCAPE)
+ {
+ return;
+ }
+ //don't let the OS handle the event
+ event.preventDefault();
+
+ this.close();
+ }
+
+ /**
+ * @private
+ */
+ protected function stage_resizeHandler(event:ResizeEvent):void
+ {
+ this.layout();
+ }
+
+ /**
+ * @private
+ */
+ protected function stage_touchHandler(event:TouchEvent):void
+ {
+ var target:DisplayObject = DisplayObject(event.target);
+ if(this.content == target || (this.content is DisplayObjectContainer && DisplayObjectContainer(this.content).contains(target)))
+ {
+ return;
+ }
+ if(this.source == target || (this.source is DisplayObjectContainer && DisplayObjectContainer(this.source).contains(target)))
+ {
+ return;
+ }
+ if(!PopUpManager.isTopLevelPopUp(this.content))
+ {
+ return;
+ }
+ //any began touch is okay here. we don't need to check all touches
+ var touch:Touch = event.getTouch(Starling.current.stage, TouchPhase.BEGAN);
+ if(!touch)
+ {
+ return;
+ }
+ this.close();
+ }
+ }
+}
diff --git a/source/feathers/controls/popups/IPopUpContentManager.as b/source/feathers/controls/popups/IPopUpContentManager.as
new file mode 100644
index 0000000000..157d9aafa6
--- /dev/null
+++ b/source/feathers/controls/popups/IPopUpContentManager.as
@@ -0,0 +1,84 @@
+/*
+Feathers
+Copyright 2012-2014 Joshua Tynjala. All Rights Reserved.
+
+This program is free software. You can redistribute and/or modify it in
+accordance with the terms of the accompanying license agreement.
+*/
+package feathers.controls.popups
+{
+ import starling.display.DisplayObject;
+
+ /**
+ * Dispatched when the pop-up content opens.
+ *
+ * The properties of the event object have the following values:
+ *
+ * | Property | Value |
|---|
+ * bubbles | false |
+ * currentTarget | The Object that defines the
+ * event listener that handles the event. For example, if you use
+ * myButton.addEventListener() to register an event listener,
+ * myButton is the value of the currentTarget. |
+ * data | null |
+ * target | The Object that dispatched the event;
+ * it is not always the Object listening for the event. Use the
+ * currentTarget property to always access the Object
+ * listening for the event. |
+ *
+ *
+ * @eventType starling.events.Event.OPEN
+ */
+ [Event(name="open",type="starling.events.Event")]
+
+ /**
+ * Dispatched when the pop-up content closes.
+ *
+ * The properties of the event object have the following values:
+ *
+ * | Property | Value |
|---|
+ * bubbles | false |
+ * currentTarget | The Object that defines the
+ * event listener that handles the event. For example, if you use
+ * myButton.addEventListener() to register an event listener,
+ * myButton is the value of the currentTarget. |
+ * data | null |
+ * target | The Object that dispatched the event;
+ * it is not always the Object listening for the event. Use the
+ * currentTarget property to always access the Object
+ * listening for the event. |
+ *
+ *
+ * @eventType starling.events.Event.CLOSE
+ */
+ [Event(name="close",type="starling.events.Event")]
+
+ /**
+ * Automatically manages pop-up content layout and positioning.
+ */
+ public interface IPopUpContentManager
+ {
+ /**
+ * Indicates if the pop-up content is open or not.
+ */
+ function get isOpen():Boolean;
+
+ /**
+ * Displays the pop-up content.
+ *
+ * @param content The content for the pop-up content manager to display.
+ * @param source The source of the pop-up. May be used to position and/or size the pop-up. May be completely ignored instead.
+ */
+ function open(content:DisplayObject, source:DisplayObject):void;
+
+ /**
+ * Closes the pop-up content. If it is not opened, nothing happens.
+ */
+ function close():void;
+
+ /**
+ * Cleans up the manager.
+ */
+ function dispose():void;
+ }
+}
diff --git a/source/feathers/controls/popups/VerticalCenteredPopUpContentManager.as b/source/feathers/controls/popups/VerticalCenteredPopUpContentManager.as
new file mode 100644
index 0000000000..f10544bf78
--- /dev/null
+++ b/source/feathers/controls/popups/VerticalCenteredPopUpContentManager.as
@@ -0,0 +1,395 @@
+/*
+Feathers
+Copyright 2012-2014 Joshua Tynjala. All Rights Reserved.
+
+This program is free software. You can redistribute and/or modify it in
+accordance with the terms of the accompanying license agreement.
+*/
+package feathers.controls.popups
+{
+ import feathers.core.IFeathersControl;
+ import feathers.core.IValidating;
+ import feathers.core.PopUpManager;
+ import feathers.events.FeathersEventType;
+ import feathers.utils.display.getDisplayObjectDepthFromStage;
+
+ import flash.errors.IllegalOperationError;
+ import flash.events.KeyboardEvent;
+ import flash.geom.Point;
+ import flash.ui.Keyboard;
+
+ import starling.core.Starling;
+ import starling.display.DisplayObject;
+ import starling.display.DisplayObjectContainer;
+ import starling.display.Stage;
+ import starling.events.Event;
+ import starling.events.EventDispatcher;
+ import starling.events.ResizeEvent;
+ import starling.events.Touch;
+ import starling.events.TouchEvent;
+ import starling.events.TouchPhase;
+
+ /**
+ * @inheritDoc
+ */
+ [Event(name="open",type="starling.events.Event")]
+
+ /**
+ * @inheritDoc
+ */
+ [Event(name="close",type="starling.events.Event")]
+
+ /**
+ * Displays a pop-up at the center of the stage, filling the vertical space.
+ * The content will be sized horizontally so that it is no larger than the
+ * the width or height of the stage (whichever is smaller).
+ */
+ public class VerticalCenteredPopUpContentManager extends EventDispatcher implements IPopUpContentManager
+ {
+ /**
+ * @private
+ */
+ private static const HELPER_POINT:Point = new Point();
+
+ /**
+ * Constructor.
+ */
+ public function VerticalCenteredPopUpContentManager()
+ {
+ }
+
+ /**
+ * Quickly sets all margin properties to the same value. The
+ * margin getter always returns the value of
+ * marginTop, but the other padding values may be
+ * different.
+ *
+ * The following example gives the pop-up a minimum of 20 pixels of
+ * margin on all sides:
+ *
+ *
+ * manager.margin = 20;
+ *
+ * @default 0
+ *
+ * @see #marginTop
+ * @see #marginRight
+ * @see #marginBottom
+ * @see #marginLeft
+ */
+ public function get margin():Number
+ {
+ return this.marginTop;
+ }
+
+ /**
+ * @private
+ */
+ public function set margin(value:Number):void
+ {
+ this.marginTop = 0;
+ this.marginRight = 0;
+ this.marginBottom = 0;
+ this.marginLeft = 0;
+ }
+
+ /**
+ * The minimum space, in pixels, between the top edge of the content and
+ * the top edge of the stage.
+ *
+ * The following example gives the pop-up a minimum of 20 pixels of
+ * margin on the top:
+ *
+ *
+ * manager.marginTop = 20;
+ *
+ * @default 0
+ *
+ * @see #margin
+ */
+ public var marginTop:Number = 0;
+
+ /**
+ * The minimum space, in pixels, between the right edge of the content
+ * and the right edge of the stage.
+ *
+ * The following example gives the pop-up a minimum of 20 pixels of
+ * margin on the right:
+ *
+ *
+ * manager.marginRight = 20;
+ *
+ * @default 0
+ *
+ * @see #margin
+ */
+ public var marginRight:Number = 0;
+
+ /**
+ * The minimum space, in pixels, between the bottom edge of the content
+ * and the bottom edge of the stage.
+ *
+ * The following example gives the pop-up a minimum of 20 pixels of
+ * margin on the bottom:
+ *
+ *
+ * manager.marginBottom = 20;
+ *
+ * @default 0
+ *
+ * @see #margin
+ */
+ public var marginBottom:Number = 0;
+
+ /**
+ * The minimum space, in pixels, between the left edge of the content
+ * and the left edge of the stage.
+ *
+ * The following example gives the pop-up a minimum of 20 pixels of
+ * margin on the left:
+ *
+ *
+ * manager.marginLeft = 20;
+ *
+ * @default 0
+ *
+ * @see #margin
+ */
+ public var marginLeft:Number = 0;
+
+ /**
+ * @private
+ */
+ protected var content:DisplayObject;
+
+ /**
+ * @private
+ */
+ protected var touchPointID:int = -1;
+
+ /**
+ * @inheritDoc
+ */
+ public function get isOpen():Boolean
+ {
+ return this.content !== null;
+ }
+
+ /**
+ * @inheritDoc
+ */
+ public function open(content:DisplayObject, source:DisplayObject):void
+ {
+ if(this.isOpen)
+ {
+ throw new IllegalOperationError("Pop-up content is already open. Close the previous content before opening new content.");
+ }
+
+ this.content = content;
+ PopUpManager.addPopUp(this.content, true, false);
+ if(this.content is IFeathersControl)
+ {
+ this.content.addEventListener(FeathersEventType.RESIZE, content_resizeHandler);
+ }
+ this.content.addEventListener(Event.REMOVED_FROM_STAGE, content_removedFromStageHandler);
+ this.layout();
+ var stage:Stage = Starling.current.stage;
+ stage.addEventListener(TouchEvent.TOUCH, stage_touchHandler);
+ stage.addEventListener(ResizeEvent.RESIZE, stage_resizeHandler);
+
+ //using priority here is a hack so that objects higher up in the
+ //display list have a chance to cancel the event first.
+ var priority:int = -getDisplayObjectDepthFromStage(this.content);
+ Starling.current.nativeStage.addEventListener(KeyboardEvent.KEY_DOWN, nativeStage_keyDownHandler, false, priority, true);
+ this.dispatchEventWith(Event.OPEN);
+ }
+
+ /**
+ * @inheritDoc
+ */
+ public function close():void
+ {
+ if(!this.isOpen)
+ {
+ return;
+ }
+ var content:DisplayObject = this.content;
+ this.content = null;
+ var stage:Stage = Starling.current.stage;
+ stage.removeEventListener(TouchEvent.TOUCH, stage_touchHandler);
+ stage.removeEventListener(ResizeEvent.RESIZE, stage_resizeHandler);
+ Starling.current.nativeStage.removeEventListener(KeyboardEvent.KEY_DOWN, nativeStage_keyDownHandler);
+ if(content is IFeathersControl)
+ {
+ content.removeEventListener(FeathersEventType.RESIZE, content_resizeHandler);
+ }
+ content.removeEventListener(Event.REMOVED_FROM_STAGE, content_removedFromStageHandler);
+ if(content.parent)
+ {
+ content.removeFromParent(false);
+ }
+ this.dispatchEventWith(Event.CLOSE);
+ }
+
+ /**
+ * @inheritDoc
+ */
+ public function dispose():void
+ {
+ this.close();
+ }
+
+ /**
+ * @private
+ */
+ protected function layout():void
+ {
+ var stage:Stage = Starling.current.stage;
+ var maxWidth:Number = stage.stageWidth;
+ if(maxWidth > stage.stageHeight)
+ {
+ maxWidth = stage.stageHeight;
+ }
+ maxWidth -= (this.marginLeft + this.marginRight);
+ var maxHeight:Number = stage.stageHeight - this.marginTop - this.marginBottom;
+ var hasSetBounds:Boolean = false;
+ if(this.content is IFeathersControl)
+ {
+ //if it's a ui control that is able to auto-size, this section
+ //will ensure that the control stays within the required bounds.
+ var uiContent:IFeathersControl = IFeathersControl(this.content);
+ uiContent.minWidth = maxWidth;
+ uiContent.maxWidth = maxWidth;
+ uiContent.maxHeight = maxHeight;
+ hasSetBounds = true;
+ }
+ if(this.content is IValidating)
+ {
+ IValidating(this.content).validate();
+ }
+ if(!hasSetBounds)
+ {
+ //if it's not a ui control, and the control's explicit width and
+ //height values are greater than our maximum bounds, then we
+ //will enforce the maximum bounds the hard way.
+ if(this.content.width > maxWidth)
+ {
+ this.content.width = maxWidth;
+ }
+ if(this.content.height > maxHeight)
+ {
+ this.content.height = maxHeight;
+ }
+ }
+ //round to the nearest pixel to avoid unnecessary smoothing
+ this.content.x = Math.round((stage.stageWidth - this.content.width) / 2);
+ this.content.y = Math.round((stage.stageHeight - this.content.height) / 2);
+ }
+
+ /**
+ * @private
+ */
+ protected function content_resizeHandler(event:Event):void
+ {
+ this.layout();
+ }
+
+ /**
+ * @private
+ */
+ protected function content_removedFromStageHandler(event:Event):void
+ {
+ this.close();
+ }
+
+ /**
+ * @private
+ */
+ protected function nativeStage_keyDownHandler(event:KeyboardEvent):void
+ {
+ if(event.isDefaultPrevented())
+ {
+ //someone else already handled this one
+ return;
+ }
+ if(event.keyCode != Keyboard.BACK && event.keyCode != Keyboard.ESCAPE)
+ {
+ return;
+ }
+ //don't let the OS handle the event
+ event.preventDefault();
+
+ this.close();
+ }
+
+ /**
+ * @private
+ */
+ protected function stage_resizeHandler(event:ResizeEvent):void
+ {
+ this.layout();
+ }
+
+ /**
+ * @private
+ */
+ protected function stage_touchHandler(event:TouchEvent):void
+ {
+ if(!PopUpManager.isTopLevelPopUp(this.content))
+ {
+ return;
+ }
+ var stage:Stage = Starling.current.stage;
+ if(this.touchPointID >= 0)
+ {
+ var touch:Touch = event.getTouch(stage, TouchPhase.ENDED, this.touchPointID);
+ if(!touch)
+ {
+ return;
+ }
+ touch.getLocation(stage, HELPER_POINT);
+ var hitTestResult:DisplayObject = stage.hitTest(HELPER_POINT, true);
+ var isInBounds:Boolean = false;
+ if(this.content is DisplayObjectContainer)
+ {
+ isInBounds = DisplayObjectContainer(this.content).contains(hitTestResult);
+ }
+ else
+ {
+ isInBounds = this.content == hitTestResult;
+ }
+ if(!isInBounds)
+ {
+ this.touchPointID = -1;
+ this.close();
+ }
+ }
+ else
+ {
+ touch = event.getTouch(stage, TouchPhase.BEGAN);
+ if(!touch)
+ {
+ return;
+ }
+ touch.getLocation(stage, HELPER_POINT);
+ hitTestResult = stage.hitTest(HELPER_POINT, true);
+ isInBounds = false;
+ if(this.content is DisplayObjectContainer)
+ {
+ isInBounds = DisplayObjectContainer(this.content).contains(hitTestResult);
+ }
+ else
+ {
+ isInBounds = this.content == hitTestResult;
+ }
+ if(isInBounds)
+ {
+ return;
+ }
+ this.touchPointID = touch.id;
+ }
+ }
+
+
+ }
+}
diff --git a/source/feathers/controls/renderers/BaseDefaultItemRenderer.as b/source/feathers/controls/renderers/BaseDefaultItemRenderer.as
new file mode 100644
index 0000000000..04a81cd0ba
--- /dev/null
+++ b/source/feathers/controls/renderers/BaseDefaultItemRenderer.as
@@ -0,0 +1,4517 @@
+/*
+Feathers
+Copyright 2012-2014 Joshua Tynjala. All Rights Reserved.
+
+This program is free software. You can redistribute and/or modify it in
+accordance with the terms of the accompanying license agreement.
+*/
+package feathers.controls.renderers
+{
+ import feathers.controls.Button;
+ import feathers.controls.ImageLoader;
+ import feathers.controls.Scroller;
+ import feathers.controls.ToggleButton;
+ import feathers.controls.text.BitmapFontTextRenderer;
+ import feathers.core.FeathersControl;
+ import feathers.core.IFeathersControl;
+ import feathers.core.IFocusContainer;
+ import feathers.core.ITextRenderer;
+ import feathers.core.IValidating;
+ import feathers.core.PropertyProxy;
+ import feathers.events.FeathersEventType;
+
+ import flash.events.TimerEvent;
+ import flash.geom.Point;
+ import flash.utils.Timer;
+
+ import starling.display.DisplayObject;
+ import starling.events.Event;
+ import starling.events.Touch;
+ import starling.events.TouchEvent;
+ import starling.events.TouchPhase;
+
+ /**
+ * An abstract class for item renderer implementations.
+ */
+ public class BaseDefaultItemRenderer extends ToggleButton implements IFocusContainer
+ {
+ /**
+ * The default value added to the styleNameList of the icon
+ * label, if it exists.
+ *
+ * @see feathers.core.FeathersControl#styleNameList
+ */
+ public static const DEFAULT_CHILD_STYLE_NAME_ICON_LABEL:String = "feathers-item-renderer-icon-label";
+
+ /**
+ * DEPRECATED: Replaced by BaseDefaultItemRenderer.DEFAULT_CHILD_STYLE_NAME_ICON_LABEL.
+ *
+ * DEPRECATION WARNING: This property is deprecated
+ * starting with Feathers 2.1. It will be removed in a future version of
+ * Feathers according to the standard
+ * Feathers deprecation policy.
+ *
+ * @see BaseDefaultItemRenderer#DEFAULT_CHILD_STYLE_NAME_ICON_LABEL
+ */
+ public static const DEFAULT_CHILD_NAME_ICON_LABEL:String = DEFAULT_CHILD_STYLE_NAME_ICON_LABEL;
+
+ /**
+ * The default value added to the styleNameList of the
+ * accessory label, if it exists.
+ *
+ * @see feathers.core.FeathersControl#styleNameList
+ */
+ public static const DEFAULT_CHILD_STYLE_NAME_ACCESSORY_LABEL:String = "feathers-item-renderer-accessory-label";
+
+ /**
+ * DEPRECATED: Replaced by BaseDefaultItemRenderer.DEFAULT_CHILD_STYLE_NAME_ACCESSORY_LABEL.
+ *
+ * DEPRECATION WARNING: This property is deprecated
+ * starting with Feathers 2.1. It will be removed in a future version of
+ * Feathers according to the standard
+ * Feathers deprecation policy.
+ *
+ * @see BaseDefaultItemRenderer#DEFAULT_CHILD_STYLE_NAME_ACCESSORY_LABEL
+ */
+ public static const DEFAULT_CHILD_NAME_ACCESSORY_LABEL:String = DEFAULT_CHILD_STYLE_NAME_ACCESSORY_LABEL;
+
+ /**
+ * @copy feathers.controls.Button#ICON_POSITION_TOP
+ *
+ * @see feathers.controls.Button#iconPosition
+ */
+ public static const ICON_POSITION_TOP:String = "top";
+
+ /**
+ * @copy feathers.controls.Button#ICON_POSITION_RIGHT
+ *
+ * @see feathers.controls.Button#iconPosition
+ */
+ public static const ICON_POSITION_RIGHT:String = "right";
+
+ /**
+ * @copy feathers.controls.Button#ICON_POSITION_BOTTOM
+ *
+ * @see feathers.controls.Button#iconPosition
+ */
+ public static const ICON_POSITION_BOTTOM:String = "bottom";
+
+ /**
+ * @copy feathers.controls.Button#ICON_POSITION_LEFT
+ *
+ * @see feathers.controls.Button#iconPosition
+ */
+ public static const ICON_POSITION_LEFT:String = "left";
+
+ /**
+ * @copy feathers.controls.Button#ICON_POSITION_MANUAL
+ *
+ * @see feathers.controls.Button#iconPosition
+ * @see feathers.controls.Button#iconOffsetX
+ * @see feathers.controls.Button#iconOffsetY
+ */
+ public static const ICON_POSITION_MANUAL:String = "manual";
+
+ /**
+ * @copy feathers.controls.Button#ICON_POSITION_LEFT_BASELINE
+ *
+ * @see feathers.controls.Button#iconPosition
+ */
+ public static const ICON_POSITION_LEFT_BASELINE:String = "leftBaseline";
+
+ /**
+ * @copy feathers.controls.Button#ICON_POSITION_RIGHT_BASELINE
+ *
+ * @see feathers.controls.Button#iconPosition
+ */
+ public static const ICON_POSITION_RIGHT_BASELINE:String = "rightBaseline";
+
+ /**
+ * @copy feathers.controls.Button#HORIZONTAL_ALIGN_LEFT
+ *
+ * @see feathers.controls.Button#horizontalAlign
+ */
+ public static const HORIZONTAL_ALIGN_LEFT:String = "left";
+
+ /**
+ * @copy feathers.controls.Button#HORIZONTAL_ALIGN_CENTER
+ *
+ * @see feathers.controls.Button#horizontalAlign
+ */
+ public static const HORIZONTAL_ALIGN_CENTER:String = "center";
+
+ /**
+ * @copy feathers.controls.Button#HORIZONTAL_ALIGN_RIGHT
+ *
+ * @see feathers.controls.Button#horizontalAlign
+ */
+ public static const HORIZONTAL_ALIGN_RIGHT:String = "right";
+
+ /**
+ * @copy feathers.controls.Button#VERTICAL_ALIGN_TOP
+ *
+ * @see feathers.controls.Button#verticalAlign
+ */
+ public static const VERTICAL_ALIGN_TOP:String = "top";
+
+ /**
+ * @copy feathers.controls.Button#VERTICAL_ALIGN_MIDDLE
+ *
+ * @see feathers.controls.Button#verticalAlign
+ */
+ public static const VERTICAL_ALIGN_MIDDLE:String = "middle";
+
+ /**
+ * @copy feathers.controls.Button#VERTICAL_ALIGN_BOTTOM
+ *
+ * @see feathers.controls.Button#verticalAlign
+ */
+ public static const VERTICAL_ALIGN_BOTTOM:String = "bottom";
+
+ /**
+ * The accessory will be positioned above its origin.
+ *
+ * @see #accessoryPosition
+ */
+ public static const ACCESSORY_POSITION_TOP:String = "top";
+
+ /**
+ * The accessory will be positioned to the right of its origin.
+ *
+ * @see #accessoryPosition
+ */
+ public static const ACCESSORY_POSITION_RIGHT:String = "right";
+
+ /**
+ * The accessory will be positioned below its origin.
+ *
+ * @see #accessoryPosition
+ */
+ public static const ACCESSORY_POSITION_BOTTOM:String = "bottom";
+
+ /**
+ * The accessory will be positioned to the left of its origin.
+ *
+ * @see #accessoryPosition
+ */
+ public static const ACCESSORY_POSITION_LEFT:String = "left";
+
+ /**
+ * The accessory will be positioned manually with no relation to another
+ * child. Use accessoryOffsetX and accessoryOffsetY
+ * to set the accessory position.
+ *
+ * The accessoryPositionOrigin property will be ignored
+ * if accessoryPosition is set to ACCESSORY_POSITION_MANUAL.
+ *
+ * @see #accessoryPosition
+ * @see #accessoryOffsetX
+ * @see #accessoryOffsetY
+ */
+ public static const ACCESSORY_POSITION_MANUAL:String = "manual";
+
+ /**
+ * The layout order will be the label first, then the accessory relative
+ * to the label, then the icon relative to both. Best used when the
+ * accessory should be between the label and the icon or when the icon
+ * position shouldn't be affected by the accessory.
+ *
+ * @see #layoutOrder
+ */
+ public static const LAYOUT_ORDER_LABEL_ACCESSORY_ICON:String = "labelAccessoryIcon";
+
+ /**
+ * The layout order will be the label first, then the icon relative to
+ * label, then the accessory relative to both.
+ *
+ * @see #layoutOrder
+ */
+ public static const LAYOUT_ORDER_LABEL_ICON_ACCESSORY:String = "labelIconAccessory";
+
+ /**
+ * @private
+ */
+ private static const HELPER_POINT:Point = new Point();
+
+ /**
+ * @private
+ */
+ protected static var DOWN_STATE_DELAY_MS:int = 250;
+
+ /**
+ * @private
+ */
+ protected static function defaultLoaderFactory():ImageLoader
+ {
+ return new ImageLoader();
+ }
+
+ /**
+ * Constructor.
+ */
+ public function BaseDefaultItemRenderer()
+ {
+ super();
+ this.isFocusEnabled = false;
+ this.isQuickHitAreaEnabled = false;
+ this.addEventListener(Event.TRIGGERED, itemRenderer_triggeredHandler);
+ }
+
+ /**
+ * The value added to the styleNameList of the icon label
+ * text renderer, if it exists.
+ *
+ * @see feathers.core.FeathersControl#styleNameList
+ */
+ protected var iconLabelStyleName:String = DEFAULT_CHILD_STYLE_NAME_ICON_LABEL;
+
+ /**
+ * DEPRECATED: Replaced by iconLabelStyleName.
+ *
+ * DEPRECATION WARNING: This property is deprecated
+ * starting with Feathers 2.1. It will be removed in a future version of
+ * Feathers according to the standard
+ * Feathers deprecation policy.
+ *
+ * @see #iconLabelStyleName
+ */
+ protected function get iconLabelName():String
+ {
+ return this.iconLabelStyleName;
+ }
+
+ /**
+ * @private
+ */
+ protected function set iconLabelName(value:String):void
+ {
+ this.iconLabelStyleName = value;
+ }
+
+ /**
+ * The value added to the styleNameList of the accessory
+ * label text renderer, if it exists.
+ *
+ * @see feathers.core.FeathersControl#styleNameList
+ */
+ protected var accessoryLabelStyleName:String = DEFAULT_CHILD_STYLE_NAME_ACCESSORY_LABEL;
+
+ /**
+ * DEPRECATED: Replaced by accessoryLabelStyleName.
+ *
+ * DEPRECATION WARNING: This property is deprecated
+ * starting with Feathers 2.1. It will be removed in a future version of
+ * Feathers according to the standard
+ * Feathers deprecation policy.
+ *
+ * @see #accessoryLabelStyleName
+ */
+ protected function get accessoryLabelName():String
+ {
+ return this.accessoryLabelStyleName;
+ }
+
+ /**
+ * @private
+ */
+ protected function set accessoryLabelName(value:String):void
+ {
+ this.accessoryLabelStyleName = value;
+ }
+
+ /**
+ * @private
+ */
+ protected var _isChildFocusEnabled:Boolean = true;
+
+ /**
+ * @copy feathers.core.IFocusContainer#isChildFocusEnabled
+ *
+ * @default true
+ *
+ * @see #isFocusEnabled
+ */
+ public function get isChildFocusEnabled():Boolean
+ {
+ return this._isEnabled && this._isChildFocusEnabled;
+ }
+
+ /**
+ * @private
+ */
+ public function set isChildFocusEnabled(value:Boolean):void
+ {
+ this._isChildFocusEnabled = value;
+ }
+
+ /**
+ * @private
+ */
+ protected var skinLoader:ImageLoader;
+
+ /**
+ * @private
+ */
+ protected var iconLoader:ImageLoader;
+
+ /**
+ * @private
+ */
+ protected var iconLabel:ITextRenderer;
+
+ /**
+ * @private
+ */
+ protected var accessoryLoader:ImageLoader;
+
+ /**
+ * @private
+ */
+ protected var accessoryLabel:ITextRenderer;
+
+ /**
+ * @private
+ */
+ protected var accessory:DisplayObject;
+
+ /**
+ * @private
+ */
+ protected var _skinIsFromItem:Boolean = false;
+
+ /**
+ * @private
+ */
+ protected var _iconIsFromItem:Boolean = false;
+
+ /**
+ * @private
+ */
+ protected var _accessoryIsFromItem:Boolean = false;
+
+ /**
+ * @private
+ */
+ override public function set defaultIcon(value:DisplayObject):void
+ {
+ if(this._iconSelector.defaultValue == value)
+ {
+ return;
+ }
+ this.replaceIcon(null);
+ this._iconIsFromItem = false;
+ super.defaultIcon = value;
+ }
+
+ /**
+ * @private
+ */
+ override public function set defaultSkin(value:DisplayObject):void
+ {
+ if(this._skinSelector.defaultValue == value)
+ {
+ return;
+ }
+ this.replaceSkin(null);
+ this._skinIsFromItem = false;
+ super.defaultSkin = value;
+ }
+
+ /**
+ * @private
+ */
+ protected var _data:Object;
+
+ /**
+ * The item displayed by this renderer. This property is set by the
+ * list, and should not be set manually.
+ */
+ public function get data():Object
+ {
+ return this._data;
+ }
+
+ /**
+ * @private
+ */
+ public function set data(value:Object):void
+ {
+ //we need to use strict equality here because the data can be
+ //non-strictly equal to null
+ if(this._data === value)
+ {
+ return;
+ }
+ this._data = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _owner:Scroller;
+
+ /**
+ * @private
+ */
+ protected var _delayedCurrentState:String;
+
+ /**
+ * @private
+ */
+ protected var _stateDelayTimer:Timer;
+
+ /**
+ * @private
+ */
+ protected var _useStateDelayTimer:Boolean = true;
+
+ /**
+ * If true, the down state (and subsequent state changes) will be
+ * delayed to make scrolling look nicer.
+ *
+ * In the following example, the state delay timer is disabled:
+ *
+ *
+ * renderer.useStateDelayTimer = false;
+ *
+ * @default true
+ */
+ public function get useStateDelayTimer():Boolean
+ {
+ return this._useStateDelayTimer;
+ }
+
+ /**
+ * @private
+ */
+ public function set useStateDelayTimer(value:Boolean):void
+ {
+ this._useStateDelayTimer = value;
+ }
+
+ /**
+ * Determines if the item renderer can be selected even if
+ * isToggle is set to false. Subclasses are
+ * expected to change this value, if required.
+ */
+ protected var isSelectableWithoutToggle:Boolean = true;
+
+ /**
+ * @private
+ */
+ protected var _itemHasLabel:Boolean = true;
+
+ /**
+ * If true, the label will come from the renderer's item using the
+ * appropriate field or function for the label. If false, the label may
+ * be set externally.
+ *
+ * In the following example, the item doesn't have a label:
+ *
+ *
+ * renderer.itemHasLabel = false;
+ *
+ * @default true
+ */
+ public function get itemHasLabel():Boolean
+ {
+ return this._itemHasLabel;
+ }
+
+ /**
+ * @private
+ */
+ public function set itemHasLabel(value:Boolean):void
+ {
+ if(this._itemHasLabel == value)
+ {
+ return;
+ }
+ this._itemHasLabel = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _itemHasIcon:Boolean = true;
+
+ /**
+ * If true, the icon will come from the renderer's item using the
+ * appropriate field or function for the icon. If false, the icon may
+ * be skinned for each state externally.
+ *
+ * In the following example, the item doesn't have an icon:
+ *
+ *
+ * renderer.itemHasIcon = false;
+ *
+ * @default true
+ */
+ public function get itemHasIcon():Boolean
+ {
+ return this._itemHasIcon;
+ }
+
+ /**
+ * @private
+ */
+ public function set itemHasIcon(value:Boolean):void
+ {
+ if(this._itemHasIcon == value)
+ {
+ return;
+ }
+ this._itemHasIcon = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _itemHasAccessory:Boolean = true;
+
+ /**
+ * If true, the accessory will come from the renderer's item using the
+ * appropriate field or function for the accessory. If false, the
+ * accessory may be set using other means.
+ *
+ * In the following example, the item doesn't have an accessory:
+ *
+ *
+ * renderer.itemHasAccessory = false;
+ *
+ * @default true
+ */
+ public function get itemHasAccessory():Boolean
+ {
+ return this._itemHasAccessory;
+ }
+
+ /**
+ * @private
+ */
+ public function set itemHasAccessory(value:Boolean):void
+ {
+ if(this._itemHasAccessory == value)
+ {
+ return;
+ }
+ this._itemHasAccessory = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _itemHasSkin:Boolean = false;
+
+ /**
+ * If true, the skin will come from the renderer's item using the
+ * appropriate field or function for the skin. If false, the skin may
+ * be set for each state externally.
+ *
+ * In the following example, the item has a skin:
+ *
+ *
+ * renderer.itemHasSkin = true;
+ * renderer.skinField = "background";
+ *
+ * @default false
+ */
+ public function get itemHasSkin():Boolean
+ {
+ return this._itemHasSkin;
+ }
+
+ /**
+ * @private
+ */
+ public function set itemHasSkin(value:Boolean):void
+ {
+ if(this._itemHasSkin == value)
+ {
+ return;
+ }
+ this._itemHasSkin = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _itemHasSelectable:Boolean = false;
+
+ /**
+ * If true, the ability to select the renderer will come from the
+ * renderer's item using the appropriate field or function for
+ * selectable. If false, the renderer will be selectable if its owner
+ * is selectable.
+ *
+ * In the following example, the item doesn't have an accessory:
+ *
+ *
+ * renderer.itemHasSelectable = true;
+ *
+ * @default false
+ */
+ public function get itemHasSelectable():Boolean
+ {
+ return this._itemHasSelectable;
+ }
+
+ /**
+ * @private
+ */
+ public function set itemHasSelectable(value:Boolean):void
+ {
+ if(this._itemHasSelectable == value)
+ {
+ return;
+ }
+ this._itemHasSelectable = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _itemHasEnabled:Boolean = false;
+
+ /**
+ * If true, the renderer's enabled state will come from the renderer's
+ * item using the appropriate field or function for enabled. If false,
+ * the renderer will be enabled if its owner is enabled.
+ *
+ * In the following example, the item doesn't have an accessory:
+ *
+ *
+ * renderer.itemHasEnabled = true;
+ *
+ * @default false
+ */
+ public function get itemHasEnabled():Boolean
+ {
+ return this._itemHasEnabled;
+ }
+
+ /**
+ * @private
+ */
+ public function set itemHasEnabled(value:Boolean):void
+ {
+ if(this._itemHasEnabled == value)
+ {
+ return;
+ }
+ this._itemHasEnabled = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _accessoryPosition:String = ACCESSORY_POSITION_RIGHT;
+
+ [Inspectable(type="String",enumeration="top,right,bottom,left,manual")]
+ /**
+ * The location of the accessory, relative to one of the other children.
+ * Use ACCESSORY_POSITION_MANUAL to position the accessory
+ * from the top-left corner.
+ *
+ * In the following example, the accessory is placed on the bottom:
+ *
+ *
+ * renderer.accessoryPosition = BaseDefaultItemRenderer.ACCESSORY_POSITION_BOTTOM;
+ *
+ * @default BaseDefaultItemRenderer.ACCESSORY_POSITION_RIGHT
+ *
+ * @see #ACCESSORY_POSITION_TOP
+ * @see #ACCESSORY_POSITION_RIGHT
+ * @see #ACCESSORY_POSITION_BOTTOM
+ * @see #ACCESSORY_POSITION_LEFT
+ * @see #ACCESSORY_POSITION_MANUAL
+ * @see #layoutOrder
+ */
+ public function get accessoryPosition():String
+ {
+ return this._accessoryPosition;
+ }
+
+ /**
+ * @private
+ */
+ public function set accessoryPosition(value:String):void
+ {
+ if(this._accessoryPosition == value)
+ {
+ return;
+ }
+ this._accessoryPosition = value;
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _layoutOrder:String = LAYOUT_ORDER_LABEL_ICON_ACCESSORY;
+
+ [Inspectable(type="String",enumeration="labelIconAccessory,labelAccessoryIcon")]
+ /**
+ * The accessory's position will be based on which other child (the
+ * label or the icon) the accessory should be relative to.
+ *
+ * The accessoryPositionOrigin property will be ignored
+ * if accessoryPosition is set to ACCESSORY_POSITION_MANUAL.
+ *
+ * In the following example, the layout order is changed:
+ *
+ *
+ * renderer.layoutOrder = BaseDefaultItemRenderer.LAYOUT_ORDER_LABEL_ACCESSORY_ICON;
+ *
+ * @default BaseDefaultItemRenderer.LAYOUT_ORDER_LABEL_ICON_ACCESSORY
+ *
+ * @see #LAYOUT_ORDER_LABEL_ICON_ACCESSORY
+ * @see #LAYOUT_ORDER_LABEL_ACCESSORY_ICON
+ * @see #accessoryPosition
+ * @see #iconPosition
+ */
+ public function get layoutOrder():String
+ {
+ return this._layoutOrder;
+ }
+
+ /**
+ * @private
+ */
+ public function set layoutOrder(value:String):void
+ {
+ if(this._layoutOrder == value)
+ {
+ return;
+ }
+ this._layoutOrder = value;
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _accessoryOffsetX:Number = 0;
+
+ /**
+ * Offsets the x position of the accessory by a certain number of pixels.
+ *
+ * In the following example, the accessory x position is adjusted by 20 pixels:
+ *
+ *
+ * renderer.accessoryOffsetX = 20;
+ *
+ * @default 0
+ *
+ * @see #accessoryOffsetY
+ */
+ public function get accessoryOffsetX():Number
+ {
+ return this._accessoryOffsetX;
+ }
+
+ /**
+ * @private
+ */
+ public function set accessoryOffsetX(value:Number):void
+ {
+ if(this._accessoryOffsetX == value)
+ {
+ return;
+ }
+ this._accessoryOffsetX = value;
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _accessoryOffsetY:Number = 0;
+
+ /**
+ * Offsets the y position of the accessory by a certain number of pixels.
+ *
+ * In the following example, the accessory y position is adjusted by 20 pixels:
+ *
+ *
+ * renderer.accessoryOffsetY = 20;
+ *
+ * @default 0
+ *
+ * @see #accessoryOffsetX
+ */
+ public function get accessoryOffsetY():Number
+ {
+ return this._accessoryOffsetY;
+ }
+
+ /**
+ * @private
+ */
+ public function set accessoryOffsetY(value:Number):void
+ {
+ if(this._accessoryOffsetY == value)
+ {
+ return;
+ }
+ this._accessoryOffsetY = value;
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _accessoryGap:Number = NaN;
+
+ /**
+ * The space, in pixels, between the accessory and the other child it is
+ * positioned relative to. Applies to either horizontal or vertical
+ * spacing, depending on the value of accessoryPosition. If
+ * the value is NaN, the value of the gap
+ * property will be used instead.
+ *
+ * If accessoryGap is set to Number.POSITIVE_INFINITY,
+ * the accessory and the component it is relative to will be positioned
+ * as far apart as possible.
+ *
+ * In the following example, the accessory gap is set to 20 pixels:
+ *
+ *
+ * renderer.accessoryGap = 20;
+ *
+ * @default NaN
+ *
+ * @see #gap
+ * @see #accessoryPosition
+ */
+ public function get accessoryGap():Number
+ {
+ return this._accessoryGap;
+ }
+
+ /**
+ * @private
+ */
+ public function set accessoryGap(value:Number):void
+ {
+ if(this._accessoryGap == value)
+ {
+ return;
+ }
+ this._accessoryGap = value;
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _minAccessoryGap:Number = NaN;
+
+ /**
+ * If the value of the accessoryGap property is
+ * Number.POSITIVE_INFINITY, meaning that the gap will
+ * fill as much space as possible, the final calculated value will not be
+ * smaller than the value of the minAccessoryGap property.
+ * If the value of minAccessoryGap is NaN, the
+ * value of the minGap property will be used instead.
+ *
+ * The following example ensures that the gap is never smaller than
+ * 20 pixels:
+ *
+ *
+ * button.gap = Number.POSITIVE_INFINITY;
+ * button.minGap = 20;
+ *
+ *
+ * renderer.accessoryGap = 20;
+ *
+ * @default NaN
+ *
+ * @see #accessoryGap
+ */
+ public function get minAccessoryGap():Number
+ {
+ return this._minAccessoryGap;
+ }
+
+ /**
+ * @private
+ */
+ public function set minAccessoryGap(value:Number):void
+ {
+ if(this._minAccessoryGap == value)
+ {
+ return;
+ }
+ this._minAccessoryGap = value;
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ override protected function set currentState(value:String):void
+ {
+ if(this._isEnabled && !this._isToggle && (!this.isSelectableWithoutToggle || (this._itemHasSelectable && !this.itemToSelectable(this._data))))
+ {
+ value = STATE_UP;
+ }
+ if(this._useStateDelayTimer)
+ {
+ if(this._stateDelayTimer && this._stateDelayTimer.running)
+ {
+ this._delayedCurrentState = value;
+ return;
+ }
+
+ if(value == Button.STATE_DOWN)
+ {
+ if(this._currentState == value)
+ {
+ return;
+ }
+ this._delayedCurrentState = value;
+ if(this._stateDelayTimer)
+ {
+ this._stateDelayTimer.reset();
+ }
+ else
+ {
+ this._stateDelayTimer = new Timer(DOWN_STATE_DELAY_MS, 1);
+ this._stateDelayTimer.addEventListener(TimerEvent.TIMER_COMPLETE, stateDelayTimer_timerCompleteHandler);
+ }
+ this._stateDelayTimer.start();
+ return;
+ }
+ }
+ super.currentState = value;
+ }
+
+ /**
+ * @private
+ */
+ protected var accessoryTouchPointID:int = -1;
+
+ /**
+ * @private
+ */
+ protected var _stopScrollingOnAccessoryTouch:Boolean = true;
+
+ /**
+ * If enabled, calls owner.stopScrolling() when TouchEvents are
+ * dispatched by the accessory.
+ *
+ * In the following example, the list won't stop scrolling when the
+ * accessory is touched:
+ *
+ *
+ * renderer.stopScrollingOnAccessoryTouch = false;
+ *
+ * @default true
+ */
+ public function get stopScrollingOnAccessoryTouch():Boolean
+ {
+ return this._stopScrollingOnAccessoryTouch;
+ }
+
+ /**
+ * @private
+ */
+ public function set stopScrollingOnAccessoryTouch(value:Boolean):void
+ {
+ this._stopScrollingOnAccessoryTouch = value;
+ }
+
+ /**
+ * @private
+ */
+ protected var _isSelectableOnAccessoryTouch:Boolean = false;
+
+ /**
+ * If enabled, the item renderer may be selected by touching the
+ * accessory. By default, the accessory will not trigger selection when
+ * using accessoryField or accessoryFunction.
+ *
+ * In the following example, the item renderer can be selected when
+ * the accessory is touched:
+ *
+ *
+ * renderer.isSelectableOnAccessoryTouch = true;
+ *
+ * @default false
+ */
+ public function get isSelectableOnAccessoryTouch():Boolean
+ {
+ return this._isSelectableOnAccessoryTouch;
+ }
+
+ /**
+ * @private
+ */
+ public function set isSelectableOnAccessoryTouch(value:Boolean):void
+ {
+ this._isSelectableOnAccessoryTouch = value;
+ }
+
+ /**
+ * @private
+ */
+ protected var _delayTextureCreationOnScroll:Boolean = false;
+
+ /**
+ * If enabled, automatically manages the delayTextureCreation
+ * property on accessory and icon ImageLoader instances
+ * when the owner scrolls. This applies to the loaders created when the
+ * following properties are set: accessorySourceField,
+ * accessorySourceFunction, iconSourceField,
+ * and iconSourceFunction.
+ *
+ * In the following example, any loaded textures won't be uploaded to
+ * the GPU until the owner stops scrolling:
+ *
+ *
+ * renderer.delayTextureCreationOnScroll = true;
+ *
+ * @default false
+ */
+ public function get delayTextureCreationOnScroll():Boolean
+ {
+ return this._delayTextureCreationOnScroll;
+ }
+
+ /**
+ * @private
+ */
+ public function set delayTextureCreationOnScroll(value:Boolean):void
+ {
+ this._delayTextureCreationOnScroll = value;
+ }
+
+ /**
+ * @private
+ */
+ protected var _labelField:String = "label";
+
+ /**
+ * The field in the item that contains the label text to be displayed by
+ * the renderer. If the item does not have this field, and a
+ * labelFunction is not defined, then the renderer will
+ * default to calling toString() on the item. To omit the
+ * label completely, either provide a custom item renderer without a
+ * label or define a labelFunction that returns an empty
+ * string.
+ *
+ * All of the label fields and functions, ordered by priority:
+ *
+ * labelFunctionlabelField
+ *
+ * In the following example, the label field is customized:
+ *
+ *
+ * renderer.labelField = "text";
+ *
+ * @default "label"
+ *
+ * @see #labelFunction
+ */
+ public function get labelField():String
+ {
+ return this._labelField;
+ }
+
+ /**
+ * @private
+ */
+ public function set labelField(value:String):void
+ {
+ if(this._labelField == value)
+ {
+ return;
+ }
+ this._labelField = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _labelFunction:Function;
+
+ /**
+ * A function used to generate label text for a specific item. If this
+ * function is not null, then the labelField will be
+ * ignored.
+ *
+ * The function is expected to have the following signature:
+ * function( item:Object ):String
+ *
+ * All of the label fields and functions, ordered by priority:
+ *
+ * labelFunctionlabelField
+ *
+ * In the following example, the label function is customized:
+ *
+ *
+ * renderer.labelFunction = function( item:Object ):String
+ * {
+ * return item.firstName + " " + item.lastName;
+ * };
+ *
+ * @default null
+ *
+ * @see #labelField
+ */
+ public function get labelFunction():Function
+ {
+ return this._labelFunction;
+ }
+
+ /**
+ * @private
+ */
+ public function set labelFunction(value:Function):void
+ {
+ if(this._labelFunction == value)
+ {
+ return;
+ }
+ this._labelFunction = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _iconField:String = "icon";
+
+ /**
+ * The field in the item that contains a display object to be displayed
+ * as an icon or other graphic next to the label in the renderer.
+ *
+ * Warning: It is your responsibility to dispose all icons
+ * included in the data provider and accessed with iconField,
+ * or any display objects returned by iconFunction.
+ * These display objects will not be disposed when the list is disposed.
+ * Not disposing an icon may result in a memory leak.
+ *
+ * All of the icon fields and functions, ordered by priority:
+ *
+ * iconSourceFunctioniconSourceFieldiconLabelFunctioniconLabelFieldiconFunctioniconField
+ *
+ * In the following example, the icon field is customized:
+ *
+ *
+ * renderer.iconField = "photo";
+ *
+ * @default "icon"
+ *
+ * @see #itemHasIcon
+ * @see #iconFunction
+ * @see #iconSourceField
+ * @see #iconSourceFunction
+ */
+ public function get iconField():String
+ {
+ return this._iconField;
+ }
+
+ /**
+ * @private
+ */
+ public function set iconField(value:String):void
+ {
+ if(this._iconField == value)
+ {
+ return;
+ }
+ this._iconField = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _iconFunction:Function;
+
+ /**
+ * A function used to generate an icon for a specific item.
+ *
+ * Note: As the list scrolls, this function will almost always be
+ * called more than once for each individual item in the list's data
+ * provider. Your function should not simply return a new icon every
+ * time. This will result in the unnecessary creation and destruction of
+ * many icons, which will overwork the garbage collector and hurt
+ * performance. It's better to return a new icon the first time this
+ * function is called for a particular item and then return the same
+ * icon if that item is passed to this function again.
+ *
+ * Warning: It is your responsibility to dispose all icons
+ * included in the data provider and accessed with iconField,
+ * or any display objects returned by iconFunction.
+ * These display objects will not be disposed when the list is disposed.
+ * Not disposing an icon may result in a memory leak.
+ *
+ * The function is expected to have the following signature:
+ * function( item:Object ):DisplayObject
+ *
+ * All of the icon fields and functions, ordered by priority:
+ *
+ * iconSourceFunctioniconSourceFieldiconLabelFunctioniconLabelFieldiconFunctioniconField
+ *
+ * In the following example, the icon function is customized:
+ *
+ *
+ * renderer.iconFunction = function( item:Object ):DisplayObject
+ * {
+ * if(item in cachedIcons)
+ * {
+ * return cachedIcons[item];
+ * }
+ * var icon:Image = new Image( textureAtlas.getTexture( item.textureName ) );
+ * cachedIcons[item] = icon;
+ * return icon;
+ * };
+ *
+ * @default null
+ *
+ * @see #itemHasIcon
+ * @see #iconField
+ * @see #iconSourceField
+ * @see #iconSourceFunction
+ */
+ public function get iconFunction():Function
+ {
+ return this._iconFunction;
+ }
+
+ /**
+ * @private
+ */
+ public function set iconFunction(value:Function):void
+ {
+ if(this._iconFunction == value)
+ {
+ return;
+ }
+ this._iconFunction = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _iconSourceField:String = "iconSource";
+
+ /**
+ * The field in the item that contains a starling.textures.Texture
+ * or a URL that points to a bitmap to be used as the item renderer's
+ * icon. The renderer will automatically manage and reuse an internal
+ * ImageLoader sub-component and this value will be passed
+ * to the source property. The ImageLoader may
+ * be customized by changing the iconLoaderFactory.
+ *
+ * Using an icon source will result in better performance than
+ * passing in an ImageLoader or Image through
+ * a iconField or iconFunction
+ * because the renderer can avoid costly display list manipulation.
+ *
+ * All of the icon fields and functions, ordered by priority:
+ *
+ * iconSourceFunctioniconSourceFieldiconLabelFunctioniconLabelFieldiconFunctioniconField
+ *
+ * In the following example, the icon source field is customized:
+ *
+ *
+ * renderer.iconSourceField = "texture";
+ *
+ * @default "iconSource"
+ *
+ * @see feathers.controls.ImageLoader#source
+ * @see #itemHasIcon
+ * @see #iconLoaderFactory
+ * @see #iconSourceFunction
+ * @see #iconField
+ * @see #iconFunction
+ */
+ public function get iconSourceField():String
+ {
+ return this._iconSourceField;
+ }
+
+ /**
+ * @private
+ */
+ public function set iconSourceField(value:String):void
+ {
+ if(this._iconSourceField == value)
+ {
+ return;
+ }
+ this._iconSourceField = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _iconSourceFunction:Function;
+
+ /**
+ * A function used to generate a starling.textures.Texture
+ * or a URL that points to a bitmap to be used as the item renderer's
+ * icon. The renderer will automatically manage and reuse an internal
+ * ImageLoader sub-component and this value will be passed
+ * to the source property. The ImageLoader may
+ * be customized by changing the iconLoaderFactory.
+ *
+ * Using an icon source will result in better performance than
+ * passing in an ImageLoader or Image through
+ * a iconField or iconFunction
+ * because the renderer can avoid costly display list manipulation.
+ *
+ * Note: As the list scrolls, this function will almost always be
+ * called more than once for each individual item in the list's data
+ * provider. Your function should not simply return a new texture every
+ * time. This will result in the unnecessary creation and destruction of
+ * many textures, which will overwork the garbage collector and hurt
+ * performance. Creating a new texture at all is dangerous, unless you
+ * are absolutely sure to dispose it when necessary because neither the
+ * list nor its item renderer will dispose of the texture for you. If
+ * you are absolutely sure that you are managing the texture memory with
+ * proper disposal, it's better to return a new texture the first
+ * time this function is called for a particular item and then return
+ * the same texture if that item is passed to this function again.
+ *
+ * The function is expected to have the following signature:
+ * function( item:Object ):Object
+ *
+ * The return value is a valid value for the source
+ * property of an ImageLoader component.
+ *
+ * All of the icon fields and functions, ordered by priority:
+ *
+ * iconSourceFunctioniconSourceFieldiconLabelFunctioniconLabelFieldiconFunctioniconField
+ *
+ * In the following example, the icon source function is customized:
+ *
+ *
+ * renderer.iconSourceFunction = function( item:Object ):Object
+ * {
+ * return "http://www.example.com/thumbs/" + item.name + "-thumb.png";
+ * };
+ *
+ * @default null
+ *
+ * @see feathers.controls.ImageLoader#source
+ * @see #itemHasIcon
+ * @see #iconLoaderFactory
+ * @see #iconSourceField
+ * @see #iconField
+ * @see #iconFunction
+ */
+ public function get iconSourceFunction():Function
+ {
+ return this._iconSourceFunction;
+ }
+
+ /**
+ * @private
+ */
+ public function set iconSourceFunction(value:Function):void
+ {
+ if(this._iconSourceFunction == value)
+ {
+ return;
+ }
+ this._iconSourceFunction = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _iconLabelField:String = "iconLabel";
+
+ /**
+ * The field in the item that contains a string to be displayed in a
+ * renderer-managed ITextRenderer in the icon position of
+ * the renderer. The renderer will automatically reuse an internal
+ * ITextRenderer and swap the text when the data changes.
+ * This ITextRenderer may be skinned by changing the
+ * iconLabelFactory.
+ *
+ * Using an icon label will result in better performance than
+ * passing in an ITextRenderer through a iconField
+ * or iconFunction because the renderer can avoid
+ * costly display list manipulation.
+ *
+ * All of the icon fields and functions, ordered by priority:
+ *
+ * iconSourceFunctioniconSourceFieldiconLabelFunctioniconLabelFieldiconFunctioniconField
+ *
+ * In the following example, the icon label field is customized:
+ *
+ *
+ * renderer.iconLabelField = "text";
+ *
+ * @default "iconLabel"
+ *
+ * @see #itemHasIcon
+ * @see #iconLabelFactory
+ * @see #iconLabelFunction
+ * @see #iconField
+ * @see #iconFunction
+ * @see #iconySourceField
+ * @see #iconSourceFunction
+ */
+ public function get iconLabelField():String
+ {
+ return this._iconLabelField;
+ }
+
+ /**
+ * @private
+ */
+ public function set iconLabelField(value:String):void
+ {
+ if(this._iconLabelField == value)
+ {
+ return;
+ }
+ this._iconLabelField = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _iconLabelFunction:Function;
+
+ /**
+ * A function that returns a string to be displayed in a
+ * renderer-managed ITextRenderer in the icon position of
+ * the renderer. The renderer will automatically reuse an internal
+ * ITextRenderer and swap the text when the data changes.
+ * This ITextRenderer may be skinned by changing the
+ * iconLabelFactory.
+ *
+ * Using an icon label will result in better performance than
+ * passing in an ITextRenderer through a iconField
+ * or iconFunction because the renderer can avoid costly
+ * display list manipulation.
+ *
+ * The function is expected to have the following signature:
+ * function( item:Object ):String
+ *
+ * All of the icon fields and functions, ordered by priority:
+ *
+ * iconSourceFunctioniconSourceFieldiconLabelFunctioniconLabelFieldiconFunctioniconField
+ *
+ * In the following example, the icon label function is customized:
+ *
+ *
+ * renderer.iconLabelFunction = function( item:Object ):String
+ * {
+ * return item.firstName + " " + item.lastName;
+ * };
+ *
+ * @default null
+ *
+ * @see #itemHasIcon
+ * @see #iconLabelFactory
+ * @see #iconLabelField
+ * @see #iconField
+ * @see #iconFunction
+ * @see #iconSourceField
+ * @see #iconSourceFunction
+ */
+ public function get iconLabelFunction():Function
+ {
+ return this._iconLabelFunction;
+ }
+
+ /**
+ * @private
+ */
+ public function set iconLabelFunction(value:Function):void
+ {
+ if(this._iconLabelFunction == value)
+ {
+ return;
+ }
+ this._iconLabelFunction = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _accessoryField:String = "accessory";
+
+ /**
+ * The field in the item that contains a display object to be positioned
+ * in the accessory position of the renderer. If you wish to display an
+ * Image in the accessory position, it's better for
+ * performance to use accessorySourceField instead.
+ *
+ * Warning: It is your responsibility to dispose all accessories
+ * included in the data provider and accessed with accessoryField,
+ * or any display objects returned by accessoryFunction.
+ * These display objects will not be disposed when the list is disposed.
+ * Not disposing an accessory may result in a memory leak.
+ *
+ * All of the accessory fields and functions, ordered by priority:
+ *
+ * accessorySourceFunctionaccessorySourceFieldaccessoryLabelFunctionaccessoryLabelFieldaccessoryFunctionaccessoryField
+ *
+ * In the following example, the accessory field is customized:
+ *
+ *
+ * renderer.accessoryField = "component";
+ *
+ * @default "accessory"
+ *
+ * @see #itemHasAccessory
+ * @see #accessorySourceField
+ * @see #accessoryFunction
+ * @see #accessorySourceFunction
+ * @see #accessoryLabelField
+ * @see #accessoryLabelFunction
+ */
+ public function get accessoryField():String
+ {
+ return this._accessoryField;
+ }
+
+ /**
+ * @private
+ */
+ public function set accessoryField(value:String):void
+ {
+ if(this._accessoryField == value)
+ {
+ return;
+ }
+ this._accessoryField = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _accessoryFunction:Function;
+
+ /**
+ * A function that returns a display object to be positioned in the
+ * accessory position of the renderer. If you wish to display an
+ * Image in the accessory position, it's better for
+ * performance to use accessorySourceFunction instead.
+ *
+ * Note: As the list scrolls, this function will almost always be
+ * called more than once for each individual item in the list's data
+ * provider. Your function should not simply return a new accessory
+ * every time. This will result in the unnecessary creation and
+ * destruction of many icons, which will overwork the garbage collector
+ * and hurt performance. It's better to return a new accessory the first
+ * time this function is called for a particular item and then return
+ * the same accessory if that item is passed to this function again.
+ *
+ * Warning: It is your responsibility to dispose all accessories
+ * included in the data provider and accessed with accessoryField,
+ * or any display objects returned by accessoryFunction.
+ * These display objects will not be disposed when the list is disposed.
+ * Not disposing an accessory may result in a memory leak.
+ *
+ * The function is expected to have the following signature:
+ * function( item:Object ):DisplayObject
+ *
+ * All of the accessory fields and functions, ordered by priority:
+ *
+ * accessorySourceFunctionaccessorySourceFieldaccessoryLabelFunctionaccessoryLabelFieldaccessoryFunctionaccessoryField
+ *
+ * In the following example, the accessory function is customized:
+ *
+ *
+ * renderer.accessoryFunction = function( item:Object ):DisplayObject
+ * {
+ * if(item in cachedAccessories)
+ * {
+ * return cachedAccessories[item];
+ * }
+ * var accessory:DisplayObject = createAccessoryForItem( item );
+ * cachedAccessories[item] = accessory;
+ * return accessory;
+ * };
+ *
+ * @default null
+ **
+ * @see #itemHasAccessory
+ * @see #accessoryField
+ * @see #accessorySourceField
+ * @see #accessorySourceFunction
+ * @see #accessoryLabelField
+ * @see #accessoryLabelFunction
+ */
+ public function get accessoryFunction():Function
+ {
+ return this._accessoryFunction;
+ }
+
+ /**
+ * @private
+ */
+ public function set accessoryFunction(value:Function):void
+ {
+ if(this._accessoryFunction == value)
+ {
+ return;
+ }
+ this._accessoryFunction = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _accessorySourceField:String = "accessorySource";
+
+ /**
+ * A field in the item that contains a starling.textures.Texture
+ * or a URL that points to a bitmap to be used as the item renderer's
+ * accessory. The renderer will automatically manage and reuse an internal
+ * ImageLoader sub-component and this value will be passed
+ * to the source property. The ImageLoader may
+ * be customized by changing the accessoryLoaderFactory.
+ *
+ * Using an accessory source will result in better performance than
+ * passing in an ImageLoader or Image through
+ * a accessoryField or accessoryFunction because
+ * the renderer can avoid costly display list manipulation.
+ *
+ * All of the accessory fields and functions, ordered by priority:
+ *
+ * accessorySourceFunctionaccessorySourceFieldaccessoryLabelFunctionaccessoryLabelFieldaccessoryFunctionaccessoryField
+ *
+ * In the following example, the accessory source field is customized:
+ *
+ *
+ * renderer.accessorySourceField = "texture";
+ *
+ * @default "accessorySource"
+ *
+ * @see feathers.controls.ImageLoader#source
+ * @see #itemHasAccessory
+ * @see #accessoryLoaderFactory
+ * @see #accessorySourceFunction
+ * @see #accessoryField
+ * @see #accessoryFunction
+ * @see #accessoryLabelField
+ * @see #accessoryLabelFunction
+ */
+ public function get accessorySourceField():String
+ {
+ return this._accessorySourceField;
+ }
+
+ /**
+ * @private
+ */
+ public function set accessorySourceField(value:String):void
+ {
+ if(this._accessorySourceField == value)
+ {
+ return;
+ }
+ this._accessorySourceField = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _accessorySourceFunction:Function;
+
+ /**
+ * A function that generates a starling.textures.Texture
+ * or a URL that points to a bitmap to be used as the item renderer's
+ * accessory. The renderer will automatically manage and reuse an internal
+ * ImageLoader sub-component and this value will be passed
+ * to the source property. The ImageLoader may
+ * be customized by changing the accessoryLoaderFactory.
+ *
+ * Using an accessory source will result in better performance than
+ * passing in an ImageLoader or Image through
+ * a accessoryField or accessoryFunction
+ * because the renderer can avoid costly display list manipulation.
+ *
+ * Note: As the list scrolls, this function will almost always be
+ * called more than once for each individual item in the list's data
+ * provider. Your function should not simply return a new texture every
+ * time. This will result in the unnecessary creation and destruction of
+ * many textures, which will overwork the garbage collector and hurt
+ * performance. Creating a new texture at all is dangerous, unless you
+ * are absolutely sure to dispose it when necessary because neither the
+ * list nor its item renderer will dispose of the texture for you. If
+ * you are absolutely sure that you are managing the texture memory with
+ * proper disposal, it's better to return a new texture the first
+ * time this function is called for a particular item and then return
+ * the same texture if that item is passed to this function again.
+ *
+ * The function is expected to have the following signature:
+ * function( item:Object ):Object
+ *
+ * The return value is a valid value for the source
+ * property of an ImageLoader component.
+ *
+ * All of the accessory fields and functions, ordered by priority:
+ *
+ * accessorySourceFunctionaccessorySourceFieldaccessoryLabelFunctionaccessoryLabelFieldaccessoryFunctionaccessoryField
+ *
+ * In the following example, the accessory source function is customized:
+ *
+ *
+ * renderer.accessorySourceFunction = function( item:Object ):Object
+ * {
+ * return "http://www.example.com/thumbs/" + item.name + "-thumb.png";
+ * };
+ *
+ * @default null
+ *
+ * @see feathers.controls.ImageLoader#source
+ * @see #itemHasAccessory
+ * @see #accessoryLoaderFactory
+ * @see #accessorySourceField
+ * @see #accessoryField
+ * @see #accessoryFunction
+ * @see #accessoryLabelField
+ * @see #accessoryLabelFunction
+ */
+ public function get accessorySourceFunction():Function
+ {
+ return this._accessorySourceFunction;
+ }
+
+ /**
+ * @private
+ */
+ public function set accessorySourceFunction(value:Function):void
+ {
+ if(this._accessorySourceFunction == value)
+ {
+ return;
+ }
+ this._accessorySourceFunction = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _accessoryLabelField:String = "accessoryLabel";
+
+ /**
+ * The field in the item that contains a string to be displayed in a
+ * renderer-managed ITextRenderer in the accessory position
+ * of the renderer. The renderer will automatically reuse an internal
+ * ITextRenderer and swap the text when the data changes.
+ * This ITextRenderer may be skinned by changing the
+ * accessoryLabelFactory.
+ *
+ * Using an accessory label will result in better performance than
+ * passing in a ITextRenderer through an accessoryField
+ * or accessoryFunction because the renderer can avoid
+ * costly display list manipulation.
+ *
+ * All of the accessory fields and functions, ordered by priority:
+ *
+ * accessorySourceFunctionaccessorySourceFieldaccessoryLabelFunctionaccessoryLabelFieldaccessoryFunctionaccessoryField
+ *
+ * In the following example, the accessory label field is customized:
+ *
+ *
+ * renderer.accessoryLabelField = "text";
+ *
+ * @default "accessoryLabel"
+ **
+ * @see #itemHasAccessory
+ * @see #accessoryLabelFactory
+ * @see #accessoryLabelFunction
+ * @see #accessoryField
+ * @see #accessoryFunction
+ * @see #accessorySourceField
+ * @see #accessorySourceFunction
+ */
+ public function get accessoryLabelField():String
+ {
+ return this._accessoryLabelField;
+ }
+
+ /**
+ * @private
+ */
+ public function set accessoryLabelField(value:String):void
+ {
+ if(this._accessoryLabelField == value)
+ {
+ return;
+ }
+ this._accessoryLabelField = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _accessoryLabelFunction:Function;
+
+ /**
+ * A function that returns a string to be displayed in a
+ * renderer-managed ITextRenderer in the accessory position
+ * of the renderer. The renderer will automatically reuse an internal
+ * ITextRenderer and swap the text when the data changes.
+ * This ITextRenderer may be skinned by changing the
+ * accessoryLabelFactory.
+ *
+ * Using an accessory label will result in better performance than
+ * passing in an ITextRenderer through an accessoryField
+ * or accessoryFunction because the renderer can avoid
+ * costly display list manipulation.
+ *
+ * The function is expected to have the following signature:
+ * function( item:Object ):String
+ *
+ * All of the accessory fields and functions, ordered by priority:
+ *
+ * accessorySourceFunctionaccessorySourceFieldaccessoryLabelFunctionaccessoryLabelFieldaccessoryFunctionaccessoryField
+ *
+ * In the following example, the accessory label function is customized:
+ *
+ *
+ * renderer.accessoryLabelFunction = function( item:Object ):String
+ * {
+ * return item.firstName + " " + item.lastName;
+ * };
+ *
+ * @default null
+ **
+ * @see #itemHasAccessory
+ * @see #accessoryLabelFactory
+ * @see #accessoryLabelField
+ * @see #accessoryField
+ * @see #accessoryFunction
+ * @see #accessorySourceField
+ * @see #accessorySourceFunction
+ */
+ public function get accessoryLabelFunction():Function
+ {
+ return this._accessoryLabelFunction;
+ }
+
+ /**
+ * @private
+ */
+ public function set accessoryLabelFunction(value:Function):void
+ {
+ if(this._accessoryLabelFunction == value)
+ {
+ return;
+ }
+ this._accessoryLabelFunction = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _skinField:String = "skin";
+
+ /**
+ * The field in the item that contains a display object to be displayed
+ * as a background skin.
+ *
+ * All of the icon fields and functions, ordered by priority:
+ *
+ * skinSourceFunctionskinSourceFieldskinFunctionskinField
+ *
+ * In the following example, the skin field is customized:
+ *
+ *
+ * renderer.itemHasSkin = true;
+ * renderer.skinField = "background";
+ *
+ * @default "skin"
+ *
+ * @see #itemHasSkin
+ * @see #skinFunction
+ * @see #skinSourceField
+ * @see #skinSourceFunction
+ */
+ public function get skinField():String
+ {
+ return this._skinField;
+ }
+
+ /**
+ * @private
+ */
+ public function set skinField(value:String):void
+ {
+ if(this._skinField == value)
+ {
+ return;
+ }
+ this._skinField = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _skinFunction:Function;
+
+ /**
+ * A function used to generate a background skin for a specific item.
+ *
+ * Note: As the list scrolls, this function will almost always be
+ * called more than once for each individual item in the list's data
+ * provider. Your function should not simply return a new display object
+ * every time. This will result in the unnecessary creation and
+ * destruction of many skins, which will overwork the garbage collector
+ * and hurt performance. It's better to return a new skin the first time
+ * this function is called for a particular item and then return the same
+ * skin if that item is passed to this function again.
+ *
+ * The function is expected to have the following signature:
+ * function( item:Object ):DisplayObject
+ *
+ * All of the skin fields and functions, ordered by priority:
+ *
+ * skinSourceFunctionskinSourceFieldskinFunctionskinField
+ *
+ * In the following example, the skin function is customized:
+ *
+ *
+ * renderer.itemHasSkin = true;
+ * renderer.skinFunction = function( item:Object ):DisplayObject
+ * {
+ * if(item in cachedSkin)
+ * {
+ * return cachedSkin[item];
+ * }
+ * var skin:Image = new Image( textureAtlas.getTexture( item.textureName ) );
+ * cachedSkin[item] = skin;
+ * return skin;
+ * };
+ *
+ * @default null
+ *
+ * @see #itemHasSkin
+ * @see #skinField
+ * @see #skinSourceField
+ * @see #skinSourceFunction
+ */
+ public function get skinFunction():Function
+ {
+ return this._skinFunction;
+ }
+
+ /**
+ * @private
+ */
+ public function set skinFunction(value:Function):void
+ {
+ if(this._skinFunction == value)
+ {
+ return;
+ }
+ this._skinFunction = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _skinSourceField:String = "skinSource";
+
+ /**
+ * The field in the item that contains a starling.textures.Texture
+ * or a URL that points to a bitmap to be used as the item renderer's
+ * skin. The renderer will automatically manage and reuse an internal
+ * ImageLoader sub-component and this value will be passed
+ * to the source property. The ImageLoader may
+ * be customized by changing the skinLoaderFactory.
+ *
+ * Using a skin source will result in better performance than
+ * passing in an ImageLoader or Image through
+ * a skinField or skinFunction
+ * because the renderer can avoid costly display list manipulation.
+ *
+ * All of the skin fields and functions, ordered by priority:
+ *
+ * skinSourceFunctionskinSourceFieldskinFunctionskinField
+ *
+ * In the following example, the skin source field is customized:
+ *
+ *
+ * renderer.itemHasSkin = true;
+ * renderer.skinSourceField = "texture";
+ *
+ * @default "skinSource"
+ *
+ * @see feathers.controls.ImageLoader#source
+ * @see #itemHasSkin
+ * @see #skinLoaderFactory
+ * @see #skinSourceFunction
+ * @see #skinField
+ * @see #skinFunction
+ */
+ public function get skinSourceField():String
+ {
+ return this._skinSourceField;
+ }
+
+ /**
+ * @private
+ */
+ public function set skinSourceField(value:String):void
+ {
+ if(this._iconSourceField == value)
+ {
+ return;
+ }
+ this._skinSourceField = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _skinSourceFunction:Function;
+
+ /**
+ * A function used to generate a starling.textures.Texture
+ * or a URL that points to a bitmap to be used as the item renderer's
+ * skin. The renderer will automatically manage and reuse an internal
+ * ImageLoader sub-component and this value will be passed
+ * to the source property. The ImageLoader may
+ * be customized by changing the skinLoaderFactory.
+ *
+ * Using a skin source will result in better performance than
+ * passing in an ImageLoader or Image through
+ * a skinField or skinnFunction
+ * because the renderer can avoid costly display list manipulation.
+ *
+ * Note: As the list scrolls, this function will almost always be
+ * called more than once for each individual item in the list's data
+ * provider. Your function should not simply return a new texture every
+ * time. This will result in the unnecessary creation and destruction of
+ * many textures, which will overwork the garbage collector and hurt
+ * performance. Creating a new texture at all is dangerous, unless you
+ * are absolutely sure to dispose it when necessary because neither the
+ * list nor its item renderer will dispose of the texture for you. If
+ * you are absolutely sure that you are managing the texture memory with
+ * proper disposal, it's better to return a new texture the first
+ * time this function is called for a particular item and then return
+ * the same texture if that item is passed to this function again.
+ *
+ * The function is expected to have the following signature:
+ * function( item:Object ):Object
+ *
+ * The return value is a valid value for the source
+ * property of an ImageLoader component.
+ *
+ * All of the skin fields and functions, ordered by priority:
+ *
+ * skinSourceFunctionskinSourceFieldskinFunctionskinField
+ *
+ * In the following example, the skin source function is customized:
+ *
+ *
+ * renderer.itemHasSkin = true;
+ * renderer.skinSourceFunction = function( item:Object ):Object
+ * {
+ * return "http://www.example.com/images/" + item.name + "-skin.png";
+ * };
+ *
+ * @default null
+ *
+ * @see feathers.controls.ImageLoader#source
+ * @see #itemHasSkin
+ * @see #skinLoaderFactory
+ * @see #skinSourceField
+ * @see #skinField
+ * @see #skinFunction
+ */
+ public function get skinSourceFunction():Function
+ {
+ return this._skinSourceFunction;
+ }
+
+ /**
+ * @private
+ */
+ public function set skinSourceFunction(value:Function):void
+ {
+ if(this._skinSourceFunction == value)
+ {
+ return;
+ }
+ this._skinSourceFunction = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _selectableField:String = "selectable";
+
+ /**
+ * The field in the item that determines if the item renderer can be
+ * selected, if the list allows selection. If the item does not have
+ * this field, and a selectableFunction is not defined,
+ * then the renderer will default to being selectable.
+ *
+ * All of the label fields and functions, ordered by priority:
+ *
+ * selectableFunctionselectableField
+ *
+ * In the following example, the selectable field is customized:
+ *
+ *
+ * renderer.itemHasSelectable = true;
+ * renderer.selectableField = "isSelectable";
+ *
+ * @default "selectable"
+ *
+ * @see #selectableFunction
+ */
+ public function get selectableField():String
+ {
+ return this._selectableField;
+ }
+
+ /**
+ * @private
+ */
+ public function set selectableField(value:String):void
+ {
+ if(this._selectableField == value)
+ {
+ return;
+ }
+ this._selectableField = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _selectableFunction:Function;
+
+ /**
+ * A function used to determine if a specific item is selectable. If this
+ * function is not null, then the selectableField will be
+ * ignored.
+ *
+ * The function is expected to have the following signature:
+ * function( item:Object ):Boolean
+ *
+ * All of the selectable fields and functions, ordered by priority:
+ *
+ * selectableFunctionselectableField
+ *
+ * In the following example, the selectable function is customized:
+ *
+ *
+ * renderer.itemHasSelectable = true;
+ * renderer.selectableFunction = function( item:Object ):Boolean
+ * {
+ * return item.isSelectable;
+ * };
+ *
+ * @default null
+ *
+ * @see #selectableField
+ */
+ public function get selectableFunction():Function
+ {
+ return this._selectableFunction;
+ }
+
+ /**
+ * @private
+ */
+ public function set selectableFunction(value:Function):void
+ {
+ if(this._selectableFunction == value)
+ {
+ return;
+ }
+ this._selectableFunction = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _enabledField:String = "enabled";
+
+ /**
+ * The field in the item that determines if the item renderer is
+ * enabled, if the list is enabled. If the item does not have
+ * this field, and a enabledFunction is not defined,
+ * then the renderer will default to being enabled.
+ *
+ * All of the label fields and functions, ordered by priority:
+ *
+ * enabledFunctionenabledField
+ *
+ * In the following example, the enabled field is customized:
+ *
+ *
+ * renderer.itemHasEnabled = true;
+ * renderer.enabledField = "isEnabled";
+ *
+ * @default "enabled"
+ *
+ * @see #enabledFunction
+ */
+ public function get enabledField():String
+ {
+ return this._enabledField;
+ }
+
+ /**
+ * @private
+ */
+ public function set enabledField(value:String):void
+ {
+ if(this._enabledField == value)
+ {
+ return;
+ }
+ this._enabledField = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _enabledFunction:Function;
+
+ /**
+ * A function used to determine if a specific item is enabled. If this
+ * function is not null, then the enabledField will be
+ * ignored.
+ *
+ * The function is expected to have the following signature:
+ * function( item:Object ):Boolean
+ *
+ * All of the enabled fields and functions, ordered by priority:
+ *
+ * enabledFunctionenabledField
+ *
+ * In the following example, the enabled function is customized:
+ *
+ *
+ * renderer.itemHasEnabled = true;
+ * renderer.enabledFunction = function( item:Object ):Boolean
+ * {
+ * return item.isEnabled;
+ * };
+ *
+ * @default null
+ *
+ * @see #enabledField
+ */
+ public function get enabledFunction():Function
+ {
+ return this._enabledFunction;
+ }
+
+ /**
+ * @private
+ */
+ public function set enabledFunction(value:Function):void
+ {
+ if(this._enabledFunction == value)
+ {
+ return;
+ }
+ this._enabledFunction = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _explicitIsToggle:Boolean = false;
+
+ /**
+ * @private
+ */
+ override public function set isToggle(value:Boolean):void
+ {
+ if(this._explicitIsToggle == value)
+ {
+ return;
+ }
+ super.isToggle = value;
+ this._explicitIsToggle = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _explicitIsEnabled:Boolean = false;
+
+ /**
+ * @private
+ */
+ override public function set isEnabled(value:Boolean):void
+ {
+ if(this._explicitIsEnabled == value)
+ {
+ return;
+ }
+ this._explicitIsEnabled = value;
+ super.isEnabled = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ this.invalidate(INVALIDATION_FLAG_STATE);
+ }
+
+ /**
+ * @private
+ */
+ protected var _iconLoaderFactory:Function = defaultLoaderFactory;
+
+ /**
+ * A function that generates an ImageLoader that uses the result
+ * of iconSourceField or iconSourceFunction.
+ * Useful for transforming the ImageLoader in some way. For
+ * example, you might want to scale the texture for current screen
+ * density or apply pixel snapping.
+ *
+ * The function is expected to have the following signature:
+ * function():ImageLoader
+ *
+ * In the following example, the loader factory is customized:
+ *
+ *
+ * renderer.iconLoaderFactory = function():ImageLoader
+ * {
+ * var loader:ImageLoader = new ImageLoader();
+ * loader.snapToPixels = true;
+ * return loader;
+ * };
+ *
+ * @default function():ImageLoader { return new ImageLoader(); }
+ *
+ * @see feathers.controls.ImageLoader
+ * @see #iconSourceField
+ * @see #iconSourceFunction
+ */
+ public function get iconLoaderFactory():Function
+ {
+ return this._iconLoaderFactory;
+ }
+
+ /**
+ * @private
+ */
+ public function set iconLoaderFactory(value:Function):void
+ {
+ if(this._iconLoaderFactory == value)
+ {
+ return;
+ }
+ this._iconLoaderFactory = value;
+ this._iconIsFromItem = false;
+ this.replaceIcon(null);
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _iconLabelFactory:Function;
+
+ /**
+ * A function that generates ITextRenderer that uses the result
+ * of iconLabelField or iconLabelFunction.
+ * CAn be used to set properties on the ITextRenderer.
+ *
+ * The function is expected to have the following signature:
+ * function():ITextRenderer
+ *
+ * In the following example, the icon label factory is customized:
+ *
+ *
+ * renderer.iconLabelFactory = function():ITextRenderer
+ * {
+ * var renderer:TextFieldTextRenderer = new TextFieldTextRenderer();
+ * renderer.textFormat = new TextFormat( "Source Sans Pro", 16, 0x333333 );
+ * renderer.embedFonts = true;
+ * return renderer;
+ * };
+ *
+ * @default null
+ *
+ * @see feathers.core.ITextRenderer
+ * @see feathers.core.FeathersControl#defaultTextRendererFactory
+ * @see #iconLabelField
+ * @see #iconLabelFunction
+ */
+ public function get iconLabelFactory():Function
+ {
+ return this._iconLabelFactory;
+ }
+
+ /**
+ * @private
+ */
+ public function set iconLabelFactory(value:Function):void
+ {
+ if(this._iconLabelFactory == value)
+ {
+ return;
+ }
+ this._iconLabelFactory = value;
+ this._iconIsFromItem = false;
+ this.replaceIcon(null);
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _iconLabelProperties:PropertyProxy;
+
+ /**
+ * A set of key/value pairs to be passed down to a label icon, if one
+ * exists. The title is an ITextRenderer instance. The
+ * available properties depend on which ITextRenderer
+ * implementation is used.
+ *
+ * If the subcomponent has its own subcomponents, their properties
+ * can be set too, using attribute @ notation. For example,
+ * to set the skin on the thumb which is in a SimpleScrollBar,
+ * which is in a List, you can use the following syntax:
+ * list.verticalScrollBarProperties.@thumbProperties.defaultSkin = new Image(texture);
+ *
+ * Setting properties in a iconLabelFactory
+ * function instead of using iconLabelProperties will
+ * result in better performance.
+ *
+ * In the following example, the icon label properties are customized:
+ *
+ *
+ * renderer.@iconLabelProperties.textFormat = new TextFormat( "Source Sans Pro", 16, 0x333333 );
+ * renderer.@iconLabelProperties.embedFonts = true;
+ *
+ * @default null
+ *
+ * @see feathers.core.ITextRenderer
+ * @see #iconLabelFactory
+ * @see #iconLabelField
+ * @see #iconLabelFunction
+ */
+ public function get iconLabelProperties():Object
+ {
+ if(!this._iconLabelProperties)
+ {
+ this._iconLabelProperties = new PropertyProxy(childProperties_onChange);
+ }
+ return this._iconLabelProperties;
+ }
+
+ /**
+ * @private
+ */
+ public function set iconLabelProperties(value:Object):void
+ {
+ if(this._iconLabelProperties == value)
+ {
+ return;
+ }
+ if(!value)
+ {
+ value = new PropertyProxy();
+ }
+ if(!(value is PropertyProxy))
+ {
+ var newValue:PropertyProxy = new PropertyProxy();
+ for(var propertyName:String in value)
+ {
+ newValue[propertyName] = value[propertyName];
+ }
+ value = newValue;
+ }
+ if(this._iconLabelProperties)
+ {
+ this._iconLabelProperties.removeOnChangeCallback(childProperties_onChange);
+ }
+ this._iconLabelProperties = PropertyProxy(value);
+ if(this._iconLabelProperties)
+ {
+ this._iconLabelProperties.addOnChangeCallback(childProperties_onChange);
+ }
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _accessoryLoaderFactory:Function = defaultLoaderFactory;
+
+ /**
+ * A function that generates an ImageLoader that uses the result
+ * of accessorySourceField or accessorySourceFunction.
+ * Useful for transforming the ImageLoader in some way. For
+ * example, you might want to scale the texture for current screen
+ * density or apply pixel snapping.
+ *
+ * The function is expected to have the following signature:
+ * function():ImageLoader
+ *
+ * In the following example, the loader factory is customized:
+ *
+ *
+ * renderer.accessoryLoaderFactory = function():ImageLoader
+ * {
+ * var loader:ImageLoader = new ImageLoader();
+ * loader.snapToPixels = true;
+ * return loader;
+ * };
+ *
+ * @default function():ImageLoader { return new ImageLoader(); }
+ *
+ * @see feathers.controls.ImageLoader
+ * @see #accessorySourceField;
+ * @see #accessorySourceFunction;
+ */
+ public function get accessoryLoaderFactory():Function
+ {
+ return this._accessoryLoaderFactory;
+ }
+
+ /**
+ * @private
+ */
+ public function set accessoryLoaderFactory(value:Function):void
+ {
+ if(this._accessoryLoaderFactory == value)
+ {
+ return;
+ }
+ this._accessoryLoaderFactory = value;
+ this._accessoryIsFromItem = false;
+ this.replaceAccessory(null);
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _accessoryLabelFactory:Function;
+
+ /**
+ * A function that generates ITextRenderer that uses the result
+ * of accessoryLabelField or accessoryLabelFunction.
+ * CAn be used to set properties on the ITextRenderer.
+ *
+ * The function is expected to have the following signature:
+ * function():ITextRenderer
+ *
+ * In the following example, the accessory label factory is customized:
+ *
+ *
+ * renderer.accessoryLabelFactory = function():ITextRenderer
+ * {
+ * var renderer:TextFieldTextRenderer = new TextFieldTextRenderer();
+ * renderer.textFormat = new TextFormat( "Source Sans Pro", 16, 0x333333 );
+ * renderer.embedFonts = true;
+ * return renderer;
+ * };
+ *
+ * @default null
+ *
+ * @see feathers.core.ITextRenderer
+ * @see feathers.core.FeathersControl#defaultTextRendererFactory
+ * @see #accessoryLabelField
+ * @see #accessoryLabelFunction
+ */
+ public function get accessoryLabelFactory():Function
+ {
+ return this._accessoryLabelFactory;
+ }
+
+ /**
+ * @private
+ */
+ public function set accessoryLabelFactory(value:Function):void
+ {
+ if(this._accessoryLabelFactory == value)
+ {
+ return;
+ }
+ this._accessoryLabelFactory = value;
+ this._accessoryIsFromItem = false;
+ this.replaceAccessory(null);
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _accessoryLabelProperties:PropertyProxy;
+
+ /**
+ * A set of key/value pairs to be passed down to a label accessory. The
+ * title is an ITextRenderer instance. The available
+ * properties depend on which ITextRenderer implementation
+ * is used.
+ *
+ * If the subcomponent has its own subcomponents, their properties
+ * can be set too, using attribute @ notation. For example,
+ * to set the skin on the thumb which is in a SimpleScrollBar,
+ * which is in a List, you can use the following syntax:
+ * list.verticalScrollBarProperties.@thumbProperties.defaultSkin = new Image(texture);
+ *
+ * Setting properties in a accessoryLabelFactory
+ * function instead of using accessoryLabelProperties will
+ * result in better performance.
+ *
+ * In the following example, the accessory label properties are customized:
+ *
+ *
+ * renderer.@accessoryLabelProperties.textFormat = new TextFormat( "Source Sans Pro", 16, 0x333333 );
+ * renderer.@accessoryLabelProperties.embedFonts = true;
+ *
+ * @default null
+ *
+ * @see feathers.core.ITextRenderer
+ * @see #accessoryLabelFactory
+ * @see #accessoryLabelField
+ * @see #accessoryLabelFunction
+ */
+ public function get accessoryLabelProperties():Object
+ {
+ if(!this._accessoryLabelProperties)
+ {
+ this._accessoryLabelProperties = new PropertyProxy(childProperties_onChange);
+ }
+ return this._accessoryLabelProperties;
+ }
+
+ /**
+ * @private
+ */
+ public function set accessoryLabelProperties(value:Object):void
+ {
+ if(this._accessoryLabelProperties == value)
+ {
+ return;
+ }
+ if(!value)
+ {
+ value = new PropertyProxy();
+ }
+ if(!(value is PropertyProxy))
+ {
+ var newValue:PropertyProxy = new PropertyProxy();
+ for(var propertyName:String in value)
+ {
+ newValue[propertyName] = value[propertyName];
+ }
+ value = newValue;
+ }
+ if(this._accessoryLabelProperties)
+ {
+ this._accessoryLabelProperties.removeOnChangeCallback(childProperties_onChange);
+ }
+ this._accessoryLabelProperties = PropertyProxy(value);
+ if(this._accessoryLabelProperties)
+ {
+ this._accessoryLabelProperties.addOnChangeCallback(childProperties_onChange);
+ }
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _skinLoaderFactory:Function = defaultLoaderFactory;
+
+ /**
+ * A function that generates an ImageLoader that uses the result
+ * of skinSourceField or skinSourceFunction.
+ * Useful for transforming the ImageLoader in some way. For
+ * example, you might want to scale the texture for current screen
+ * density or apply pixel snapping.
+ *
+ * The function is expected to have the following signature:
+ * function():ImageLoader
+ *
+ * In the following example, the loader factory is customized:
+ *
+ *
+ * renderer.skinLoaderFactory = function():ImageLoader
+ * {
+ * var loader:ImageLoader = new ImageLoader();
+ * loader.snapToPixels = true;
+ * return loader;
+ * };
+ *
+ * @default function():ImageLoader { return new ImageLoader(); }
+ *
+ * @see feathers.controls.ImageLoader
+ * @see #skinSourceField
+ * @see #skinSourceFunction
+ */
+ public function get skinLoaderFactory():Function
+ {
+ return this._skinLoaderFactory;
+ }
+
+ /**
+ * @private
+ */
+ public function set skinLoaderFactory(value:Function):void
+ {
+ if(this._skinLoaderFactory == value)
+ {
+ return;
+ }
+ this._skinLoaderFactory = value;
+ this._skinIsFromItem = false;
+ this.replaceSkin(null);
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _ignoreAccessoryResizes:Boolean = false;
+
+ /**
+ * @private
+ */
+ override public function dispose():void
+ {
+ if(this._iconIsFromItem)
+ {
+ this.replaceIcon(null);
+ }
+ if(this._accessoryIsFromItem)
+ {
+ this.replaceAccessory(null);
+ }
+ if(this._skinIsFromItem)
+ {
+ this.replaceSkin(null);
+ }
+ if(this._stateDelayTimer)
+ {
+ if(this._stateDelayTimer.running)
+ {
+ this._stateDelayTimer.stop();
+ }
+ this._stateDelayTimer.removeEventListener(TimerEvent.TIMER_COMPLETE, stateDelayTimer_timerCompleteHandler);
+ this._stateDelayTimer = null;
+ }
+ super.dispose();
+ }
+
+ /**
+ * Using labelField and labelFunction,
+ * generates a label from the item.
+ *
+ * All of the label fields and functions, ordered by priority:
+ *
+ * labelFunctionlabelField
+ */
+ public function itemToLabel(item:Object):String
+ {
+ if(this._labelFunction != null)
+ {
+ var labelResult:Object = this._labelFunction(item);
+ if(labelResult is String)
+ {
+ return labelResult as String;
+ }
+ return labelResult.toString();
+ }
+ else if(this._labelField != null && item && item.hasOwnProperty(this._labelField))
+ {
+ labelResult = item[this._labelField];
+ if(labelResult is String)
+ {
+ return labelResult as String;
+ }
+ return labelResult.toString();
+ }
+ else if(item is String)
+ {
+ return item as String;
+ }
+ else if(item !== null)
+ {
+ //we need to use strict equality here because the data can be
+ //non-strictly equal to null
+ return item.toString();
+ }
+ return "";
+ }
+
+ /**
+ * Uses the icon fields and functions to generate an icon for a specific
+ * item.
+ *
+ * All of the icon fields and functions, ordered by priority:
+ *
+ * iconSourceFunctioniconSourceFieldiconLabelFunctioniconLabelFieldiconFunctioniconField
+ */
+ protected function itemToIcon(item:Object):DisplayObject
+ {
+ if(this._iconSourceFunction != null)
+ {
+ var source:Object = this._iconSourceFunction(item);
+ this.refreshIconSource(source);
+ return this.iconLoader;
+ }
+ else if(this._iconSourceField != null && item && item.hasOwnProperty(this._iconSourceField))
+ {
+ source = item[this._iconSourceField];
+ this.refreshIconSource(source);
+ return this.iconLoader;
+ }
+ else if(this._iconLabelFunction != null)
+ {
+ var labelResult:Object = this._iconLabelFunction(item);
+ if(labelResult is String)
+ {
+ this.refreshIconLabel(labelResult as String);
+ }
+ else
+ {
+ this.refreshIconLabel(labelResult.toString());
+ }
+ return DisplayObject(this.iconLabel);
+ }
+ else if(this._iconLabelField != null && item && item.hasOwnProperty(this._iconLabelField))
+ {
+ labelResult = item[this._iconLabelField];
+ if(labelResult is String)
+ {
+ this.refreshIconLabel(labelResult as String);
+ }
+ else
+ {
+ this.refreshIconLabel(labelResult.toString());
+ }
+ return DisplayObject(this.iconLabel);
+ }
+ else if(this._iconFunction != null)
+ {
+ return this._iconFunction(item) as DisplayObject;
+ }
+ else if(this._iconField != null && item && item.hasOwnProperty(this._iconField))
+ {
+ return item[this._iconField] as DisplayObject;
+ }
+
+ return null;
+ }
+
+ /**
+ * Uses the accessory fields and functions to generate an accessory for
+ * a specific item.
+ *
+ * All of the accessory fields and functions, ordered by priority:
+ *
+ * accessorySourceFunctionaccessorySourceFieldaccessoryLabelFunctionaccessoryLabelFieldaccessoryFunctionaccessoryField
+ */
+ protected function itemToAccessory(item:Object):DisplayObject
+ {
+ if(this._accessorySourceFunction != null)
+ {
+ var source:Object = this._accessorySourceFunction(item);
+ this.refreshAccessorySource(source);
+ return this.accessoryLoader;
+ }
+ else if(this._accessorySourceField != null && item && item.hasOwnProperty(this._accessorySourceField))
+ {
+ source = item[this._accessorySourceField];
+ this.refreshAccessorySource(source);
+ return this.accessoryLoader;
+ }
+ else if(this._accessoryLabelFunction != null)
+ {
+ var labelResult:Object = this._accessoryLabelFunction(item);
+ if(labelResult is String)
+ {
+ this.refreshAccessoryLabel(labelResult as String);
+ }
+ else
+ {
+ this.refreshAccessoryLabel(labelResult.toString());
+ }
+ return DisplayObject(this.accessoryLabel);
+ }
+ else if(this._accessoryLabelField != null && item && item.hasOwnProperty(this._accessoryLabelField))
+ {
+ labelResult = item[this._accessoryLabelField];
+ if(labelResult is String)
+ {
+ this.refreshAccessoryLabel(labelResult as String);
+ }
+ else
+ {
+ this.refreshAccessoryLabel(labelResult.toString());
+ }
+ return DisplayObject(this.accessoryLabel);
+ }
+ else if(this._accessoryFunction != null)
+ {
+ return this._accessoryFunction(item) as DisplayObject;
+ }
+ else if(this._accessoryField != null && item && item.hasOwnProperty(this._accessoryField))
+ {
+ return item[this._accessoryField] as DisplayObject;
+ }
+
+ return null;
+ }
+
+ /**
+ * Uses the skin fields and functions to generate a skin for a specific
+ * item.
+ *
+ * All of the skin fields and functions, ordered by priority:
+ *
+ * skinSourceFunctionskinSourceFieldskinFunctionskinField
+ */
+ protected function itemToSkin(item:Object):DisplayObject
+ {
+ if(this._skinSourceFunction != null)
+ {
+ var source:Object = this._skinSourceFunction(item);
+ this.refreshSkinSource(source);
+ return this.skinLoader;
+ }
+ else if(this._skinSourceField != null && item && item.hasOwnProperty(this._skinSourceField))
+ {
+ source = item[this._skinSourceField];
+ this.refreshSkinSource(source);
+ return this.skinLoader;
+ }
+ else if(this._skinFunction != null)
+ {
+ return this._skinFunction(item) as DisplayObject;
+ }
+ else if(this._skinField != null && item && item.hasOwnProperty(this._skinField))
+ {
+ return item[this._skinField] as DisplayObject;
+ }
+
+ return null;
+ }
+
+ /**
+ * Uses the selectable fields and functions to generate a selectable
+ * value for a specific item.
+ *
+ * All of the selectable fields and functions, ordered by priority:
+ *
+ * selectableFunctionselectableField
+ */
+ protected function itemToSelectable(item:Object):Boolean
+ {
+ if(this._selectableFunction != null)
+ {
+ return this._selectableFunction(item) as Boolean;
+ }
+ else if(this._selectableField != null && item && item.hasOwnProperty(this._selectableField))
+ {
+ return item[this._selectableField] as Boolean;
+ }
+
+ return true;
+ }
+
+ /**
+ * Uses the enabled fields and functions to generate a enabled value for
+ * a specific item.
+ *
+ * All of the enabled fields and functions, ordered by priority:
+ *
+ * enabledFunctionenabledField
+ */
+ protected function itemToEnabled(item:Object):Boolean
+ {
+ if(this._enabledFunction != null)
+ {
+ return this._enabledFunction(item) as Boolean;
+ }
+ else if(this._enabledField != null && item && item.hasOwnProperty(this._enabledField))
+ {
+ return item[this._enabledField] as Boolean;
+ }
+
+ return true;
+ }
+
+ /**
+ * @private
+ */
+ override protected function draw():void
+ {
+ var stateInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_STATE);
+ var dataInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_DATA);
+ var stylesInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_STYLES);
+ if(dataInvalid)
+ {
+ this.commitData();
+ }
+ if(stateInvalid || dataInvalid || stylesInvalid)
+ {
+ this.refreshAccessory();
+ }
+ super.draw();
+ }
+
+ /**
+ * @inheritDoc
+ */
+ override protected function autoSizeIfNeeded():Boolean
+ {
+ var needsWidth:Boolean = this.explicitWidth !== this.explicitWidth; //isNaN
+ var needsHeight:Boolean = this.explicitHeight !== this.explicitHeight; //isNaN
+ if(!needsWidth && !needsHeight)
+ {
+ return false;
+ }
+ var oldIgnoreAccessoryResizes:Boolean = this._ignoreAccessoryResizes;
+ this._ignoreAccessoryResizes = true;
+ this.refreshMaxLabelWidth(true);
+ if(this.labelTextRenderer)
+ {
+ this.labelTextRenderer.measureText(HELPER_POINT);
+ }
+ else
+ {
+ HELPER_POINT.setTo(0, 0);
+ }
+ var newWidth:Number = this.explicitWidth;
+ if(needsWidth)
+ {
+ if(this._label)
+ {
+ newWidth = HELPER_POINT.x;
+ }
+ if(this._layoutOrder == LAYOUT_ORDER_LABEL_ACCESSORY_ICON)
+ {
+ newWidth = this.addAccessoryWidth(newWidth);
+ newWidth = this.addIconWidth(newWidth);
+ }
+ else
+ {
+ newWidth = this.addIconWidth(newWidth);
+ newWidth = this.addAccessoryWidth(newWidth);
+ }
+ newWidth += this._paddingLeft + this._paddingRight;
+ if(newWidth !== newWidth) //isNaN
+ {
+ newWidth = this._originalSkinWidth;
+ if(newWidth !== newWidth) //isNaN
+ {
+ newWidth = 0;
+ }
+ }
+ else if(this._originalSkinWidth === this._originalSkinWidth) //!isNaN
+ {
+ if(this._originalSkinWidth > newWidth)
+ {
+ newWidth = this._originalSkinWidth;
+ }
+ }
+ }
+
+ var newHeight:Number = this.explicitHeight;
+ if(needsHeight)
+ {
+ if(this._label)
+ {
+ newHeight = HELPER_POINT.y;
+ }
+ if(this._layoutOrder == LAYOUT_ORDER_LABEL_ACCESSORY_ICON)
+ {
+ newHeight = this.addAccessoryHeight(newHeight);
+ newHeight = this.addIconHeight(newHeight);
+ }
+ else
+ {
+ newHeight = this.addIconHeight(newHeight);
+ newHeight = this.addAccessoryHeight(newHeight);
+ }
+ newHeight += this._paddingTop + this._paddingBottom;
+ if(newHeight !== newHeight) //isNaN
+ {
+ newHeight = this._originalSkinHeight;
+ if(newHeight !== newHeight) //isNaN
+ {
+ newHeight = 0;
+ }
+ }
+ else if(this._originalSkinHeight === this._originalSkinHeight) //!isNaN
+ {
+ if(this._originalSkinHeight > newHeight)
+ {
+ newHeight = this._originalSkinHeight;
+ }
+ }
+ }
+ this._ignoreAccessoryResizes = oldIgnoreAccessoryResizes;
+
+ return this.setSizeInternal(newWidth, newHeight, false);
+ }
+
+ /**
+ * @private
+ */
+ protected function addIconWidth(width:Number):Number
+ {
+ if(!this.currentIcon)
+ {
+ return width;
+ }
+ var iconWidth:Number = this.currentIcon.width;
+ if(iconWidth !== iconWidth) //isNaN
+ {
+ return width;
+ }
+
+ var hasPreviousItem:Boolean = width === width; //!isNaN
+ if(!hasPreviousItem)
+ {
+ width = 0;
+ }
+
+ if(this._iconPosition == ICON_POSITION_LEFT || this._iconPosition == ICON_POSITION_LEFT_BASELINE || this._iconPosition == ICON_POSITION_RIGHT || this._iconPosition == ICON_POSITION_RIGHT_BASELINE)
+ {
+ if(hasPreviousItem)
+ {
+ var adjustedGap:Number = this._gap;
+ if(this._gap == Number.POSITIVE_INFINITY)
+ {
+ adjustedGap = this._minGap;
+ }
+ width += adjustedGap;
+ }
+ width += iconWidth;
+ }
+ else if(iconWidth > width)
+ {
+ width = iconWidth;
+ }
+ return width;
+ }
+
+ /**
+ * @private
+ */
+ protected function addAccessoryWidth(width:Number):Number
+ {
+ if(!this.accessory)
+ {
+ return width;
+ }
+ var accessoryWidth:Number = this.accessory.width;
+ if(accessoryWidth !== accessoryWidth) //isNaN
+ {
+ return width;
+ }
+
+ var hasPreviousItem:Boolean = width === width; //!isNaN;
+ if(!hasPreviousItem)
+ {
+ width = 0;
+ }
+
+ if(this._accessoryPosition == ACCESSORY_POSITION_LEFT || this._accessoryPosition == ACCESSORY_POSITION_RIGHT)
+ {
+ if(hasPreviousItem)
+ {
+ var adjustedAccessoryGap:Number = this._accessoryGap;
+ //for some reason, if we don't call a function right here,
+ //compiling with the flex 4.6 SDK will throw a VerifyError
+ //for a stack overflow.
+ //we could change the !== check back to isNaN() instead, but
+ //isNaN() can allocate an object, so we should call a different
+ //function without allocation.
+ this.doNothing();
+ if(adjustedAccessoryGap !== adjustedAccessoryGap) //isNaN
+ {
+ adjustedAccessoryGap = this._gap;
+ }
+ if(adjustedAccessoryGap == Number.POSITIVE_INFINITY)
+ {
+ if(this._minAccessoryGap !== this._minAccessoryGap) //isNaN
+ {
+ adjustedAccessoryGap = this._minGap;
+ }
+ else
+ {
+ adjustedAccessoryGap = this._minAccessoryGap;
+ }
+ }
+ width += adjustedAccessoryGap;
+ }
+ width += accessoryWidth;
+ }
+ else if(accessoryWidth > width)
+ {
+ width = accessoryWidth;
+ }
+ return width;
+ }
+
+
+ /**
+ * @private
+ */
+ protected function addIconHeight(height:Number):Number
+ {
+ if(!this.currentIcon)
+ {
+ return height;
+ }
+ var iconHeight:Number = this.currentIcon.height;
+ if(iconHeight !== iconHeight) //isNaN
+ {
+ return height;
+ }
+
+ var hasPreviousItem:Boolean = height === height; //!isNaN
+ if(!hasPreviousItem)
+ {
+ height = 0;
+ }
+
+ if(this._iconPosition == ICON_POSITION_TOP || this._iconPosition == ICON_POSITION_BOTTOM)
+ {
+ if(hasPreviousItem)
+ {
+ var adjustedGap:Number = this._gap;
+ if(this._gap == Number.POSITIVE_INFINITY)
+ {
+ adjustedGap = this._minGap;
+ }
+ height += adjustedGap;
+ }
+ height += iconHeight;
+ }
+ else if(iconHeight > height)
+ {
+ height = iconHeight;
+ }
+ return height;
+ }
+
+ /**
+ * @private
+ */
+ protected function addAccessoryHeight(height:Number):Number
+ {
+ if(!this.accessory)
+ {
+ return height;
+ }
+ var accessoryHeight:Number = this.accessory.height;
+ if(accessoryHeight !== accessoryHeight) //isNaN
+ {
+ return height;
+ }
+
+ var hasPreviousItem:Boolean = height === height; //!isNaN
+ if(!hasPreviousItem)
+ {
+ height = 0;
+ }
+
+ if(this._accessoryPosition == ACCESSORY_POSITION_TOP || this._accessoryPosition == ACCESSORY_POSITION_BOTTOM)
+ {
+ if(hasPreviousItem)
+ {
+ var adjustedAccessoryGap:Number = this._accessoryGap;
+ //for some reason, if we don't call a function right here,
+ //compiling with the flex 4.6 SDK will throw a VerifyError
+ //for a stack overflow.
+ //we could change the !== check back to isNaN() instead, but
+ //isNaN() can allocate an object, so we should call a different
+ //function without allocation.
+ this.doNothing();
+ if(adjustedAccessoryGap !== adjustedAccessoryGap) //isNaN
+ {
+ adjustedAccessoryGap = this._gap;
+ }
+ if(adjustedAccessoryGap == Number.POSITIVE_INFINITY)
+ {
+ if(this._minAccessoryGap != this._minAccessoryGap) //isNaN
+ {
+ adjustedAccessoryGap = this._minGap;
+ }
+ else
+ {
+ adjustedAccessoryGap = this._minAccessoryGap;
+ }
+ }
+ height += adjustedAccessoryGap;
+ }
+ height += accessoryHeight;
+ }
+ else if(accessoryHeight > height)
+ {
+ height = accessoryHeight;
+ }
+ return height;
+ }
+
+ /**
+ * @private
+ * This function is here to work around a bug in the Flex 4.6 SDK
+ * compiler. For explanation, see the places where it gets called.
+ */
+ protected function doNothing():void {}
+
+ /**
+ * Updates the renderer to display the item's data. Override this
+ * function to pass data to sub-components and react to data changes.
+ *
+ * Don't forget to handle the case where the data is null.
+ */
+ protected function commitData():void
+ {
+ //we need to use strict equality here because the data can be
+ //non-strictly equal to null
+ if(this._data !== null && this._owner)
+ {
+ if(this._itemHasLabel)
+ {
+ this._label = this.itemToLabel(this._data);
+ //we don't need to invalidate because the label setter
+ //uses the same data invalidation flag that triggered this
+ //call to commitData(), so we're already properly invalid.
+ }
+ if(this._itemHasSkin)
+ {
+ var newSkin:DisplayObject = this.itemToSkin(this._data);
+ this._skinIsFromItem = newSkin != null;
+ this.replaceSkin(newSkin);
+ }
+ else if(this._skinIsFromItem)
+ {
+ this._skinIsFromItem = false;
+ this.replaceSkin(null);
+ }
+ if(this._itemHasIcon)
+ {
+ var newIcon:DisplayObject = this.itemToIcon(this._data);
+ this._iconIsFromItem = newIcon != null;
+ this.replaceIcon(newIcon);
+ }
+ else if(this._iconIsFromItem)
+ {
+ this._iconIsFromItem = false;
+ this.replaceIcon(null);
+ }
+ if(this._itemHasAccessory)
+ {
+ var newAccessory:DisplayObject = this.itemToAccessory(this._data);
+ this._accessoryIsFromItem = newAccessory != null;
+ this.replaceAccessory(newAccessory);
+ }
+ else if(this._accessoryIsFromItem)
+ {
+ this._accessoryIsFromItem = false;
+ this.replaceAccessory(null);
+ }
+ if(this._itemHasSelectable)
+ {
+ this._isToggle = this._explicitIsToggle && this.itemToSelectable(this._data);
+ }
+ else
+ {
+ this._isToggle = this._explicitIsToggle;
+ }
+ if(this._itemHasEnabled)
+ {
+ this.refreshIsEnabled(this._explicitIsEnabled && this.itemToEnabled(this._data));
+ }
+ else
+ {
+ this.refreshIsEnabled(this._explicitIsEnabled);
+ }
+ }
+ else
+ {
+ if(this._itemHasLabel)
+ {
+ this._label = "";
+ }
+ if(this._itemHasIcon || this._iconIsFromItem)
+ {
+ this._iconIsFromItem = false;
+ this.replaceIcon(null);
+ }
+ if(this._itemHasSkin || this._skinIsFromItem)
+ {
+ this._skinIsFromItem = false;
+ this.replaceSkin(null);
+ }
+ if(this._itemHasAccessory || this._accessoryIsFromItem)
+ {
+ this._accessoryIsFromItem = false;
+ this.replaceAccessory(null);
+ }
+ if(this._itemHasSelectable)
+ {
+ this._isToggle = this._explicitIsToggle;
+ }
+ if(this._itemHasEnabled)
+ {
+ this.refreshIsEnabled(this._explicitIsEnabled);
+ }
+ }
+ }
+
+ /**
+ * @private
+ */
+ protected function refreshIsEnabled(value:Boolean):void
+ {
+ if(this._isEnabled == value)
+ {
+ return;
+ }
+ this._isEnabled = value;
+ if(!this._isEnabled)
+ {
+ this.touchable = false;
+ this._currentState = STATE_DISABLED;
+ this.touchPointID = -1;
+ }
+ else
+ {
+ //might be in another state for some reason
+ //let's only change to up if needed
+ if(this._currentState == STATE_DISABLED)
+ {
+ this._currentState = STATE_UP;
+ }
+ this.touchable = true;
+ }
+ this.setInvalidationFlag(INVALIDATION_FLAG_STATE);
+ }
+
+ /**
+ * @private
+ */
+ protected function replaceIcon(newIcon:DisplayObject):void
+ {
+ if(this.iconLoader && this.iconLoader != newIcon)
+ {
+ this.iconLoader.removeEventListener(Event.COMPLETE, loader_completeOrErrorHandler);
+ this.iconLoader.removeEventListener(FeathersEventType.ERROR, loader_completeOrErrorHandler);
+ this.iconLoader.dispose();
+ this.iconLoader = null;
+ }
+
+ if(this.iconLabel && this.iconLabel != newIcon)
+ {
+ //we can dispose this one, though, since we created it
+ this.iconLabel.dispose();
+ this.iconLabel = null;
+ }
+
+ if(this._itemHasIcon && this.currentIcon && this.currentIcon != newIcon && this.currentIcon.parent == this)
+ {
+ //the icon is created using the data provider, and it is not
+ //created inside this class, so it is not our responsibility to
+ //dispose the icon. if we dispose it, it may break something.
+ this.currentIcon.removeFromParent(false);
+ this.currentIcon = null;
+ }
+ //we're using currentIcon above, but we're emulating calling the
+ //defaultIcon setter here. the Button class sets the currentIcon
+ //elsewhere, so we want to take advantage of that exisiting code.
+
+ //we're not calling the defaultIcon setter directly because we're in
+ //the middle of validating, and it will just invalidate, which will
+ //require another validation later. we want the Button class to
+ //process the new icon immediately when we call super.draw().
+ if(this._iconSelector.defaultValue != newIcon)
+ {
+ this._iconSelector.defaultValue = newIcon;
+ //we don't want this taking precedence over our icon from the
+ //data provider.
+ this._stateToIconFunction = null;
+ //we don't need to do a full invalidation. the superclass will
+ //correctly see this flag when we call super.draw().
+ this.setInvalidationFlag(INVALIDATION_FLAG_STYLES);
+ }
+
+ if(this.iconLoader)
+ {
+ this.iconLoader.delayTextureCreation = this._delayTextureCreationOnScroll && this._owner.isScrolling;
+ }
+ }
+
+ /**
+ * @private
+ */
+ protected function replaceAccessory(newAccessory:DisplayObject):void
+ {
+ if(this.accessory == newAccessory)
+ {
+ return;
+ }
+
+ if(this.accessory)
+ {
+ this.accessory.removeEventListener(FeathersEventType.RESIZE, accessory_resizeHandler);
+ this.accessory.removeEventListener(TouchEvent.TOUCH, accessory_touchHandler);
+
+ if(this.accessory.parent == this)
+ {
+ //the accessory may have come from outside of this class. it's
+ //up to that code to dispose of the accessory. in fact, if we
+ //disposed of it here, we will probably screw something up, so
+ //let's just remove it.
+ this.accessory.removeFromParent(false);
+ }
+ }
+
+ if(this.accessoryLabel && this.accessoryLabel != newAccessory)
+ {
+ //we can dispose this one, though, since we created it
+ this.accessoryLabel.dispose();
+ this.accessoryLabel = null;
+ }
+
+ if(this.accessoryLoader && this.accessoryLoader != newAccessory)
+ {
+ this.accessoryLoader.removeEventListener(Event.COMPLETE, loader_completeOrErrorHandler);
+ this.accessoryLoader.removeEventListener(FeathersEventType.ERROR, loader_completeOrErrorHandler);
+
+ //same ability to dispose here
+ this.accessoryLoader.dispose();
+ this.accessoryLoader = null;
+ }
+
+ this.accessory = newAccessory;
+
+ if(this.accessory)
+ {
+ if(this.accessory is IFeathersControl)
+ {
+ if(!(this.accessory is BitmapFontTextRenderer))
+ {
+ this.accessory.addEventListener(TouchEvent.TOUCH, accessory_touchHandler);
+ }
+ this.accessory.addEventListener(FeathersEventType.RESIZE, accessory_resizeHandler);
+ }
+ this.addChild(this.accessory);
+ }
+
+ if(this.accessoryLoader)
+ {
+ this.accessoryLoader.delayTextureCreation = this._delayTextureCreationOnScroll && this._owner.isScrolling;
+ }
+ }
+
+ /**
+ * @private
+ */
+ protected function replaceSkin(newSkin:DisplayObject):void
+ {
+ if(this.skinLoader && this.skinLoader != newSkin)
+ {
+ this.skinLoader.removeEventListener(Event.COMPLETE, loader_completeOrErrorHandler);
+ this.skinLoader.removeEventListener(FeathersEventType.ERROR, loader_completeOrErrorHandler);
+ this.skinLoader.dispose();
+ this.skinLoader = null;
+ }
+
+ if(this._itemHasSkin && this.currentSkin && this.currentSkin != newSkin && this.currentSkin.parent == this)
+ {
+ //the icon is created using the data provider, and it is not
+ //created inside this class, so it is not our responsibility to
+ //dispose the icon. if we dispose it, it may break something.
+ this.currentSkin.removeFromParent(false);
+ this.currentSkin = null;
+ }
+ //we're using currentIcon above, but we're emulating calling the
+ //defaultIcon setter here. the Button class sets the currentIcon
+ //elsewhere, so we want to take advantage of that exisiting code.
+
+ //we're not calling the defaultSkin setter directly because we're in
+ //the middle of validating, and it will just invalidate, which will
+ //require another validation later. we want the Button class to
+ //process the new skin immediately when we call super.draw().
+ if(this._skinSelector.defaultValue != newSkin)
+ {
+ this._skinSelector.defaultValue = newSkin;
+ //we don't want this taking precedence over our skin from the
+ //data provider.
+ this._stateToSkinFunction = null;
+ //we don't need to do a full invalidation. the superclass will
+ //correctly see this flag when we call super.draw().
+ this.setInvalidationFlag(INVALIDATION_FLAG_STYLES);
+ }
+
+ if(this.skinLoader)
+ {
+ this.skinLoader.delayTextureCreation = this._delayTextureCreationOnScroll && this._owner.isScrolling;
+ }
+ }
+
+ /**
+ * @private
+ */
+ override protected function refreshIcon():void
+ {
+ super.refreshIcon();
+ if(this.iconLabel)
+ {
+ var displayIconLabel:DisplayObject = DisplayObject(this.iconLabel);
+ for(var propertyName:String in this._iconLabelProperties)
+ {
+ var propertyValue:Object = this._iconLabelProperties[propertyName];
+ displayIconLabel[propertyName] = propertyValue;
+ }
+ }
+ }
+
+ /**
+ * @private
+ */
+ protected function refreshAccessory():void
+ {
+ if(this.accessory is IFeathersControl)
+ {
+ IFeathersControl(this.accessory).isEnabled = this._isEnabled;
+ }
+ if(this.accessoryLabel)
+ {
+ var displayAccessoryLabel:DisplayObject = DisplayObject(this.accessoryLabel);
+ for(var propertyName:String in this._accessoryLabelProperties)
+ {
+ var propertyValue:Object = this._accessoryLabelProperties[propertyName];
+ displayAccessoryLabel[propertyName] = propertyValue;
+ }
+ }
+ }
+
+ /**
+ * @private
+ */
+ protected function refreshIconSource(source:Object):void
+ {
+ if(!this.iconLoader)
+ {
+ this.iconLoader = this._iconLoaderFactory();
+ this.iconLoader.addEventListener(Event.COMPLETE, loader_completeOrErrorHandler);
+ this.iconLoader.addEventListener(FeathersEventType.ERROR, loader_completeOrErrorHandler);
+ }
+ this.iconLoader.source = source;
+ }
+
+ /**
+ * @private
+ */
+ protected function refreshIconLabel(label:String):void
+ {
+ if(!this.iconLabel)
+ {
+ var factory:Function = this._iconLabelFactory != null ? this._iconLabelFactory : FeathersControl.defaultTextRendererFactory;
+ this.iconLabel = ITextRenderer(factory());
+ this.iconLabel.styleNameList.add(this.iconLabelStyleName);
+ }
+ this.iconLabel.text = label;
+ }
+
+ /**
+ * @private
+ */
+ protected function refreshAccessorySource(source:Object):void
+ {
+ if(!this.accessoryLoader)
+ {
+ this.accessoryLoader = this._accessoryLoaderFactory();
+ this.accessoryLoader.addEventListener(Event.COMPLETE, loader_completeOrErrorHandler);
+ this.accessoryLoader.addEventListener(FeathersEventType.ERROR, loader_completeOrErrorHandler);
+ }
+ this.accessoryLoader.source = source;
+ }
+
+ /**
+ * @private
+ */
+ protected function refreshAccessoryLabel(label:String):void
+ {
+ if(!this.accessoryLabel)
+ {
+ var factory:Function = this._accessoryLabelFactory != null ? this._accessoryLabelFactory : FeathersControl.defaultTextRendererFactory;
+ this.accessoryLabel = ITextRenderer(factory());
+ this.accessoryLabel.styleNameList.add(this.accessoryLabelStyleName);
+ }
+ this.accessoryLabel.text = label;
+ }
+
+ /**
+ * @private
+ */
+ protected function refreshSkinSource(source:Object):void
+ {
+ if(!this.skinLoader)
+ {
+ this.skinLoader = this._skinLoaderFactory();
+ this.skinLoader.addEventListener(Event.COMPLETE, loader_completeOrErrorHandler);
+ this.skinLoader.addEventListener(FeathersEventType.ERROR, loader_completeOrErrorHandler);
+ }
+ this.skinLoader.source = source;
+ }
+
+ /**
+ * @private
+ */
+ override protected function layoutContent():void
+ {
+ var oldIgnoreAccessoryResizes:Boolean = this._ignoreAccessoryResizes;
+ this._ignoreAccessoryResizes = true;
+ this.refreshMaxLabelWidth(false);
+ if(this._label && this.labelTextRenderer)
+ {
+ this.labelTextRenderer.validate();
+ var labelRenderer:DisplayObject = DisplayObject(this.labelTextRenderer);
+ }
+ var iconIsInLayout:Boolean = this.currentIcon && this._iconPosition != ICON_POSITION_MANUAL;
+ var accessoryIsInLayout:Boolean = this.accessory && this._accessoryPosition != ACCESSORY_POSITION_MANUAL;
+ var accessoryGap:Number = this._accessoryGap;
+ if(accessoryGap !== accessoryGap) //isNaN
+ {
+ accessoryGap = this._gap;
+ }
+ if(this._label && this.labelTextRenderer && iconIsInLayout && accessoryIsInLayout)
+ {
+ this.positionSingleChild(labelRenderer);
+ if(this._layoutOrder == LAYOUT_ORDER_LABEL_ACCESSORY_ICON)
+ {
+ this.positionRelativeToOthers(this.accessory, labelRenderer, null, this._accessoryPosition, accessoryGap, null, 0);
+ var iconPosition:String = this._iconPosition;
+ if(iconPosition == ICON_POSITION_LEFT_BASELINE)
+ {
+ iconPosition = ICON_POSITION_LEFT;
+ }
+ else if(iconPosition == ICON_POSITION_RIGHT_BASELINE)
+ {
+ iconPosition = ICON_POSITION_RIGHT;
+ }
+ this.positionRelativeToOthers(this.currentIcon, labelRenderer, this.accessory, iconPosition, this._gap, this._accessoryPosition, accessoryGap);
+ }
+ else
+ {
+ this.positionLabelAndIcon();
+ this.positionRelativeToOthers(this.accessory, labelRenderer, this.currentIcon, this._accessoryPosition, accessoryGap, this._iconPosition, this._gap);
+ }
+ }
+ else if(this._label && this.labelTextRenderer)
+ {
+ this.positionSingleChild(labelRenderer);
+ //we won't position both the icon and accessory here, otherwise
+ //we would have gone into the previous conditional
+ if(iconIsInLayout)
+ {
+ this.positionLabelAndIcon();
+ }
+ else if(accessoryIsInLayout)
+ {
+ this.positionRelativeToOthers(this.accessory, labelRenderer, null, this._accessoryPosition, accessoryGap, null, 0);
+ }
+ }
+ else if(iconIsInLayout)
+ {
+ this.positionSingleChild(this.currentIcon);
+ if(accessoryIsInLayout)
+ {
+ this.positionRelativeToOthers(this.accessory, this.currentIcon, null, this._accessoryPosition, accessoryGap, null, 0);
+ }
+ }
+ else if(accessoryIsInLayout)
+ {
+ this.positionSingleChild(this.accessory);
+ }
+
+ if(this.accessory)
+ {
+ if(!accessoryIsInLayout)
+ {
+ this.accessory.x = this._paddingLeft;
+ this.accessory.y = this._paddingTop;
+ }
+ this.accessory.x += this._accessoryOffsetX;
+ this.accessory.y += this._accessoryOffsetY;
+ }
+ if(this.currentIcon)
+ {
+ if(!iconIsInLayout)
+ {
+ this.currentIcon.x = this._paddingLeft;
+ this.currentIcon.y = this._paddingTop;
+ }
+ this.currentIcon.x += this._iconOffsetX;
+ this.currentIcon.y += this._iconOffsetY;
+ }
+ if(this._label && this.labelTextRenderer)
+ {
+ this.labelTextRenderer.x += this._labelOffsetX;
+ this.labelTextRenderer.y += this._labelOffsetY;
+ }
+ this._ignoreAccessoryResizes = oldIgnoreAccessoryResizes;
+ }
+
+ /**
+ * @private
+ */
+ override protected function refreshMaxLabelWidth(forMeasurement:Boolean):void
+ {
+ var calculatedWidth:Number = this.actualWidth;
+ if(forMeasurement)
+ {
+ calculatedWidth = this.explicitWidth;
+ if(calculatedWidth !== calculatedWidth) //isNaN
+ {
+ calculatedWidth = this._maxWidth;
+ }
+ }
+ calculatedWidth -= (this._paddingLeft + this._paddingRight);
+
+ var adjustedGap:Number = this._gap;
+ if(adjustedGap == Number.POSITIVE_INFINITY)
+ {
+ adjustedGap = this._minGap;
+ }
+ var adjustedAccessoryGap:Number = this._accessoryGap;
+ if(adjustedAccessoryGap !== adjustedAccessoryGap) //isNaN
+ {
+ adjustedAccessoryGap = this._gap;
+ }
+ if(adjustedAccessoryGap == Number.POSITIVE_INFINITY)
+ {
+ adjustedAccessoryGap = this._minAccessoryGap;
+ if(adjustedAccessoryGap !== adjustedAccessoryGap) //isNaN
+ {
+ adjustedAccessoryGap = this._minGap;
+ }
+ }
+
+ var hasIconToLeftOrRight:Boolean = this.currentIcon && (this._iconPosition == ICON_POSITION_LEFT || this._iconPosition == ICON_POSITION_LEFT_BASELINE ||
+ this._iconPosition == ICON_POSITION_RIGHT || this._iconPosition == ICON_POSITION_RIGHT_BASELINE);
+ var hasAccessoryToLeftOrRight:Boolean = this.accessory && (this._accessoryPosition == ACCESSORY_POSITION_LEFT || this._accessoryPosition == ACCESSORY_POSITION_RIGHT);
+
+ if(this.accessoryLabel)
+ {
+ var iconAffectsAccessoryLabelMaxWidth:Boolean = hasIconToLeftOrRight && (hasAccessoryToLeftOrRight || this._layoutOrder == LAYOUT_ORDER_LABEL_ACCESSORY_ICON);
+ if(this.iconLabel)
+ {
+ this.iconLabel.maxWidth = calculatedWidth - adjustedGap;
+ if(this.iconLabel.maxWidth < 0)
+ {
+ this.iconLabel.maxWidth = 0;
+ }
+ }
+ if(this.currentIcon is IValidating)
+ {
+ IValidating(this.currentIcon).validate();
+ }
+ if(iconAffectsAccessoryLabelMaxWidth)
+ {
+ calculatedWidth -= (this.currentIcon.width + adjustedGap);
+ }
+ if(hasAccessoryToLeftOrRight)
+ {
+ calculatedWidth -= adjustedAccessoryGap;
+ }
+ if(calculatedWidth < 0)
+ {
+ calculatedWidth = 0;
+ }
+ this.accessoryLabel.maxWidth = calculatedWidth;
+ if(this.currentIcon && !iconAffectsAccessoryLabelMaxWidth)
+ {
+ calculatedWidth -= (this.currentIcon.width + adjustedGap);
+ }
+ if(this.accessory is IValidating)
+ {
+ IValidating(this.accessory).validate();
+ }
+ if(hasAccessoryToLeftOrRight)
+ {
+ calculatedWidth -= this.accessory.width;
+ }
+ }
+ else if(this.iconLabel)
+ {
+ var accessoryAffectsIconLabelMaxWidth:Boolean = hasAccessoryToLeftOrRight && (hasIconToLeftOrRight || this._layoutOrder == LAYOUT_ORDER_LABEL_ICON_ACCESSORY);
+ if(this.accessory is IValidating)
+ {
+ IValidating(this.accessory).validate();
+ }
+ if(accessoryAffectsIconLabelMaxWidth)
+ {
+ calculatedWidth -= (adjustedAccessoryGap + this.accessory.width);
+ }
+ if(hasIconToLeftOrRight)
+ {
+ calculatedWidth -= adjustedGap;
+ }
+ if(calculatedWidth < 0)
+ {
+ calculatedWidth = 0;
+ }
+ this.iconLabel.maxWidth = calculatedWidth;
+ if(this.accessory && !accessoryAffectsIconLabelMaxWidth)
+ {
+ calculatedWidth -= (adjustedAccessoryGap + this.accessory.width);
+ }
+ if(this.currentIcon is IValidating)
+ {
+ IValidating(this.currentIcon).validate();
+ }
+ if(hasIconToLeftOrRight)
+ {
+ calculatedWidth -= this.currentIcon.width;
+ }
+ }
+ else
+ {
+ if(this.currentIcon is IValidating)
+ {
+ IValidating(this.currentIcon).validate();
+ }
+ if(hasIconToLeftOrRight)
+ {
+ calculatedWidth -= (adjustedGap + this.currentIcon.width);
+ }
+ if(this.accessory is IValidating)
+ {
+ IValidating(this.accessory).validate();
+ }
+ if(hasAccessoryToLeftOrRight)
+ {
+ calculatedWidth -= (adjustedAccessoryGap + this.accessory.width);
+ }
+ }
+ if(calculatedWidth < 0)
+ {
+ calculatedWidth = 0;
+ }
+ if(this.labelTextRenderer)
+ {
+ this.labelTextRenderer.maxWidth = calculatedWidth;
+ }
+ }
+
+ /**
+ * @private
+ */
+ protected function positionRelativeToOthers(object:DisplayObject, relativeTo:DisplayObject, relativeTo2:DisplayObject, position:String, gap:Number, otherPosition:String, otherGap:Number):void
+ {
+ var relativeToX:Number = relativeTo2 ? Math.min(relativeTo.x, relativeTo2.x) : relativeTo.x;
+ var relativeToY:Number = relativeTo2 ? Math.min(relativeTo.y, relativeTo2.y) : relativeTo.y;
+ var relativeToWidth:Number = relativeTo2 ? (Math.max(relativeTo.x + relativeTo.width, relativeTo2.x + relativeTo2.width) - relativeToX) : relativeTo.width;
+ var relativeToHeight:Number = relativeTo2 ? (Math.max(relativeTo.y + relativeTo.height, relativeTo2.y + relativeTo2.height) - relativeToY) : relativeTo.height;
+ var newRelativeToX:Number = relativeToX;
+ var newRelativeToY:Number = relativeToY;
+ if(position == ACCESSORY_POSITION_TOP)
+ {
+ if(gap == Number.POSITIVE_INFINITY)
+ {
+ object.y = this._paddingTop;
+ newRelativeToY = this.actualHeight - this._paddingBottom - relativeToHeight;
+ }
+ else
+ {
+ if(this._verticalAlign == VERTICAL_ALIGN_TOP)
+ {
+ newRelativeToY += object.height + gap;
+ }
+ else if(this._verticalAlign == VERTICAL_ALIGN_MIDDLE)
+ {
+ newRelativeToY += Math.round((object.height + gap) / 2);
+ }
+ if(relativeTo2)
+ {
+ newRelativeToY = Math.max(newRelativeToY, this._paddingTop + object.height + gap);
+ }
+ object.y = newRelativeToY - object.height - gap;
+ }
+ }
+ else if(position == ACCESSORY_POSITION_RIGHT)
+ {
+ if(gap == Number.POSITIVE_INFINITY)
+ {
+ newRelativeToX = this._paddingLeft;
+ object.x = this.actualWidth - this._paddingRight - object.width;
+ }
+ else
+ {
+ if(this._horizontalAlign == HORIZONTAL_ALIGN_RIGHT)
+ {
+ newRelativeToX -= (object.width + gap);
+ }
+ else if(this._horizontalAlign == HORIZONTAL_ALIGN_CENTER)
+ {
+ newRelativeToX -= Math.round((object.width + gap) / 2);
+ }
+ if(relativeTo2)
+ {
+ newRelativeToX = Math.min(newRelativeToX, this.actualWidth - this._paddingRight - object.width - relativeToWidth - gap);
+ }
+ object.x = newRelativeToX + relativeToWidth + gap;
+ }
+ }
+ else if(position == ACCESSORY_POSITION_BOTTOM)
+ {
+ if(gap == Number.POSITIVE_INFINITY)
+ {
+ newRelativeToY = this._paddingTop;
+ object.y = this.actualHeight - this._paddingBottom - object.height;
+ }
+ else
+ {
+ if(this._verticalAlign == VERTICAL_ALIGN_BOTTOM)
+ {
+ newRelativeToY -= (object.height + gap);
+ }
+ else if(this._verticalAlign == VERTICAL_ALIGN_MIDDLE)
+ {
+ newRelativeToY -= Math.round((object.height + gap) / 2);
+ }
+ if(relativeTo2)
+ {
+ newRelativeToY = Math.min(newRelativeToY, this.actualHeight - this._paddingBottom - object.height - relativeToHeight - gap);
+ }
+ object.y = newRelativeToY + relativeToHeight + gap;
+ }
+ }
+ else if(position == ACCESSORY_POSITION_LEFT)
+ {
+ if(gap == Number.POSITIVE_INFINITY)
+ {
+ object.x = this._paddingLeft;
+ newRelativeToX = this.actualWidth - this._paddingRight - relativeToWidth;
+ }
+ else
+ {
+ if(this._horizontalAlign == HORIZONTAL_ALIGN_LEFT)
+ {
+ newRelativeToX += gap + object.width;
+ }
+ else if(this._horizontalAlign == HORIZONTAL_ALIGN_CENTER)
+ {
+ newRelativeToX += Math.round((gap + object.width) / 2);
+ }
+ if(relativeTo2)
+ {
+ newRelativeToX = Math.max(newRelativeToX, this._paddingLeft + object.width + gap);
+ }
+ object.x = newRelativeToX - gap - object.width;
+ }
+ }
+
+ var offsetX:Number = newRelativeToX - relativeToX;
+ var offsetY:Number = newRelativeToY - relativeToY;
+ if(!relativeTo2 || otherGap != Number.POSITIVE_INFINITY || !(
+ (position == ACCESSORY_POSITION_TOP && otherPosition == ACCESSORY_POSITION_TOP) ||
+ (position == ACCESSORY_POSITION_RIGHT && otherPosition == ACCESSORY_POSITION_RIGHT) ||
+ (position == ACCESSORY_POSITION_BOTTOM && otherPosition == ACCESSORY_POSITION_BOTTOM) ||
+ (position == ACCESSORY_POSITION_LEFT && otherPosition == ACCESSORY_POSITION_LEFT)
+ ))
+ {
+ relativeTo.x += offsetX;
+ relativeTo.y += offsetY;
+ }
+ if(relativeTo2)
+ {
+ if(otherGap != Number.POSITIVE_INFINITY || !(
+ (position == ACCESSORY_POSITION_LEFT && otherPosition == ACCESSORY_POSITION_RIGHT) ||
+ (position == ACCESSORY_POSITION_RIGHT && otherPosition == ACCESSORY_POSITION_LEFT) ||
+ (position == ACCESSORY_POSITION_TOP && otherPosition == ACCESSORY_POSITION_BOTTOM) ||
+ (position == ACCESSORY_POSITION_BOTTOM && otherPosition == ACCESSORY_POSITION_TOP)
+ ))
+ {
+ relativeTo2.x += offsetX;
+ relativeTo2.y += offsetY;
+ }
+ if(gap == Number.POSITIVE_INFINITY && otherGap == Number.POSITIVE_INFINITY)
+ {
+ if(position == ACCESSORY_POSITION_RIGHT && otherPosition == ACCESSORY_POSITION_LEFT)
+ {
+ relativeTo.x = relativeTo2.x + Math.round((object.x - relativeTo2.x + relativeTo2.width - relativeTo.width) / 2);
+ }
+ else if(position == ACCESSORY_POSITION_LEFT && otherPosition == ACCESSORY_POSITION_RIGHT)
+ {
+ relativeTo.x = object.x + Math.round((relativeTo2.x - object.x + object.width - relativeTo.width) / 2);
+ }
+ else if(position == ACCESSORY_POSITION_RIGHT && otherPosition == ACCESSORY_POSITION_RIGHT)
+ {
+ relativeTo2.x = relativeTo.x + Math.round((object.x - relativeTo.x + relativeTo.width - relativeTo2.width) / 2);
+ }
+ else if(position == ACCESSORY_POSITION_LEFT && otherPosition == ACCESSORY_POSITION_LEFT)
+ {
+ relativeTo2.x = object.x + Math.round((relativeTo.x - object.x + object.width - relativeTo2.width) / 2);
+ }
+ else if(position == ACCESSORY_POSITION_BOTTOM && otherPosition == ACCESSORY_POSITION_TOP)
+ {
+ relativeTo.y = relativeTo2.y + Math.round((object.y - relativeTo2.y + relativeTo2.height - relativeTo.height) / 2);
+ }
+ else if(position == ACCESSORY_POSITION_TOP && otherPosition == ACCESSORY_POSITION_BOTTOM)
+ {
+ relativeTo.y = object.y + Math.round((relativeTo2.y - object.y + object.height - relativeTo.height) / 2);
+ }
+ else if(position == ACCESSORY_POSITION_BOTTOM && otherPosition == ACCESSORY_POSITION_BOTTOM)
+ {
+ relativeTo2.y = relativeTo.y + Math.round((object.y - relativeTo.y + relativeTo.height - relativeTo2.height) / 2);
+ }
+ else if(position == ACCESSORY_POSITION_TOP && otherPosition == ACCESSORY_POSITION_TOP)
+ {
+ relativeTo2.y = object.y + Math.round((relativeTo.y - object.y + object.height - relativeTo2.height) / 2);
+ }
+ }
+ }
+
+ if(position == ACCESSORY_POSITION_LEFT || position == ACCESSORY_POSITION_RIGHT)
+ {
+ if(this._verticalAlign == VERTICAL_ALIGN_TOP)
+ {
+ object.y = this._paddingTop;
+ }
+ else if(this._verticalAlign == VERTICAL_ALIGN_BOTTOM)
+ {
+ object.y = this.actualHeight - this._paddingBottom - object.height;
+ }
+ else //middle
+ {
+ object.y = this._paddingTop + Math.round((this.actualHeight - this._paddingTop - this._paddingBottom - object.height) / 2);
+ }
+ }
+ else if(position == ACCESSORY_POSITION_TOP || position == ACCESSORY_POSITION_BOTTOM)
+ {
+ if(this._horizontalAlign == HORIZONTAL_ALIGN_LEFT)
+ {
+ object.x = this._paddingLeft;
+ }
+ else if(this._horizontalAlign == HORIZONTAL_ALIGN_RIGHT)
+ {
+ object.x = this.actualWidth - this._paddingRight - object.width;
+ }
+ else //center
+ {
+ object.x = this._paddingLeft + Math.round((this.actualWidth - this._paddingLeft - this._paddingRight - object.width) / 2);
+ }
+ }
+ }
+
+ /**
+ * @private
+ */
+ protected function owner_scrollStartHandler(event:Event):void
+ {
+ if(this._delayTextureCreationOnScroll)
+ {
+ if(this.accessoryLoader)
+ {
+ this.accessoryLoader.delayTextureCreation = true;
+ }
+ if(this.iconLoader)
+ {
+ this.iconLoader.delayTextureCreation = true;
+ }
+ }
+
+ if(this.touchPointID < 0 && this.accessoryTouchPointID < 0)
+ {
+ return;
+ }
+ this.resetTouchState();
+ if(this._stateDelayTimer && this._stateDelayTimer.running)
+ {
+ this._stateDelayTimer.stop();
+ }
+ this._delayedCurrentState = null;
+
+ if(this.accessoryTouchPointID >= 0)
+ {
+ this._owner.stopScrolling();
+ }
+ }
+
+ /**
+ * @private
+ */
+ protected function owner_scrollCompleteHandler(event:Event):void
+ {
+ if(this._delayTextureCreationOnScroll)
+ {
+ if(this.accessoryLoader)
+ {
+ this.accessoryLoader.delayTextureCreation = false;
+ }
+ if(this.iconLoader)
+ {
+ this.iconLoader.delayTextureCreation = false;
+ }
+ }
+ }
+
+ /**
+ * @private
+ */
+ override protected function button_removedFromStageHandler(event:Event):void
+ {
+ super.button_removedFromStageHandler(event);
+ this.accessoryTouchPointID = -1;
+ }
+
+ /**
+ * @private
+ */
+ protected function itemRenderer_triggeredHandler(event:Event):void
+ {
+ if(this._isToggle || !this.isSelectableWithoutToggle || (this._itemHasSelectable && !this.itemToSelectable(this._data)))
+ {
+ return;
+ }
+ this.isSelected = true;
+ }
+
+ /**
+ * @private
+ */
+ protected function stateDelayTimer_timerCompleteHandler(event:TimerEvent):void
+ {
+ super.currentState = this._delayedCurrentState;
+ this._delayedCurrentState = null;
+ }
+
+ /**
+ * @private
+ */
+ override protected function button_touchHandler(event:TouchEvent):void
+ {
+ if(this.accessory && !this._isSelectableOnAccessoryTouch && this.accessory != this.accessoryLabel && this.accessory != this.accessoryLoader && this.touchPointID < 0)
+ {
+ //ignore all touches on accessories that are not labels or
+ //loaders. return to up state.
+ var touch:Touch = event.getTouch(this.accessory);
+ if(touch)
+ {
+ this.currentState = Button.STATE_UP;
+ return;
+ }
+ }
+ super.button_touchHandler(event);
+ }
+
+ /**
+ * @private
+ */
+ protected function accessory_touchHandler(event:TouchEvent):void
+ {
+ if(!this._isEnabled)
+ {
+ this.accessoryTouchPointID = -1;
+ return;
+ }
+ if(!this._stopScrollingOnAccessoryTouch ||
+ this.accessory == this.accessoryLabel ||
+ this.accessory == this.accessoryLoader)
+ {
+ //do nothing
+ return;
+ }
+
+ if(this.accessoryTouchPointID >= 0)
+ {
+ var touch:Touch = event.getTouch(this.accessory, TouchPhase.ENDED, this.accessoryTouchPointID);
+ if(!touch)
+ {
+ return;
+ }
+ this.accessoryTouchPointID = -1;
+ }
+ else //if we get here, we don't have a saved touch ID yet
+ {
+ touch = event.getTouch(this.accessory, TouchPhase.BEGAN);
+ if(!touch)
+ {
+ return;
+ }
+ this.accessoryTouchPointID = touch.id;
+ }
+ }
+
+ /**
+ * @private
+ */
+ protected function accessory_resizeHandler(event:Event):void
+ {
+ if(this._ignoreAccessoryResizes)
+ {
+ return;
+ }
+ this.invalidate(INVALIDATION_FLAG_SIZE);
+ }
+
+ /**
+ * @private
+ */
+ protected function loader_completeOrErrorHandler(event:Event):void
+ {
+ this.invalidate(INVALIDATION_FLAG_SIZE);
+ }
+ }
+}
\ No newline at end of file
diff --git a/source/feathers/controls/renderers/DefaultGroupedListHeaderOrFooterRenderer.as b/source/feathers/controls/renderers/DefaultGroupedListHeaderOrFooterRenderer.as
new file mode 100644
index 0000000000..2970094bb8
--- /dev/null
+++ b/source/feathers/controls/renderers/DefaultGroupedListHeaderOrFooterRenderer.as
@@ -0,0 +1,1587 @@
+/*
+Feathers
+Copyright 2012-2014 Joshua Tynjala. All Rights Reserved.
+
+This program is free software. You can redistribute and/or modify it in
+accordance with the terms of the accompanying license agreement.
+*/
+package feathers.controls.renderers
+{
+ import feathers.controls.GroupedList;
+ import feathers.controls.ImageLoader;
+ import feathers.core.FeathersControl;
+ import feathers.core.IFeathersControl;
+ import feathers.core.ITextRenderer;
+ import feathers.core.IValidating;
+ import feathers.core.PropertyProxy;
+ import feathers.skins.IStyleProvider;
+
+ import starling.display.DisplayObject;
+
+ /**
+ * The default renderer used for headers and footers in a GroupedList
+ * control.
+ *
+ * @see feathers.controls.GroupedList
+ */
+ public class DefaultGroupedListHeaderOrFooterRenderer extends FeathersControl implements IGroupedListHeaderOrFooterRenderer
+ {
+ /**
+ * The content will be aligned horizontally to the left edge of the renderer.
+ *
+ * @see #horizontalAlign
+ */
+ public static const HORIZONTAL_ALIGN_LEFT:String = "left";
+
+ /**
+ * The content will be aligned horizontally to the center of the renderer.
+ *
+ * @see #horizontalAlign
+ */
+ public static const HORIZONTAL_ALIGN_CENTER:String = "center";
+
+ /**
+ * The content will be aligned horizontally to the right edge of the renderer.
+ *
+ * @see #horizontalAlign
+ */
+ public static const HORIZONTAL_ALIGN_RIGHT:String = "right";
+
+ /**
+ * The content will be justified horizontally, filling the entire width
+ * of the renderer, minus padding.
+ *
+ * @see #horizontalAlign
+ */
+ public static const HORIZONTAL_ALIGN_JUSTIFY:String = "justify";
+
+ /**
+ * The content will be aligned vertically to the top edge of the renderer.
+ *
+ * @see #verticalAlign
+ */
+ public static const VERTICAL_ALIGN_TOP:String = "top";
+
+ /**
+ * The content will be aligned vertically to the middle of the renderer.
+ *
+ * @see #verticalAlign
+ */
+ public static const VERTICAL_ALIGN_MIDDLE:String = "middle";
+
+ /**
+ * The content will be aligned vertically to the bottom edge of the renderer.
+ *
+ * @see #verticalAlign
+ */
+ public static const VERTICAL_ALIGN_BOTTOM:String = "bottom";
+
+ /**
+ * The content will be justified vertically, filling the entire height
+ * of the renderer, minus padding.
+ *
+ * @see #verticalAlign
+ */
+ public static const VERTICAL_ALIGN_JUSTIFY:String = "justify";
+
+ /**
+ * The default value added to the styleNameList of the
+ * content label.
+ *
+ * @see feathers.core.FeathersControl#styleNameList
+ */
+ public static const DEFAULT_CHILD_STYLE_NAME_CONTENT_LABEL:String = "feathers-header-footer-renderer-content-label";
+
+ /**
+ * DEPRECATED: Replaced by DefaultGroupedListHeaderOrFooterRenderer.DEFAULT_CHILD_STYLE_NAME_CONTENT_LABEL.
+ *
+ * DEPRECATION WARNING: This property is deprecated
+ * starting with Feathers 2.1. It will be removed in a future version of
+ * Feathers according to the standard
+ * Feathers deprecation policy.
+ *
+ * @see DefaultGroupedListHeaderOrFooterRenderer#DEFAULT_CHILD_STYLE_NAME_CONTENT_LABEL
+ */
+ public static const DEFAULT_CHILD_NAME_CONTENT_LABEL:String = DEFAULT_CHILD_STYLE_NAME_CONTENT_LABEL;
+
+ /**
+ * The default IStyleProvider for all DefaultGroupedListHeaderOrFooterRenderer
+ * components.
+ *
+ * @default null
+ * @see feathers.core.FeathersControl#styleProvider
+ */
+ public static var globalStyleProvider:IStyleProvider;
+
+ /**
+ * @private
+ */
+ protected static function defaultImageLoaderFactory():ImageLoader
+ {
+ return new ImageLoader();
+ }
+
+ /**
+ * Constructor.
+ */
+ public function DefaultGroupedListHeaderOrFooterRenderer()
+ {
+ super();
+ }
+
+ /**
+ * The value added to the styleNameList of the content
+ * label text renderer.
+ *
+ * @see feathers.core.FeathersControl#styleNameList
+ */
+ protected var contentLabelStyleName:String = DEFAULT_CHILD_STYLE_NAME_CONTENT_LABEL;
+
+ /**
+ * DEPRECATED: Replaced by contentLabelStyleName.
+ *
+ * DEPRECATION WARNING: This property is deprecated
+ * starting with Feathers 2.1. It will be removed in a future version of
+ * Feathers according to the standard
+ * Feathers deprecation policy.
+ *
+ * @see #contentLabelStyleName
+ */
+ protected function get contentLabelName():String
+ {
+ return this.contentLabelStyleName;
+ }
+
+ /**
+ * @private
+ */
+ protected function set contentLabelName(value:String):void
+ {
+ this.contentLabelStyleName = value;
+ }
+
+ /**
+ * @private
+ */
+ protected var contentImage:ImageLoader;
+
+ /**
+ * @private
+ */
+ protected var contentLabel:ITextRenderer;
+
+ /**
+ * @private
+ */
+ protected var content:DisplayObject;
+
+ /**
+ * @private
+ */
+ override protected function get defaultStyleProvider():IStyleProvider
+ {
+ return DefaultGroupedListHeaderOrFooterRenderer.globalStyleProvider;
+ }
+
+ /**
+ * @private
+ */
+ protected var _data:Object;
+
+ /**
+ * @inheritDoc
+ */
+ public function get data():Object
+ {
+ return this._data;
+ }
+
+ /**
+ * @private
+ */
+ public function set data(value:Object):void
+ {
+ if(this._data == value)
+ {
+ return;
+ }
+ this._data = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _groupIndex:int = -1;
+
+ /**
+ * @inheritDoc
+ */
+ public function get groupIndex():int
+ {
+ return this._groupIndex;
+ }
+
+ /**
+ * @private
+ */
+ public function set groupIndex(value:int):void
+ {
+ this._groupIndex = value;
+ }
+
+ /**
+ * @private
+ */
+ protected var _layoutIndex:int = -1;
+
+ /**
+ * @inheritDoc
+ */
+ public function get layoutIndex():int
+ {
+ return this._layoutIndex;
+ }
+
+ /**
+ * @private
+ */
+ public function set layoutIndex(value:int):void
+ {
+ this._layoutIndex = value;
+ }
+
+ /**
+ * @private
+ */
+ protected var _owner:GroupedList;
+
+ /**
+ * @inheritDoc
+ */
+ public function get owner():GroupedList
+ {
+ return this._owner;
+ }
+
+ /**
+ * @private
+ */
+ public function set owner(value:GroupedList):void
+ {
+ if(this._owner == value)
+ {
+ return;
+ }
+ this._owner = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _horizontalAlign:String = HORIZONTAL_ALIGN_LEFT;
+
+ [Inspectable(type="String",enumeration="left,center,right,justify")]
+ /**
+ * The location where the renderer's content is aligned horizontally
+ * (on the x-axis).
+ *
+ * In the following example, the horizontal alignment is changed to
+ * right:
+ *
+ *
+ * renderer.horizontalAlign = DefaultGroupedListHeaderOrFooterRenderer.HORIZONTAL_ALIGN_RIGHT;
+ *
+ * @default DefaultGroupedListHeaderOrFooterRenderer.HORIZONTAL_ALIGN_LEFT
+ *
+ * @see #HORIZONTAL_ALIGN_LEFT
+ * @see #HORIZONTAL_ALIGN_CENTER
+ * @see #HORIZONTAL_ALIGN_RIGHT
+ * @see #HORIZONTAL_ALIGN_JUSTIFY
+ */
+ public function get horizontalAlign():String
+ {
+ return this._horizontalAlign;
+ }
+
+ /**
+ * @private
+ */
+ public function set horizontalAlign(value:String):void
+ {
+ if(this._horizontalAlign == value)
+ {
+ return;
+ }
+ this._horizontalAlign = value;
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _verticalAlign:String = VERTICAL_ALIGN_MIDDLE;
+
+ [Inspectable(type="String",enumeration="top,middle,bottom,justify")]
+ /**
+ * The location where the renderer's content is aligned vertically (on
+ * the y-axis).
+ *
+ * In the following example, the vertical alignment is changed to
+ * bottom:
+ *
+ *
+ * renderer.verticalAlign = DefaultGroupedListHeaderOrFooterRenderer.HORIZONTAL_ALIGN_BOTTOM;
+ *
+ * @default DefaultGroupedListHeaderOrFooterRenderer.VERTICAL_ALIGN_MIDDLE
+ *
+ * @see #VERTICAL_ALIGN_TOP
+ * @see #VERTICAL_ALIGN_MIDDLE
+ * @see #VERTICAL_ALIGN_BOTTOM
+ * @see #VERTICAL_ALIGN_JUSTIFY
+ */
+ public function get verticalAlign():String
+ {
+ return _verticalAlign;
+ }
+
+ /**
+ * @private
+ */
+ public function set verticalAlign(value:String):void
+ {
+ if(this._verticalAlign == value)
+ {
+ return;
+ }
+ this._verticalAlign = value;
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _contentField:String = "content";
+
+ /**
+ * The field in the item that contains a display object to be positioned
+ * in the content position of the renderer. If you wish to display a
+ * texture in the content position, it's better for performance to use
+ * contentSourceField instead.
+ *
+ * All of the content fields and functions, ordered by priority:
+ *
+ * contentSourceFunctioncontentSourceFieldcontentLabelFunctioncontentLabelFieldcontentFunctioncontentField
+ *
+ * In the following example, the content field is customized:
+ *
+ *
+ * renderer.contentField = "header";
+ *
+ * @default "content"
+ *
+ * @see #contentSourceField
+ * @see #contentFunction
+ * @see #contentSourceFunction
+ * @see #contentLabelField
+ * @see #contentLabelFunction
+ */
+ public function get contentField():String
+ {
+ return this._contentField;
+ }
+
+ /**
+ * @private
+ */
+ public function set contentField(value:String):void
+ {
+ if(this._contentField == value)
+ {
+ return;
+ }
+ this._contentField = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _contentFunction:Function;
+
+ /**
+ * A function that returns a display object to be positioned in the
+ * content position of the renderer. If you wish to display a texture in
+ * the content position, it's better for performance to use
+ * contentSourceFunction instead.
+ *
+ * The function is expected to have the following signature:
+ * function( item:Object ):DisplayObject
+ *
+ * All of the content fields and functions, ordered by priority:
+ *
+ * contentSourceFunctioncontentSourceFieldcontentLabelFunctioncontentLabelFieldcontentFunctioncontentField
+ *
+ * In the following example, the content function is customized:
+ *
+ *
+ * renderer.contentFunction = function( item:Object ):DisplayObject
+ * {
+ * if(item in cachedContent)
+ * {
+ * return cachedContent[item];
+ * }
+ * var content:DisplayObject = createContentForHeader( item );
+ * cachedContent[item] = content;
+ * return content;
+ * };
+ *
+ * @default null
+ *
+ * @see #contentField
+ * @see #contentSourceField
+ * @see #contentSourceFunction
+ * @see #contentLabelField
+ * @see #contentLabelFunction
+ */
+ public function get contentFunction():Function
+ {
+ return this._contentFunction;
+ }
+
+ /**
+ * @private
+ */
+ public function set contentFunction(value:Function):void
+ {
+ if(this._contentFunction == value)
+ {
+ return;
+ }
+ this._contentFunction = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _contentSourceField:String = "source";
+
+ /**
+ * The field in the data that contains a starling.textures.Texture
+ * or a URL that points to a bitmap to be used as the renderer's
+ * content. The renderer will automatically manage and reuse an internal
+ * ImageLoader sub-component and this value will be passed
+ * to the source property. The ImageLoader may
+ * be customized by changing the contentLoaderFactory.
+ *
+ * Using an content source will result in better performance than
+ * passing in an ImageLoader or Image through
+ * contentField or contentFunction because the
+ * renderer can avoid costly display list manipulation.
+ *
+ * All of the content fields and functions, ordered by priority:
+ *
+ * contentSourceFunctioncontentSourceFieldcontentLabelFunctioncontentLabelFieldcontentFunctioncontentField
+ *
+ * In the following example, the content source field is customized:
+ *
+ *
+ * renderer.contentSourceField = "texture";
+ *
+ * @default "source"
+ *
+ * @see feathers.controls.ImageLoader#source
+ * @see #contentLoaderFactory
+ * @see #contentSourceFunction
+ * @see #contentField
+ * @see #contentFunction
+ * @see #contentLabelField
+ * @see #contentLabelFunction
+ */
+ public function get contentSourceField():String
+ {
+ return this._contentSourceField;
+ }
+
+ /**
+ * @private
+ */
+ public function set contentSourceField(value:String):void
+ {
+ if(this._contentSourceField == value)
+ {
+ return;
+ }
+ this._contentSourceField = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _contentSourceFunction:Function;
+
+ /**
+ * A function used to generate a starling.textures.Texture
+ * or a URL that points to a bitmap to be used as the renderer's
+ * content. The renderer will automatically manage and reuse an internal
+ * ImageLoader sub-component and this value will be passed
+ * to the source property. The ImageLoader may
+ * be customized by changing the contentLoaderFactory.
+ *
+ * Using an content source will result in better performance than
+ * passing in an ImageLoader or Image through
+ * contentField or contentFunction because the
+ * renderer can avoid costly display list manipulation.
+ *
+ * The function is expected to have the following signature:
+ * function( item:Object ):Object
+ *
+ * The return value is a valid value for the source
+ * property of an ImageLoader component.
+ *
+ * All of the content fields and functions, ordered by priority:
+ *
+ * contentSourceFunctioncontentSourceFieldcontentLabelFunctioncontentLabelFieldcontentFunctioncontentField
+ *
+ * In the following example, the content source function is customized:
+ *
+ *
+ * renderer.contentSourceFunction = function( item:Object ):Object
+ * {
+ * return "http://www.example.com/thumbs/" + item.name + "-thumb.png";
+ * };
+ *
+ * @default null
+ *
+ * @see feathers.controls.ImageLoader#source
+ * @see #contentLoaderFactory
+ * @see #contentSourceField
+ * @see #contentField
+ * @see #contentFunction
+ * @see #contentLabelField
+ * @see #contentLabelFunction
+ */
+ public function get contentSourceFunction():Function
+ {
+ return this._contentSourceFunction;
+ }
+
+ /**
+ * @private
+ */
+ public function set contentSourceFunction(value:Function):void
+ {
+ if(this.contentSourceFunction == value)
+ {
+ return;
+ }
+ this._contentSourceFunction = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _contentLabelField:String = "label";
+
+ /**
+ * The field in the item that contains a string to be displayed in a
+ * renderer-managed Label in the content position of the
+ * renderer. The renderer will automatically reuse an internal
+ * Label and swap the text when the data changes. This
+ * Label may be skinned by changing the
+ * contentLabelFactory.
+ *
+ * Using an content label will result in better performance than
+ * passing in a Label through a contentField
+ * or contentFunction because the renderer can avoid
+ * costly display list manipulation.
+ *
+ * All of the content fields and functions, ordered by priority:
+ *
+ * contentTextureFunctioncontentTextureFieldcontentLabelFunctioncontentLabelFieldcontentFunctioncontentField
+ *
+ * In the following example, the content label field is customized:
+ *
+ *
+ * renderer.contentLabelField = "text";
+ *
+ * @default "label"
+ *
+ * @see #contentLabelFactory
+ * @see #contentLabelFunction
+ * @see #contentField
+ * @see #contentFunction
+ * @see #contentSourceField
+ * @see #contentSourceFunction
+ */
+ public function get contentLabelField():String
+ {
+ return this._contentLabelField;
+ }
+
+ /**
+ * @private
+ */
+ public function set contentLabelField(value:String):void
+ {
+ if(this._contentLabelField == value)
+ {
+ return;
+ }
+ this._contentLabelField = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _contentLabelFunction:Function;
+
+ /**
+ * A function that returns a string to be displayed in a
+ * renderer-managed Label in the content position of the
+ * renderer. The renderer will automatically reuse an internal
+ * Label and swap the text when the data changes. This
+ * Label may be skinned by changing the
+ * contentLabelFactory.
+ *
+ * Using an content label will result in better performance than
+ * passing in a Label through a contentField
+ * or contentFunction because the renderer can avoid
+ * costly display list manipulation.
+ *
+ * The function is expected to have the following signature:
+ * function( item:Object ):String
+ *
+ * All of the content fields and functions, ordered by priority:
+ *
+ * contentTextureFunctioncontentTextureFieldcontentLabelFunctioncontentLabelFieldcontentFunctioncontentField
+ *
+ * In the following example, the content label function is customized:
+ *
+ *
+ * renderer.contentLabelFunction = function( item:Object ):String
+ * {
+ * return item.category + " > " + item.subCategory;
+ * };
+ *
+ * @default null
+ *
+ * @see #contentLabelFactory
+ * @see #contentLabelField
+ * @see #contentField
+ * @see #contentFunction
+ * @see #contentSourceField
+ * @see #contentSourceFunction
+ */
+ public function get contentLabelFunction():Function
+ {
+ return this._contentLabelFunction;
+ }
+
+ /**
+ * @private
+ */
+ public function set contentLabelFunction(value:Function):void
+ {
+ if(this._contentLabelFunction == value)
+ {
+ return;
+ }
+ this._contentLabelFunction = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _contentLoaderFactory:Function = defaultImageLoaderFactory;
+
+ /**
+ * A function that generates an ImageLoader that uses the result
+ * of contentSourceField or contentSourceFunction.
+ * Useful for transforming the ImageLoader in some way. For
+ * example, you might want to scale it for current screen density or
+ * apply pixel snapping.
+ *
+ * In the following example, a custom content loader factory is passed
+ * to the renderer:
+ *
+ *
+ * renderer.contentLoaderFactory = function():ImageLoader
+ * {
+ * var loader:ImageLoader = new ImageLoader();
+ * loader.snapToPixels = true;
+ * return loader;
+ * };
+ *
+ * @default function():ImageLoader { return new ImageLoader(); }
+ *
+ * @see feathers.controls.ImageLoader
+ * @see #contentSourceField
+ * @see #contentSourceFunction
+ */
+ public function get contentLoaderFactory():Function
+ {
+ return this._contentLoaderFactory;
+ }
+
+ /**
+ * @private
+ */
+ public function set contentLoaderFactory(value:Function):void
+ {
+ if(this._contentLoaderFactory == value)
+ {
+ return;
+ }
+ this._contentLoaderFactory = value;
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _contentLabelFactory:Function;
+
+ /**
+ * A function that generates an ITextRenderer that uses the result
+ * of contentLabelField or contentLabelFunction.
+ * Can be used to set properties on the ITextRenderer.
+ *
+ * In the following example, a custom content label factory is passed
+ * to the renderer:
+ *
+ *
+ * renderer.contentLabelFactory = function():ITextRenderer
+ * {
+ * var renderer:TextFieldTextRenderer = new TextFieldTextRenderer();
+ * renderer.textFormat = new TextFormat( "Source Sans Pro", 16, 0x333333 );
+ * renderer.embedFonts = true;
+ * return renderer;
+ * };
+ *
+ * @default null
+ *
+ * @see feathers.core.ITextRenderer
+ * @see feathers.core.FeathersControl#defaultTextRendererFactory
+ * @see #contentLabelField
+ * @see #contentLabelFunction
+ */
+ public function get contentLabelFactory():Function
+ {
+ return this._contentLabelFactory;
+ }
+
+ /**
+ * @private
+ */
+ public function set contentLabelFactory(value:Function):void
+ {
+ if(this._contentLabelFactory == value)
+ {
+ return;
+ }
+ this._contentLabelFactory = value;
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _contentLabelProperties:PropertyProxy;
+
+ /**
+ * A set of key/value pairs to be passed down to a content label.
+ *
+ * If the subcomponent has its own subcomponents, their properties
+ * can be set too, using attribute @ notation. For example,
+ * to set the skin on the thumb which is in a SimpleScrollBar,
+ * which is in a List, you can use the following syntax:
+ * list.verticalScrollBarProperties.@thumbProperties.defaultSkin = new Image(texture);
+ *
+ * In the following example, a custom content label properties are
+ * customized:
+ *
+ *
+ * renderer.contentLabelProperties.textFormat = new TextFormat( "Source Sans Pro", 16, 0x333333 );
+ * renderer.contentLabelProperties.embedFonts = true;
+ *
+ * @default null
+ *
+ * @see feathers.core.ITextRenderer
+ * @see #contentLabelField
+ * @see #contentLabelFunction
+ */
+ public function get contentLabelProperties():Object
+ {
+ if(!this._contentLabelProperties)
+ {
+ this._contentLabelProperties = new PropertyProxy(contentLabelProperties_onChange);
+ }
+ return this._contentLabelProperties;
+ }
+
+ /**
+ * @private
+ */
+ public function set contentLabelProperties(value:Object):void
+ {
+ if(this._contentLabelProperties == value)
+ {
+ return;
+ }
+ if(!value)
+ {
+ value = new PropertyProxy();
+ }
+ if(!(value is PropertyProxy))
+ {
+ var newValue:PropertyProxy = new PropertyProxy();
+ for(var propertyName:String in value)
+ {
+ newValue[propertyName] = value[propertyName];
+ }
+ value = newValue;
+ }
+ if(this._contentLabelProperties)
+ {
+ this._contentLabelProperties.removeOnChangeCallback(contentLabelProperties_onChange);
+ }
+ this._contentLabelProperties = PropertyProxy(value);
+ if(this._contentLabelProperties)
+ {
+ this._contentLabelProperties.addOnChangeCallback(contentLabelProperties_onChange);
+ }
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var originalBackgroundWidth:Number = NaN;
+
+ /**
+ * @private
+ */
+ protected var originalBackgroundHeight:Number = NaN;
+
+ /**
+ * @private
+ */
+ protected var currentBackgroundSkin:DisplayObject;
+
+ /**
+ * @private
+ */
+ protected var _backgroundSkin:DisplayObject;
+
+ /**
+ * A background to behind the component's content.
+ *
+ * In the following example, the header renderers is given a
+ * background skin:
+ *
+ *
+ * renderer.backgroundSkin = new Image( texture );
+ *
+ * @default null
+ */
+ public function get backgroundSkin():DisplayObject
+ {
+ return this._backgroundSkin;
+ }
+
+ /**
+ * @private
+ */
+ public function set backgroundSkin(value:DisplayObject):void
+ {
+ if(this._backgroundSkin == value)
+ {
+ return;
+ }
+
+ if(this._backgroundSkin && this._backgroundSkin != this._backgroundDisabledSkin)
+ {
+ this.removeChild(this._backgroundSkin);
+ }
+ this._backgroundSkin = value;
+ if(this._backgroundSkin && this._backgroundSkin.parent != this)
+ {
+ this._backgroundSkin.visible = false;
+ this.addChildAt(this._backgroundSkin, 0);
+ }
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _backgroundDisabledSkin:DisplayObject;
+
+ /**
+ * A background to display when the component is disabled.
+ *
+ * In the following example, the header renderers is given a
+ * disabled background skin:
+ *
+ *
+ * renderer.backgroundDisabledSkin = new Image( texture );
+ *
+ * @default null
+ */
+ public function get backgroundDisabledSkin():DisplayObject
+ {
+ return this._backgroundDisabledSkin;
+ }
+
+ /**
+ * @private
+ */
+ public function set backgroundDisabledSkin(value:DisplayObject):void
+ {
+ if(this._backgroundDisabledSkin == value)
+ {
+ return;
+ }
+
+ if(this._backgroundDisabledSkin && this._backgroundDisabledSkin != this._backgroundSkin)
+ {
+ this.removeChild(this._backgroundDisabledSkin);
+ }
+ this._backgroundDisabledSkin = value;
+ if(this._backgroundDisabledSkin && this._backgroundDisabledSkin.parent != this)
+ {
+ this._backgroundDisabledSkin.visible = false;
+ this.addChildAt(this._backgroundDisabledSkin, 0);
+ }
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * Quickly sets all padding properties to the same value. The
+ * padding getter always returns the value of
+ * paddingTop, but the other padding values may be
+ * different.
+ *
+ * In the following example, the padding is set to 20 pixels:
+ *
+ *
+ * renderer.padding = 20;
+ *
+ * @default 0
+ */
+ public function get padding():Number
+ {
+ return this._paddingTop;
+ }
+
+ /**
+ * @private
+ */
+ public function set padding(value:Number):void
+ {
+ this.paddingTop = value;
+ this.paddingRight = value;
+ this.paddingBottom = value;
+ this.paddingLeft = value;
+ }
+
+ /**
+ * @private
+ */
+ protected var _paddingTop:Number = 0;
+
+ /**
+ * The minimum space, in pixels, between the component's top edge and
+ * the component's content.
+ *
+ * In the following example, the top padding is set to 20 pixels:
+ *
+ *
+ * renderer.paddingTop = 20;
+ *
+ * @default 0
+ */
+ public function get paddingTop():Number
+ {
+ return this._paddingTop;
+ }
+
+ /**
+ * @private
+ */
+ public function set paddingTop(value:Number):void
+ {
+ if(this._paddingTop == value)
+ {
+ return;
+ }
+ this._paddingTop = value;
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _paddingRight:Number = 0;
+
+ /**
+ * The minimum space, in pixels, between the component's right edge
+ * and the component's content.
+ *
+ * In the following example, the right padding is set to 20 pixels:
+ *
+ *
+ * renderer.paddingRight = 20;
+ *
+ * @default 0
+ */
+ public function get paddingRight():Number
+ {
+ return this._paddingRight;
+ }
+
+ /**
+ * @private
+ */
+ public function set paddingRight(value:Number):void
+ {
+ if(this._paddingRight == value)
+ {
+ return;
+ }
+ this._paddingRight = value;
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _paddingBottom:Number = 0;
+
+ /**
+ * The minimum space, in pixels, between the component's bottom edge
+ * and the component's content.
+ *
+ * In the following example, the bottom padding is set to 20 pixels:
+ *
+ *
+ * renderer.paddingBottom = 20;
+ *
+ * @default 0
+ */
+ public function get paddingBottom():Number
+ {
+ return this._paddingBottom;
+ }
+
+ /**
+ * @private
+ */
+ public function set paddingBottom(value:Number):void
+ {
+ if(this._paddingBottom == value)
+ {
+ return;
+ }
+ this._paddingBottom = value;
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _paddingLeft:Number = 0;
+
+ /**
+ * The minimum space, in pixels, between the component's left edge
+ * and the component's content.
+ *
+ * In the following example, the left padding is set to 20 pixels:
+ *
+ *
+ * renderer.paddingLeft = 20;
+ *
+ * @default 0
+ */
+ public function get paddingLeft():Number
+ {
+ return this._paddingLeft;
+ }
+
+ /**
+ * @private
+ */
+ public function set paddingLeft(value:Number):void
+ {
+ if(this._paddingLeft == value)
+ {
+ return;
+ }
+ this._paddingLeft = value;
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ override public function dispose():void
+ {
+ //the content may have come from outside of this class. it's up
+ //to that code to dispose of the content. in fact, if we disposed
+ //of it here, we might screw something up!
+ if(this.content)
+ {
+ this.content.removeFromParent();
+ }
+
+ //however, we need to dispose these, if they exist, since we made
+ //them here.
+ if(this.contentImage)
+ {
+ this.contentImage.dispose();
+ this.contentImage = null;
+ }
+ if(this.contentLabel)
+ {
+ DisplayObject(this.contentLabel).dispose();
+ this.contentLabel = null;
+ }
+ super.dispose();
+ }
+
+ /**
+ * Uses the content fields and functions to generate content for a
+ * specific group header or footer.
+ *
+ * All of the content fields and functions, ordered by priority:
+ *
+ * contentTextureFunctioncontentTextureFieldcontentLabelFunctioncontentLabelFieldcontentFunctioncontentField
+ */
+ protected function itemToContent(item:Object):DisplayObject
+ {
+ if(this._contentSourceFunction != null)
+ {
+ var source:Object = this._contentSourceFunction(item);
+ this.refreshContentSource(source);
+ return this.contentImage;
+ }
+ else if(this._contentSourceField != null && item && item.hasOwnProperty(this._contentSourceField))
+ {
+ source = item[this._contentSourceField];
+ this.refreshContentSource(source);
+ return this.contentImage;
+ }
+ else if(this._contentLabelFunction != null)
+ {
+ var labelResult:Object = this._contentLabelFunction(item);
+ if(labelResult is String)
+ {
+ this.refreshContentLabel(labelResult as String);
+ }
+ else
+ {
+ this.refreshContentLabel(labelResult.toString());
+ }
+ return DisplayObject(this.contentLabel);
+ }
+ else if(this._contentLabelField != null && item && item.hasOwnProperty(this._contentLabelField))
+ {
+ labelResult = item[this._contentLabelField];
+ if(labelResult is String)
+ {
+ this.refreshContentLabel(labelResult as String);
+ }
+ else
+ {
+ this.refreshContentLabel(labelResult.toString());
+ }
+ return DisplayObject(this.contentLabel);
+ }
+ else if(this._contentFunction != null)
+ {
+ return this._contentFunction(item) as DisplayObject;
+ }
+ else if(this._contentField != null && item && item.hasOwnProperty(this._contentField))
+ {
+ return item[this._contentField] as DisplayObject;
+ }
+ else if(item is String)
+ {
+ this.refreshContentLabel(item as String);
+ return DisplayObject(this.contentLabel);
+ }
+ else if(item)
+ {
+ this.refreshContentLabel(item.toString());
+ return DisplayObject(this.contentLabel);
+ }
+
+ return null;
+ }
+
+ /**
+ * @private
+ */
+ override protected function draw():void
+ {
+ var dataInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_DATA);
+ var stylesInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_STYLES);
+ var stateInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_STATE);
+ var sizeInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_SIZE);
+
+ if(stylesInvalid || stateInvalid)
+ {
+ this.refreshBackgroundSkin();
+ }
+
+ if(dataInvalid)
+ {
+ this.commitData();
+ }
+
+ if(dataInvalid || stylesInvalid)
+ {
+ this.refreshContentLabelStyles();
+ }
+
+ if(dataInvalid || stateInvalid)
+ {
+ this.refreshEnabled();
+ }
+
+ sizeInvalid = this.autoSizeIfNeeded() || sizeInvalid;
+
+ if(dataInvalid || stylesInvalid || sizeInvalid)
+ {
+ this.layout();
+ }
+
+ if(sizeInvalid || stylesInvalid || stateInvalid)
+ {
+ if(this.currentBackgroundSkin)
+ {
+ this.currentBackgroundSkin.width = this.actualWidth;
+ this.currentBackgroundSkin.height = this.actualHeight;
+ }
+ }
+ }
+
+ /**
+ * If the component's dimensions have not been set explicitly, it will
+ * measure its content and determine an ideal size for itself. If the
+ * explicitWidth or explicitHeight member
+ * variables are set, those value will be used without additional
+ * measurement. If one is set, but not the other, the dimension with the
+ * explicit value will not be measured, but the other non-explicit
+ * dimension will still need measurement.
+ *
+ * Calls setSizeInternal() to set up the
+ * actualWidth and actualHeight member
+ * variables used for layout.
+ *
+ * Meant for internal use, and subclasses may override this function
+ * with a custom implementation.
+ */
+ protected function autoSizeIfNeeded():Boolean
+ {
+ var needsWidth:Boolean = this.explicitWidth !== this.explicitWidth; //isNaN
+ var needsHeight:Boolean = this.explicitHeight !== this.explicitHeight; //isNaN
+ if(!needsWidth && !needsHeight)
+ {
+ return false;
+ }
+ if(!this.content)
+ {
+ return this.setSizeInternal(0, 0, false);
+ }
+ if(this.contentLabel)
+ {
+ //special case for label to allow word wrap
+ var labelMaxWidth:Number = this.explicitWidth;
+ if(needsWidth)
+ {
+ labelMaxWidth = this._maxWidth;
+ }
+ this.contentLabel.maxWidth = labelMaxWidth - this._paddingLeft - this._paddingRight;
+ }
+ if(this._horizontalAlign == HORIZONTAL_ALIGN_JUSTIFY)
+ {
+ this.content.width = this.explicitWidth - this._paddingLeft - this._paddingRight;
+ }
+ if(this._verticalAlign == VERTICAL_ALIGN_JUSTIFY)
+ {
+ this.content.height = this.explicitHeight - this._paddingTop - this._paddingBottom;
+ }
+ if(this.content is IValidating)
+ {
+ IValidating(this.content).validate();
+ }
+ var newWidth:Number = this.explicitWidth;
+ var newHeight:Number = this.explicitHeight;
+ if(needsWidth)
+ {
+ newWidth = this.content.width + this._paddingLeft + this._paddingRight;
+ if(this.originalBackgroundWidth === this.originalBackgroundWidth && //!isNaN
+ this.originalBackgroundWidth > newWidth)
+ {
+ newWidth = this.originalBackgroundWidth;
+ }
+ }
+ if(needsHeight)
+ {
+ newHeight = this.content.height + this._paddingTop + this._paddingBottom;
+ if(this.originalBackgroundHeight === this.originalBackgroundHeight && //!isNaN
+ this.originalBackgroundHeight > newHeight)
+ {
+ newHeight = this.originalBackgroundHeight;
+ }
+ }
+ return this.setSizeInternal(newWidth, newHeight, false);
+ }
+
+ /**
+ * @private
+ */
+ protected function refreshBackgroundSkin():void
+ {
+ this.currentBackgroundSkin = this._backgroundSkin;
+ if(!this._isEnabled && this._backgroundDisabledSkin)
+ {
+ if(this._backgroundSkin)
+ {
+ this._backgroundSkin.visible = false;
+ }
+ this.currentBackgroundSkin = this._backgroundDisabledSkin;
+ }
+ else if(this._backgroundDisabledSkin)
+ {
+ this._backgroundDisabledSkin.visible = false;
+ }
+ if(this.currentBackgroundSkin)
+ {
+ if(this.originalBackgroundWidth !== this.originalBackgroundWidth) //isNaN
+ {
+ this.originalBackgroundWidth = this.currentBackgroundSkin.width;
+ }
+ if(this.originalBackgroundHeight !== this.originalBackgroundHeight) //isNaN
+ {
+ this.originalBackgroundHeight = this.currentBackgroundSkin.height;
+ }
+ this.currentBackgroundSkin.visible = true;
+ }
+ }
+
+ /**
+ * @private
+ */
+ protected function commitData():void
+ {
+ if(this._owner)
+ {
+ var newContent:DisplayObject = this.itemToContent(this._data);
+ if(newContent != this.content)
+ {
+ if(this.content)
+ {
+ this.content.removeFromParent();
+ }
+ this.content = newContent;
+ if(this.content)
+ {
+ this.addChild(this.content);
+ }
+ }
+ }
+ else
+ {
+ if(this.content)
+ {
+ this.content.removeFromParent();
+ this.content = null;
+ }
+ }
+ }
+
+ /**
+ * @private
+ */
+ protected function refreshContentSource(source:Object):void
+ {
+ if(!this.contentImage)
+ {
+ this.contentImage = this._contentLoaderFactory();
+ }
+ this.contentImage.source = source;
+ }
+
+ /**
+ * @private
+ */
+ protected function refreshContentLabel(label:String):void
+ {
+ if(label !== null)
+ {
+ if(!this.contentLabel)
+ {
+ var factory:Function = this._contentLabelFactory != null ? this._contentLabelFactory : FeathersControl.defaultTextRendererFactory;
+ this.contentLabel = ITextRenderer(factory());
+ FeathersControl(this.contentLabel).styleNameList.add(this.contentLabelName);
+ }
+ this.contentLabel.text = label;
+ }
+ else if(this.contentLabel)
+ {
+ DisplayObject(this.contentLabel).removeFromParent(true);
+ this.contentLabel = null;
+ }
+ }
+
+ /**
+ * @private
+ */
+ protected function refreshEnabled():void
+ {
+ if(this.content is IFeathersControl)
+ {
+ IFeathersControl(this.content).isEnabled = this._isEnabled;
+ }
+ }
+
+ /**
+ * @private
+ */
+ protected function refreshContentLabelStyles():void
+ {
+ if(!this.contentLabel)
+ {
+ return;
+ }
+ for(var propertyName:String in this._contentLabelProperties)
+ {
+ var propertyValue:Object = this._contentLabelProperties[propertyName];
+ this.contentLabel[propertyName] = propertyValue;
+ }
+ }
+
+ /**
+ * @private
+ */
+ protected function layout():void
+ {
+ if(!this.content)
+ {
+ return;
+ }
+
+ if(this.contentLabel)
+ {
+ this.contentLabel.maxWidth = this.actualWidth - this._paddingLeft - this._paddingRight;
+ }
+ switch(this._horizontalAlign)
+ {
+ case HORIZONTAL_ALIGN_CENTER:
+ {
+ this.content.x = this._paddingLeft + (this.actualWidth - this._paddingLeft - this._paddingRight - this.content.width) / 2;
+ break;
+ }
+ case HORIZONTAL_ALIGN_RIGHT:
+ {
+ this.content.x = this.actualWidth - this._paddingRight - this.content.width;
+ break;
+ }
+ case HORIZONTAL_ALIGN_JUSTIFY:
+ {
+ this.content.x = this._paddingLeft;
+ this.content.width = this.actualWidth - this._paddingLeft - this._paddingRight;
+ break;
+ }
+ default: //left
+ {
+ this.content.x = this._paddingLeft;
+ }
+ }
+
+ switch(this._verticalAlign)
+ {
+ case VERTICAL_ALIGN_TOP:
+ {
+ this.content.y = this._paddingTop;
+ break;
+ }
+ case VERTICAL_ALIGN_BOTTOM:
+ {
+ this.content.y = this.actualHeight - this._paddingBottom - this.content.height;
+ break;
+ }
+ case VERTICAL_ALIGN_JUSTIFY:
+ {
+ this.content.y = this._paddingTop;
+ this.content.height = this.actualHeight - this._paddingTop - this._paddingBottom;
+ break;
+ }
+ default: //middle
+ {
+ this.content.y = this._paddingTop + (this.actualHeight - this._paddingTop - this._paddingBottom - this.content.height) / 2;
+ }
+ }
+
+ }
+
+ /**
+ * @private
+ */
+ protected function contentLabelProperties_onChange(proxy:PropertyProxy, name:String):void
+ {
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+ }
+}
diff --git a/source/feathers/controls/renderers/DefaultGroupedListItemRenderer.as b/source/feathers/controls/renderers/DefaultGroupedListItemRenderer.as
new file mode 100644
index 0000000000..cc31b4b06d
--- /dev/null
+++ b/source/feathers/controls/renderers/DefaultGroupedListItemRenderer.as
@@ -0,0 +1,298 @@
+/*
+Feathers
+Copyright 2012-2014 Joshua Tynjala. All Rights Reserved.
+
+This program is free software. You can redistribute and/or modify it in
+accordance with the terms of the accompanying license agreement.
+*/
+package feathers.controls.renderers
+{
+ import feathers.controls.GroupedList;
+ import feathers.events.FeathersEventType;
+ import feathers.skins.IStyleProvider;
+
+ /**
+ * The default item renderer for a GroupedList control. Supports up to three
+ * optional sub-views, including a label to display text, an icon to display
+ * an image, and an "accessory" to display a UI control or another display
+ * object (with shortcuts for including a second image or a second label).
+ *
+ * @see feathers.controls.GroupedList
+ */
+ public class DefaultGroupedListItemRenderer extends BaseDefaultItemRenderer implements IGroupedListItemRenderer
+ {
+ /**
+ * @copy feathers.controls.Button#ICON_POSITION_TOP
+ *
+ * @see feathers.controls.Button#iconPosition
+ */
+ public static const ICON_POSITION_TOP:String = "top";
+
+ /**
+ * @copy feathers.controls.Button#ICON_POSITION_RIGHT
+ *
+ * @see feathers.controls.Button#iconPosition
+ */
+ public static const ICON_POSITION_RIGHT:String = "right";
+
+ /**
+ * @copy feathers.controls.Button#ICON_POSITION_BOTTOM
+ *
+ * @see feathers.controls.Button#iconPosition
+ */
+ public static const ICON_POSITION_BOTTOM:String = "bottom";
+
+ /**
+ * @copy feathers.controls.Button#ICON_POSITION_LEFT
+ *
+ * @see feathers.controls.Button#iconPosition
+ */
+ public static const ICON_POSITION_LEFT:String = "left";
+
+ /**
+ * @copy feathers.controls.Button#ICON_POSITION_MANUAL
+ *
+ * @see feathers.controls.Button#iconPosition
+ * @see feathers.controls.Button#iconOffsetX
+ * @see feathers.controls.Button#iconOffsetY
+ */
+ public static const ICON_POSITION_MANUAL:String = "manual";
+
+ /**
+ * @copy feathers.controls.Button#ICON_POSITION_LEFT_BASELINE
+ *
+ * @see feathers.controls.Button#iconPosition
+ */
+ public static const ICON_POSITION_LEFT_BASELINE:String = "leftBaseline";
+
+ /**
+ * @copy feathers.controls.Button#ICON_POSITION_RIGHT_BASELINE
+ *
+ * @see feathers.controls.Button#iconPosition
+ */
+ public static const ICON_POSITION_RIGHT_BASELINE:String = "rightBaseline";
+
+ /**
+ * @copy feathers.controls.Button#HORIZONTAL_ALIGN_LEFT
+ *
+ * @see feathers.controls.Button#horizontalAlign
+ */
+ public static const HORIZONTAL_ALIGN_LEFT:String = "left";
+
+ /**
+ * @copy feathers.controls.Button#HORIZONTAL_ALIGN_CENTER
+ *
+ * @see feathers.controls.Button#horizontalAlign
+ */
+ public static const HORIZONTAL_ALIGN_CENTER:String = "center";
+
+ /**
+ * @copy feathers.controls.Button#HORIZONTAL_ALIGN_RIGHT
+ *
+ * @see feathers.controls.Button#horizontalAlign
+ */
+ public static const HORIZONTAL_ALIGN_RIGHT:String = "right";
+
+ /**
+ * @copy feathers.controls.Button#VERTICAL_ALIGN_TOP
+ *
+ * @see feathers.controls.Button#verticalAlign
+ */
+ public static const VERTICAL_ALIGN_TOP:String = "top";
+
+ /**
+ * @copy feathers.controls.Button#VERTICAL_ALIGN_MIDDLE
+ *
+ * @see feathers.controls.Button#verticalAlign
+ */
+ public static const VERTICAL_ALIGN_MIDDLE:String = "middle";
+
+ /**
+ * @copy feathers.controls.Button#VERTICAL_ALIGN_BOTTOM
+ *
+ * @see feathers.controls.Button#verticalAlign
+ */
+ public static const VERTICAL_ALIGN_BOTTOM:String = "bottom";
+
+ /**
+ * @copy feathers.controls.renderers.BaseDefaultItemRenderer#ACCESSORY_POSITION_TOP
+ *
+ * @see feathers.controls.renderers.BaseDefaultItemRenderer#accessoryPosition
+ */
+ public static const ACCESSORY_POSITION_TOP:String = "top";
+
+ /**
+ * @copy feathers.controls.renderers.BaseDefaultItemRenderer#ACCESSORY_POSITION_RIGHT
+ *
+ * @see feathers.controls.renderers.BaseDefaultItemRenderer#accessoryPosition
+ */
+ public static const ACCESSORY_POSITION_RIGHT:String = "right";
+
+ /**
+ * @copy feathers.controls.renderers.BaseDefaultItemRenderer#ACCESSORY_POSITION_BOTTOM
+ *
+ * @see feathers.controls.renderers.BaseDefaultItemRenderer#accessoryPosition
+ */
+ public static const ACCESSORY_POSITION_BOTTOM:String = "bottom";
+
+ /**
+ * @copy feathers.controls.renderers.BaseDefaultItemRenderer#ACCESSORY_POSITION_LEFT
+ *
+ * @see feathers.controls.renderers.BaseDefaultItemRenderer#accessoryPosition
+ */
+ public static const ACCESSORY_POSITION_LEFT:String = "left";
+
+ /**
+ * @copy feathers.controls.renderers.BaseDefaultItemRenderer#ACCESSORY_POSITION_MANUAL
+ *
+ * @see feathers.controls.renderers.BaseDefaultItemRenderer#accessoryPosition
+ * @see feathers.controls.renderers.BaseDefaultItemRenderer#accessoryOffsetX
+ * @see feathers.controls.renderers.BaseDefaultItemRenderer#accessoryOffsetY
+ */
+ public static const ACCESSORY_POSITION_MANUAL:String = "manual";
+
+ /**
+ * @copy feathers.controls.renderers.BaseDefaultItemRenderer#LAYOUT_ORDER_LABEL_ACCESSORY_ICON
+ *
+ * @see feathers.controls.renderers.BaseDefaultItemRenderer#layoutOrder
+ */
+ public static const LAYOUT_ORDER_LABEL_ACCESSORY_ICON:String = "labelAccessoryIcon";
+
+ /**
+ * @copy feathers.controls.renderers.BaseDefaultItemRenderer#LAYOUT_ORDER_LABEL_ICON_ACCESSORY
+ *
+ * @see feathers.controls.renderers.BaseDefaultItemRenderer#layoutOrder
+ */
+ public static const LAYOUT_ORDER_LABEL_ICON_ACCESSORY:String = "labelIconAccessory";
+
+ /**
+ * The default IStyleProvider for all DefaultGroupedListItemRenderer
+ * components.
+ *
+ * @default null
+ * @see feathers.core.FeathersControl#styleProvider
+ */
+ public static var globalStyleProvider:IStyleProvider;
+
+ /**
+ * Constructor.
+ */
+ public function DefaultGroupedListItemRenderer()
+ {
+ super();
+ }
+
+ /**
+ * @private
+ */
+ override protected function get defaultStyleProvider():IStyleProvider
+ {
+ return DefaultGroupedListItemRenderer.globalStyleProvider;
+ }
+
+ /**
+ * @private
+ */
+ protected var _groupIndex:int = -1;
+
+ /**
+ * @inheritDoc
+ */
+ public function get groupIndex():int
+ {
+ return this._groupIndex;
+ }
+
+ /**
+ * @private
+ */
+ public function set groupIndex(value:int):void
+ {
+ this._groupIndex = value;
+ }
+
+ /**
+ * @private
+ */
+ protected var _itemIndex:int = -1;
+
+ /**
+ * @inheritDoc
+ */
+ public function get itemIndex():int
+ {
+ return this._itemIndex;
+ }
+
+ /**
+ * @private
+ */
+ public function set itemIndex(value:int):void
+ {
+ this._itemIndex = value;
+ }
+
+ /**
+ * @private
+ */
+ protected var _layoutIndex:int = -1;
+
+ /**
+ * @inheritDoc
+ */
+ public function get layoutIndex():int
+ {
+ return this._layoutIndex;
+ }
+
+ /**
+ * @private
+ */
+ public function set layoutIndex(value:int):void
+ {
+ this._layoutIndex = value;
+ }
+
+ /**
+ * @inheritDoc
+ */
+ public function get owner():GroupedList
+ {
+ return GroupedList(this._owner);
+ }
+
+ /**
+ * @private
+ */
+ public function set owner(value:GroupedList):void
+ {
+ if(this._owner == value)
+ {
+ return;
+ }
+ if(this._owner)
+ {
+ this._owner.removeEventListener(FeathersEventType.SCROLL_START, owner_scrollStartHandler);
+ this._owner.removeEventListener(FeathersEventType.SCROLL_COMPLETE, owner_scrollCompleteHandler);
+ }
+ this._owner = value;
+ if(this._owner)
+ {
+ var list:GroupedList = GroupedList(this._owner);
+ this.isSelectableWithoutToggle = list.isSelectable;
+ this._owner.addEventListener(FeathersEventType.SCROLL_START, owner_scrollStartHandler);
+ this._owner.addEventListener(FeathersEventType.SCROLL_COMPLETE, owner_scrollCompleteHandler);
+ }
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ override public function dispose():void
+ {
+ this.owner = null;
+ super.dispose();
+ }
+ }
+}
\ No newline at end of file
diff --git a/source/feathers/controls/renderers/DefaultListItemRenderer.as b/source/feathers/controls/renderers/DefaultListItemRenderer.as
new file mode 100644
index 0000000000..915a867911
--- /dev/null
+++ b/source/feathers/controls/renderers/DefaultListItemRenderer.as
@@ -0,0 +1,261 @@
+/*
+Feathers
+Copyright 2012-2014 Joshua Tynjala. All Rights Reserved.
+
+This program is free software. You can redistribute and/or modify it in
+accordance with the terms of the accompanying license agreement.
+*/
+package feathers.controls.renderers
+{
+ import feathers.controls.List;
+ import feathers.events.FeathersEventType;
+ import feathers.skins.IStyleProvider;
+
+ /**
+ * The default item renderer for List control. Supports up to three optional
+ * sub-views, including a label to display text, an icon to display an
+ * image, and an "accessory" to display a UI control or another display
+ * object (with shortcuts for including a second image or a second label).
+ *
+ * @see feathers.controls.List
+ */
+ public class DefaultListItemRenderer extends BaseDefaultItemRenderer implements IListItemRenderer
+ {
+ /**
+ * @copy feathers.controls.Button#ICON_POSITION_TOP
+ *
+ * @see feathers.controls.Button#iconPosition
+ */
+ public static const ICON_POSITION_TOP:String = "top";
+
+ /**
+ * @copy feathers.controls.Button#ICON_POSITION_RIGHT
+ *
+ * @see feathers.controls.Button#iconPosition
+ */
+ public static const ICON_POSITION_RIGHT:String = "right";
+
+ /**
+ * @copy feathers.controls.Button#ICON_POSITION_BOTTOM
+ *
+ * @see feathers.controls.Button#iconPosition
+ */
+ public static const ICON_POSITION_BOTTOM:String = "bottom";
+
+ /**
+ * @copy feathers.controls.Button#ICON_POSITION_LEFT
+ *
+ * @see feathers.controls.Button#iconPosition
+ */
+ public static const ICON_POSITION_LEFT:String = "left";
+
+ /**
+ * @copy feathers.controls.Button#ICON_POSITION_MANUAL
+ *
+ * @see feathers.controls.Button#iconPosition
+ * @see feathers.controls.Button#iconOffsetX
+ * @see feathers.controls.Button#iconOffsetY
+ */
+ public static const ICON_POSITION_MANUAL:String = "manual";
+
+ /**
+ * @copy feathers.controls.Button#ICON_POSITION_LEFT_BASELINE
+ *
+ * @see feathers.controls.Button#iconPosition
+ */
+ public static const ICON_POSITION_LEFT_BASELINE:String = "leftBaseline";
+
+ /**
+ * @copy feathers.controls.Button#ICON_POSITION_RIGHT_BASELINE
+ *
+ * @see feathers.controls.Button#iconPosition
+ */
+ public static const ICON_POSITION_RIGHT_BASELINE:String = "rightBaseline";
+
+ /**
+ * @copy feathers.controls.Button#HORIZONTAL_ALIGN_LEFT
+ *
+ * @see feathers.controls.Button#horizontalAlign
+ */
+ public static const HORIZONTAL_ALIGN_LEFT:String = "left";
+
+ /**
+ * @copy feathers.controls.Button#HORIZONTAL_ALIGN_CENTER
+ *
+ * @see feathers.controls.Button#horizontalAlign
+ */
+ public static const HORIZONTAL_ALIGN_CENTER:String = "center";
+
+ /**
+ * @copy feathers.controls.Button#HORIZONTAL_ALIGN_RIGHT
+ *
+ * @see feathers.controls.Button#horizontalAlign
+ */
+ public static const HORIZONTAL_ALIGN_RIGHT:String = "right";
+
+ /**
+ * @copy feathers.controls.Button#VERTICAL_ALIGN_TOP
+ *
+ * @see feathers.controls.Button#verticalAlign
+ */
+ public static const VERTICAL_ALIGN_TOP:String = "top";
+
+ /**
+ * @copy feathers.controls.Button#VERTICAL_ALIGN_MIDDLE
+ *
+ * @see feathers.controls.Button#verticalAlign
+ */
+ public static const VERTICAL_ALIGN_MIDDLE:String = "middle";
+
+ /**
+ * @copy feathers.controls.Button#VERTICAL_ALIGN_BOTTOM
+ *
+ * @see feathers.controls.Button#verticalAlign
+ */
+ public static const VERTICAL_ALIGN_BOTTOM:String = "bottom";
+
+ /**
+ * @copy feathers.controls.renderers.BaseDefaultItemRenderer#ACCESSORY_POSITION_TOP
+ *
+ * @see feathers.controls.renderers.BaseDefaultItemRenderer#accessoryPosition
+ */
+ public static const ACCESSORY_POSITION_TOP:String = "top";
+
+ /**
+ * @copy feathers.controls.renderers.BaseDefaultItemRenderer#ACCESSORY_POSITION_RIGHT
+ *
+ * @see feathers.controls.renderers.BaseDefaultItemRenderer#accessoryPosition
+ */
+ public static const ACCESSORY_POSITION_RIGHT:String = "right";
+
+ /**
+ * @copy feathers.controls.renderers.BaseDefaultItemRenderer#ACCESSORY_POSITION_BOTTOM
+ *
+ * @see feathers.controls.renderers.BaseDefaultItemRenderer#accessoryPosition
+ */
+ public static const ACCESSORY_POSITION_BOTTOM:String = "bottom";
+
+ /**
+ * @copy feathers.controls.renderers.BaseDefaultItemRenderer#ACCESSORY_POSITION_LEFT
+ *
+ * @see feathers.controls.renderers.BaseDefaultItemRenderer#accessoryPosition
+ */
+ public static const ACCESSORY_POSITION_LEFT:String = "left";
+
+ /**
+ * @copy feathers.controls.renderers.BaseDefaultItemRenderer#ACCESSORY_POSITION_MANUAL
+ *
+ * @see feathers.controls.renderers.BaseDefaultItemRenderer#accessoryPosition
+ * @see feathers.controls.renderers.BaseDefaultItemRenderer#accessoryOffsetX
+ * @see feathers.controls.renderers.BaseDefaultItemRenderer#accessoryOffsetY
+ */
+ public static const ACCESSORY_POSITION_MANUAL:String = "manual";
+
+ /**
+ * @copy feathers.controls.renderers.BaseDefaultItemRenderer#LAYOUT_ORDER_LABEL_ACCESSORY_ICON
+ *
+ * @see feathers.controls.renderers.BaseDefaultItemRenderer#layoutOrder
+ */
+ public static const LAYOUT_ORDER_LABEL_ACCESSORY_ICON:String = "labelAccessoryIcon";
+
+ /**
+ * @copy feathers.controls.renderers.BaseDefaultItemRenderer#LAYOUT_ORDER_LABEL_ICON_ACCESSORY
+ *
+ * @see feathers.controls.renderers.BaseDefaultItemRenderer#layoutOrder
+ */
+ public static const LAYOUT_ORDER_LABEL_ICON_ACCESSORY:String = "labelIconAccessory";
+
+ /**
+ * The default IStyleProvider for all DefaultListItemRenderer
+ * components.
+ *
+ * @default null
+ * @see feathers.core.FeathersControl#styleProvider
+ */
+ public static var globalStyleProvider:IStyleProvider;
+
+ /**
+ * Constructor.
+ */
+ public function DefaultListItemRenderer()
+ {
+ super();
+ }
+
+ /**
+ * @private
+ */
+ override protected function get defaultStyleProvider():IStyleProvider
+ {
+ return DefaultListItemRenderer.globalStyleProvider;
+ }
+
+ /**
+ * @private
+ */
+ protected var _index:int = -1;
+
+ /**
+ * @inheritDoc
+ */
+ public function get index():int
+ {
+ return this._index;
+ }
+
+ /**
+ * @private
+ */
+ public function set index(value:int):void
+ {
+ this._index = value;
+ }
+
+ /**
+ * @inheritDoc
+ */
+ public function get owner():List
+ {
+ return List(this._owner);
+ }
+
+ /**
+ * @private
+ */
+ public function set owner(value:List):void
+ {
+ if(this._owner == value)
+ {
+ return;
+ }
+ if(this._owner)
+ {
+ this._owner.removeEventListener(FeathersEventType.SCROLL_START, owner_scrollStartHandler);
+ this._owner.removeEventListener(FeathersEventType.SCROLL_COMPLETE, owner_scrollCompleteHandler);
+ }
+ this._owner = value;
+ if(this._owner)
+ {
+ var list:List = List(this._owner);
+ this.isSelectableWithoutToggle = list.isSelectable;
+ if(list.allowMultipleSelection)
+ {
+ //toggling is forced in this case
+ this.isToggle = true;
+ }
+ this._owner.addEventListener(FeathersEventType.SCROLL_START, owner_scrollStartHandler);
+ this._owner.addEventListener(FeathersEventType.SCROLL_COMPLETE, owner_scrollCompleteHandler);
+ }
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ override public function dispose():void
+ {
+ this.owner = null;
+ super.dispose();
+ }
+ }
+}
\ No newline at end of file
diff --git a/source/feathers/controls/renderers/IGroupedListHeaderOrFooterRenderer.as b/source/feathers/controls/renderers/IGroupedListHeaderOrFooterRenderer.as
new file mode 100644
index 0000000000..16a1c67821
--- /dev/null
+++ b/source/feathers/controls/renderers/IGroupedListHeaderOrFooterRenderer.as
@@ -0,0 +1,68 @@
+/*
+Feathers
+Copyright 2012-2014 Joshua Tynjala. All Rights Reserved.
+
+This program is free software. You can redistribute and/or modify it in
+accordance with the terms of the accompanying license agreement.
+*/
+package feathers.controls.renderers
+{
+ import feathers.controls.GroupedList;
+ import feathers.core.IFeathersControl;
+
+ /**
+ * Interface to implement a renderer for a grouped list header or footer.
+ */
+ public interface IGroupedListHeaderOrFooterRenderer extends IFeathersControl
+ {
+ /**
+ * Data for a header or footer from the grouped list's data provider.
+ * The data may change if this renderer is reused for a new header or
+ * footer because it's no longer needed for the original data.
+ *
+ * This property is set by the list, and should not be set manually.
+ */
+ function get data():Object;
+
+ /**
+ * @private
+ */
+ function set data(value:Object):void;
+
+ /**
+ * The index of the group within the data provider of the grouped list.
+ *
+ * This property is set by the list, and should not be set manually.
+ */
+ function get groupIndex():int;
+
+ /**
+ * @private
+ */
+ function set groupIndex(value:int):void;
+
+ /**
+ * The index of the item within the layout.
+ *
+ * This property is set by the list, and should not be set manually.
+ */
+ function get layoutIndex():int;
+
+ /**
+ * @private
+ */
+ function set layoutIndex(value:int):void;
+
+ /**
+ * The grouped list that contains this header or footer renderer.
+ *
+ * This property is set by the list, and should not be set manually.
+ */
+ function get owner():GroupedList;
+
+ /**
+ * @private
+ */
+ function set owner(value:GroupedList):void;
+ }
+}
diff --git a/source/feathers/controls/renderers/IGroupedListItemRenderer.as b/source/feathers/controls/renderers/IGroupedListItemRenderer.as
new file mode 100644
index 0000000000..34f1404254
--- /dev/null
+++ b/source/feathers/controls/renderers/IGroupedListItemRenderer.as
@@ -0,0 +1,81 @@
+/*
+Feathers
+Copyright 2012-2014 Joshua Tynjala. All Rights Reserved.
+
+This program is free software. You can redistribute and/or modify it in
+accordance with the terms of the accompanying license agreement.
+*/
+package feathers.controls.renderers
+{
+ import feathers.controls.*;
+ import feathers.core.IToggle;
+
+ /**
+ * Interface to implement a renderer for a grouped list item.
+ */
+ public interface IGroupedListItemRenderer extends IToggle
+ {
+ /**
+ * An item from the grouped list's data provider. The data may change if
+ * this item renderer is reused for a new item because it's no longer
+ * needed for the original item.
+ *
+ * This property is set by the list, and should not be set manually.
+ */
+ function get data():Object;
+
+ /**
+ * @private
+ */
+ function set data(value:Object):void;
+
+ /**
+ * The index of the item's parent group within the data provider of the
+ * grouped list.
+ *
+ * This property is set by the list, and should not be set manually.
+ */
+ function get groupIndex():int;
+
+ /**
+ * @private
+ */
+ function set groupIndex(value:int):void;
+
+ /**
+ * The index of the item within its parent group.
+ *
+ * This property is set by the list, and should not be set manually.
+ */
+ function get itemIndex():int;
+
+ /**
+ * @private
+ */
+ function set itemIndex(value:int):void;
+
+ /**
+ * The index of the item within the layout.
+ *
+ * This property is set by the list, and should not be set manually.
+ */
+ function get layoutIndex():int;
+
+ /**
+ * @private
+ */
+ function set layoutIndex(value:int):void;
+
+ /**
+ * The grouped list that contains this item renderer.
+ *
+ * This property is set by the list, and should not be set manually.
+ */
+ function get owner():GroupedList;
+
+ /**
+ * @private
+ */
+ function set owner(value:GroupedList):void;
+ }
+}
\ No newline at end of file
diff --git a/source/feathers/controls/renderers/IListItemRenderer.as b/source/feathers/controls/renderers/IListItemRenderer.as
new file mode 100644
index 0000000000..8ca7e04913
--- /dev/null
+++ b/source/feathers/controls/renderers/IListItemRenderer.as
@@ -0,0 +1,59 @@
+/*
+Feathers
+Copyright 2012-2014 Joshua Tynjala. All Rights Reserved.
+
+This program is free software. You can redistribute and/or modify it in
+accordance with the terms of the accompanying license agreement.
+*/
+package feathers.controls.renderers
+{
+ import feathers.controls.*;
+ import feathers.core.IToggle;
+
+ /**
+ * Interface to implement a renderer for a list item.
+ */
+ public interface IListItemRenderer extends IToggle
+ {
+ /**
+ * An item from the list's data provider. The data may change if this
+ * item renderer is reused for a new item because it's no longer needed
+ * for the original item.
+ *
+ * This property is set by the list, and should not be set manually.
+ */
+ function get data():Object;
+
+ /**
+ * @private
+ */
+ function set data(value:Object):void;
+
+ /**
+ * The index (numeric position, starting from zero) of the item within
+ * the list's data provider. Like the data property, this
+ * value may change if this item renderer is reused by the list for a
+ * different item.
+ *
+ * This property is set by the list, and should not be set manually.
+ */
+ function get index():int;
+
+ /**
+ * @private
+ */
+ function set index(value:int):void;
+
+ /**
+ * The list that contains this item renderer.
+ *
+ * This property is set by the list, and should not be set manually.
+ */
+ function get owner():List;
+
+ /**
+ * @private
+ */
+ function set owner(value:List):void;
+ }
+}
\ No newline at end of file
diff --git a/source/feathers/controls/renderers/LayoutGroupGroupedListHeaderOrFooterRenderer.as b/source/feathers/controls/renderers/LayoutGroupGroupedListHeaderOrFooterRenderer.as
new file mode 100644
index 0000000000..55c046d605
--- /dev/null
+++ b/source/feathers/controls/renderers/LayoutGroupGroupedListHeaderOrFooterRenderer.as
@@ -0,0 +1,282 @@
+/*
+Feathers
+Copyright 2012-2014 Joshua Tynjala. All Rights Reserved.
+
+This program is free software. You can redistribute and/or modify it in
+accordance with the terms of the accompanying license agreement.
+*/
+package feathers.controls.renderers
+{
+ import feathers.controls.GroupedList;
+ import feathers.controls.LayoutGroup;
+ import feathers.skins.IStyleProvider;
+
+ import starling.events.Event;
+
+ /**
+ * Based on LayoutGroup, this component is meant as a base
+ * class for creating a custom header or footer renderer for a
+ * GroupedList component.
+ *
+ * Sub-components may be created and added inside initialize().
+ * This is a good place to add event listeners and to set the layout.
+ *
+ * The data property may be parsed inside commitData().
+ * Use this function to change properties in your sub-components.
+ *
+ * Sub-components may be positioned manually, but a layout may be
+ * provided as well. An AnchorLayout is recommended for fluid
+ * layouts that can automatically adjust positions when the list resizes.
+ * Create AnchorLayoutData objects to define the constraints.
+ *
+ * @see feathers.controls.GroupedList
+ */
+ public class LayoutGroupGroupedListHeaderOrFooterRenderer extends LayoutGroup implements IGroupedListHeaderOrFooterRenderer
+ {
+ /**
+ * The default IStyleProvider for all LayoutGroupGroupedListHeaderOrFooterRenderer
+ * components.
+ *
+ * @default null
+ * @see feathers.core.FeathersControl#styleProvider
+ */
+ public static var globalStyleProvider:IStyleProvider;
+
+ /**
+ * Constructor.
+ */
+ public function LayoutGroupGroupedListHeaderOrFooterRenderer()
+ {
+ super();
+ }
+
+ /**
+ * @private
+ */
+ override protected function get defaultStyleProvider():IStyleProvider
+ {
+ return LayoutGroupGroupedListHeaderOrFooterRenderer.globalStyleProvider;
+ }
+
+ /**
+ * @private
+ */
+ protected var _groupIndex:int = -1;
+
+ /**
+ * @inheritDoc
+ */
+ public function get groupIndex():int
+ {
+ return this._groupIndex;
+ }
+
+ /**
+ * @private
+ */
+ public function set groupIndex(value:int):void
+ {
+ this._groupIndex = value;
+ }
+
+ /**
+ * @private
+ */
+ protected var _layoutIndex:int = -1;
+
+ /**
+ * @inheritDoc
+ */
+ public function get layoutIndex():int
+ {
+ return this._layoutIndex;
+ }
+
+ /**
+ * @private
+ */
+ public function set layoutIndex(value:int):void
+ {
+ this._layoutIndex = value;
+ }
+
+ /**
+ * @private
+ */
+ protected var _owner:GroupedList;
+
+ /**
+ * @inheritDoc
+ */
+ public function get owner():GroupedList
+ {
+ return this._owner;
+ }
+
+ /**
+ * @private
+ */
+ public function set owner(value:GroupedList):void
+ {
+ if(this._owner == value)
+ {
+ return;
+ }
+ this._owner = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _data:Object;
+
+ /**
+ * @inheritDoc
+ */
+ public function get data():Object
+ {
+ return this._data;
+ }
+
+ /**
+ * @private
+ */
+ public function set data(value:Object):void
+ {
+ if(this._data == value)
+ {
+ return;
+ }
+ this._data = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _isSelected:Boolean;
+
+ /**
+ * @inheritDoc
+ */
+ public function get isSelected():Boolean
+ {
+ return this._isSelected;
+ }
+
+ /**
+ * @private
+ */
+ public function set isSelected(value:Boolean):void
+ {
+ if(this._isSelected == value)
+ {
+ return;
+ }
+ this._isSelected = value;
+ this.invalidate(INVALIDATION_FLAG_SELECTED);
+ this.dispatchEventWith(Event.CHANGE);
+ }
+
+ /**
+ * @private
+ */
+ override public function dispose():void
+ {
+ this.owner = null;
+ super.dispose();
+ }
+
+ /**
+ * @private
+ */
+ override protected function draw():void
+ {
+ var dataInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_DATA);
+ var scrollInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_SCROLL);
+ var sizeInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_SIZE);
+ var layoutInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_LAYOUT);
+
+ if(dataInvalid)
+ {
+ this.commitData();
+ }
+
+ if(scrollInvalid || sizeInvalid || layoutInvalid)
+ {
+ this._ignoreChildChanges = true;
+ this.preLayout();
+ this._ignoreChildChanges = false;
+ }
+
+ super.draw();
+
+ if(scrollInvalid || sizeInvalid || layoutInvalid)
+ {
+ this._ignoreChildChanges = true;
+ this.postLayout();
+ this._ignoreChildChanges = false;
+ }
+ }
+
+ /**
+ * Makes final changes to the layout before it updates the item
+ * renderer's children. If your layout requires changing the
+ * layoutData property on the item renderer's
+ * sub-components, override the preLayout() function to
+ * make those changes.
+ *
+ * In subclasses, if you create properties that affect the layout,
+ * invalidate using INVALIDATION_FLAG_LAYOUT to trigger a
+ * call to the preLayout() function when the component
+ * validates.
+ *
+ * The final width and height of the item renderer are not yet known
+ * when this function is called. It is meant mainly for adjusting values
+ * used by fluid layouts, such as constraints or percentages. If you
+ * need io access the final width and height of the item renderer,
+ * override the postLayout() function instead.
+ *
+ * @see #postLayout()
+ */
+ protected function preLayout():void
+ {
+
+ }
+
+ /**
+ * Called after the layout updates the item renderer's children. If any
+ * children are excluded from the layout, you can update them in the
+ * postLayout() function if you need to use the final width
+ * and height in any calculations.
+ *
+ * In subclasses, if you create properties that affect the layout,
+ * invalidate using INVALIDATION_FLAG_LAYOUT to trigger a
+ * call to the postLayout() function when the component
+ * validates.
+ *
+ * To make changes to the layout before it updates the item
+ * renderer's children, override the preLayout() function
+ * instead.
+ *
+ * @see #preLayout()
+ */
+ protected function postLayout():void
+ {
+
+ }
+
+ /**
+ * Updates the renderer to display the item's data. Override this
+ * function to pass data to sub-components and react to data changes.
+ *
+ * Don't forget to handle the case where the data is null.
+ */
+ protected function commitData():void
+ {
+
+ }
+
+ }
+}
diff --git a/source/feathers/controls/renderers/LayoutGroupGroupedListItemRenderer.as b/source/feathers/controls/renderers/LayoutGroupGroupedListItemRenderer.as
new file mode 100644
index 0000000000..1b31000a5c
--- /dev/null
+++ b/source/feathers/controls/renderers/LayoutGroupGroupedListItemRenderer.as
@@ -0,0 +1,303 @@
+/*
+Feathers
+Copyright 2012-2014 Joshua Tynjala. All Rights Reserved.
+
+This program is free software. You can redistribute and/or modify it in
+accordance with the terms of the accompanying license agreement.
+*/
+package feathers.controls.renderers
+{
+ import feathers.controls.GroupedList;
+ import feathers.controls.LayoutGroup;
+ import feathers.skins.IStyleProvider;
+
+ import starling.events.Event;
+
+ /**
+ * Based on LayoutGroup, this component is meant as a base
+ * class for creating a custom item renderer for a GroupedList
+ * component.
+ *
+ * Sub-components may be created and added inside initialize().
+ * This is a good place to add event listeners and to set the layout.
+ *
+ * The data property may be parsed inside commitData().
+ * Use this function to change properties in your sub-components.
+ *
+ * Sub-components may be positioned manually, but a layout may be
+ * provided as well. An AnchorLayout is recommended for fluid
+ * layouts that can automatically adjust positions when the list resizes.
+ * Create AnchorLayoutData objects to define the constraints.
+ *
+ * @see feathers.controls.GroupedList
+ */
+ public class LayoutGroupGroupedListItemRenderer extends LayoutGroup implements IGroupedListItemRenderer
+ {
+ /**
+ * The default IStyleProvider for all LayoutGroupGroupedListItemRenderer
+ * components.
+ *
+ * @default null
+ * @see feathers.core.FeathersControl#styleProvider
+ */
+ public static var globalStyleProvider:IStyleProvider;
+
+ /**
+ * Constructor.
+ */
+ public function LayoutGroupGroupedListItemRenderer()
+ {
+ super();
+ }
+
+ /**
+ * @private
+ */
+ override protected function get defaultStyleProvider():IStyleProvider
+ {
+ return LayoutGroupGroupedListItemRenderer.globalStyleProvider;
+ }
+
+ /**
+ * @private
+ */
+ protected var _groupIndex:int = -1;
+
+ /**
+ * @inheritDoc
+ */
+ public function get groupIndex():int
+ {
+ return this._groupIndex;
+ }
+
+ /**
+ * @private
+ */
+ public function set groupIndex(value:int):void
+ {
+ this._groupIndex = value;
+ }
+
+ /**
+ * @private
+ */
+ protected var _itemIndex:int = -1;
+
+ /**
+ * @inheritDoc
+ */
+ public function get itemIndex():int
+ {
+ return this._itemIndex;
+ }
+
+ /**
+ * @private
+ */
+ public function set itemIndex(value:int):void
+ {
+ this._itemIndex = value;
+ }
+
+ /**
+ * @private
+ */
+ protected var _layoutIndex:int = -1;
+
+ /**
+ * @inheritDoc
+ */
+ public function get layoutIndex():int
+ {
+ return this._layoutIndex;
+ }
+
+ /**
+ * @private
+ */
+ public function set layoutIndex(value:int):void
+ {
+ this._layoutIndex = value;
+ }
+
+ /**
+ * @private
+ */
+ protected var _owner:GroupedList;
+
+ /**
+ * @inheritDoc
+ */
+ public function get owner():GroupedList
+ {
+ return this._owner;
+ }
+
+ /**
+ * @private
+ */
+ public function set owner(value:GroupedList):void
+ {
+ if(this._owner == value)
+ {
+ return;
+ }
+ this._owner = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _data:Object;
+
+ /**
+ * @inheritDoc
+ */
+ public function get data():Object
+ {
+ return this._data;
+ }
+
+ /**
+ * @private
+ */
+ public function set data(value:Object):void
+ {
+ if(this._data == value)
+ {
+ return;
+ }
+ this._data = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _isSelected:Boolean;
+
+ /**
+ * @inheritDoc
+ */
+ public function get isSelected():Boolean
+ {
+ return this._isSelected;
+ }
+
+ /**
+ * @private
+ */
+ public function set isSelected(value:Boolean):void
+ {
+ if(this._isSelected == value)
+ {
+ return;
+ }
+ this._isSelected = value;
+ this.invalidate(INVALIDATION_FLAG_SELECTED);
+ this.dispatchEventWith(Event.CHANGE);
+ }
+
+ /**
+ * @private
+ */
+ override public function dispose():void
+ {
+ this.owner = null;
+ super.dispose();
+ }
+
+ /**
+ * @private
+ */
+ override protected function draw():void
+ {
+ var dataInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_DATA);
+ var scrollInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_SCROLL);
+ var sizeInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_SIZE);
+ var layoutInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_LAYOUT);
+
+ if(dataInvalid)
+ {
+ this.commitData();
+ }
+
+ if(scrollInvalid || sizeInvalid || layoutInvalid)
+ {
+ this._ignoreChildChanges = true;
+ this.preLayout();
+ this._ignoreChildChanges = false;
+ }
+
+ super.draw();
+
+ if(scrollInvalid || sizeInvalid || layoutInvalid)
+ {
+ this._ignoreChildChanges = true;
+ this.postLayout();
+ this._ignoreChildChanges = false;
+ }
+ }
+
+ /**
+ * Makes final changes to the layout before it updates the item
+ * renderer's children. If your layout requires changing the
+ * layoutData property on the item renderer's
+ * sub-components, override the preLayout() function to
+ * make those changes.
+ *
+ * In subclasses, if you create properties that affect the layout,
+ * invalidate using INVALIDATION_FLAG_LAYOUT to trigger a
+ * call to the preLayout() function when the component
+ * validates.
+ *
+ * The final width and height of the item renderer are not yet known
+ * when this function is called. It is meant mainly for adjusting values
+ * used by fluid layouts, such as constraints or percentages. If you
+ * need io access the final width and height of the item renderer,
+ * override the postLayout() function instead.
+ *
+ * @see #postLayout()
+ */
+ protected function preLayout():void
+ {
+
+ }
+
+ /**
+ * Called after the layout updates the item renderer's children. If any
+ * children are excluded from the layout, you can update them in the
+ * postLayout() function if you need to use the final width
+ * and height in any calculations.
+ *
+ * In subclasses, if you create properties that affect the layout,
+ * invalidate using INVALIDATION_FLAG_LAYOUT to trigger a
+ * call to the postLayout() function when the component
+ * validates.
+ *
+ * To make changes to the layout before it updates the item
+ * renderer's children, override the preLayout() function
+ * instead.
+ *
+ * @see #preLayout()
+ */
+ protected function postLayout():void
+ {
+
+ }
+
+ /**
+ * Updates the renderer to display the item's data. Override this
+ * function to pass data to sub-components and react to data changes.
+ *
+ * Don't forget to handle the case where the data is null.
+ */
+ protected function commitData():void
+ {
+
+ }
+
+ }
+}
diff --git a/source/feathers/controls/renderers/LayoutGroupListItemRenderer.as b/source/feathers/controls/renderers/LayoutGroupListItemRenderer.as
new file mode 100644
index 0000000000..b5db939e30
--- /dev/null
+++ b/source/feathers/controls/renderers/LayoutGroupListItemRenderer.as
@@ -0,0 +1,261 @@
+/*
+Feathers
+Copyright 2012-2014 Joshua Tynjala. All Rights Reserved.
+
+This program is free software. You can redistribute and/or modify it in
+accordance with the terms of the accompanying license agreement.
+*/
+package feathers.controls.renderers
+{
+ import feathers.controls.LayoutGroup;
+ import feathers.controls.List;
+ import feathers.skins.IStyleProvider;
+
+ import starling.events.Event;
+
+ /**
+ * Based on LayoutGroup, this component is meant as a base
+ * class for creating a custom item renderer for a List
+ * component.
+ *
+ * Sub-components may be created and added inside initialize().
+ * This is a good place to add event listeners and to set the layout.
+ *
+ * The data property may be parsed inside commitData().
+ * Use this function to change properties in your sub-components.
+ *
+ * Sub-components may be positioned manually, but a layout may be
+ * provided as well. An AnchorLayout is recommended for fluid
+ * layouts that can automatically adjust positions when the list resizes.
+ * Create AnchorLayoutData objects to define the constraints.
+ *
+ * @see feathers.controls.List
+ */
+ public class LayoutGroupListItemRenderer extends LayoutGroup implements IListItemRenderer
+ {
+ /**
+ * The default IStyleProvider for all LayoutGroupListItemRenderer
+ * components.
+ *
+ * @default null
+ * @see feathers.core.FeathersControl#styleProvider
+ */
+ public static var globalStyleProvider:IStyleProvider;
+
+ /**
+ * Constructor.
+ */
+ public function LayoutGroupListItemRenderer()
+ {
+ super();
+ }
+
+ /**
+ * @private
+ */
+ override protected function get defaultStyleProvider():IStyleProvider
+ {
+ return LayoutGroupListItemRenderer.globalStyleProvider;
+ }
+
+ /**
+ * @private
+ */
+ protected var _index:int = -1;
+
+ /**
+ * @inheritDoc
+ */
+ public function get index():int
+ {
+ return this._index;
+ }
+
+ /**
+ * @private
+ */
+ public function set index(value:int):void
+ {
+ this._index = value;
+ }
+
+ /**
+ * @private
+ */
+ protected var _owner:List;
+
+ /**
+ * @inheritDoc
+ */
+ public function get owner():List
+ {
+ return this._owner;
+ }
+
+ /**
+ * @private
+ */
+ public function set owner(value:List):void
+ {
+ if(this._owner == value)
+ {
+ return;
+ }
+ this._owner = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _data:Object;
+
+ /**
+ * @inheritDoc
+ */
+ public function get data():Object
+ {
+ return this._data;
+ }
+
+ /**
+ * @private
+ */
+ public function set data(value:Object):void
+ {
+ if(this._data == value)
+ {
+ return;
+ }
+ this._data = value;
+ this.invalidate(INVALIDATION_FLAG_DATA);
+ }
+
+ /**
+ * @private
+ */
+ protected var _isSelected:Boolean;
+
+ /**
+ * @inheritDoc
+ */
+ public function get isSelected():Boolean
+ {
+ return this._isSelected;
+ }
+
+ /**
+ * @private
+ */
+ public function set isSelected(value:Boolean):void
+ {
+ if(this._isSelected == value)
+ {
+ return;
+ }
+ this._isSelected = value;
+ this.invalidate(INVALIDATION_FLAG_SELECTED);
+ this.dispatchEventWith(Event.CHANGE);
+ }
+
+ /**
+ * @private
+ */
+ override public function dispose():void
+ {
+ this.owner = null;
+ super.dispose();
+ }
+
+ /**
+ * @private
+ */
+ override protected function draw():void
+ {
+ var dataInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_DATA);
+ var scrollInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_SCROLL);
+ var sizeInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_SIZE);
+ var layoutInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_LAYOUT);
+
+ if(dataInvalid)
+ {
+ this.commitData();
+ }
+
+ if(scrollInvalid || sizeInvalid || layoutInvalid)
+ {
+ this._ignoreChildChanges = true;
+ this.preLayout();
+ this._ignoreChildChanges = false;
+ }
+
+ super.draw();
+
+ if(scrollInvalid || sizeInvalid || layoutInvalid)
+ {
+ this._ignoreChildChanges = true;
+ this.postLayout();
+ this._ignoreChildChanges = false;
+ }
+ }
+
+ /**
+ * Makes final changes to the layout before it updates the item
+ * renderer's children. If your layout requires changing the
+ * layoutData property on the item renderer's
+ * sub-components, override the preLayout() function to
+ * make those changes.
+ *
+ * In subclasses, if you create properties that affect the layout,
+ * invalidate using INVALIDATION_FLAG_LAYOUT to trigger a
+ * call to the preLayout() function when the component
+ * validates.
+ *
+ * The final width and height of the item renderer are not yet known
+ * when this function is called. It is meant mainly for adjusting values
+ * used by fluid layouts, such as constraints or percentages. If you
+ * need io access the final width and height of the item renderer,
+ * override the postLayout() function instead.
+ *
+ * @see #postLayout()
+ */
+ protected function preLayout():void
+ {
+
+ }
+
+ /**
+ * Called after the layout updates the item renderer's children. If any
+ * children are excluded from the layout, you can update them in the
+ * postLayout() function if you need to use the final width
+ * and height in any calculations.
+ *
+ * In subclasses, if you create properties that affect the layout,
+ * invalidate using INVALIDATION_FLAG_LAYOUT to trigger a
+ * call to the postLayout() function when the component
+ * validates.
+ *
+ * To make changes to the layout before it updates the item
+ * renderer's children, override the preLayout() function
+ * instead.
+ *
+ * @see #preLayout()
+ */
+ protected function postLayout():void
+ {
+
+ }
+
+ /**
+ * Updates the renderer to display the item's data. Override this
+ * function to pass data to sub-components and react to data changes.
+ *
+ * Don't forget to handle the case where the data is null.
+ */
+ protected function commitData():void
+ {
+
+ }
+
+ }
+}
diff --git a/source/feathers/controls/supportClasses/BaseScreenNavigator.as b/source/feathers/controls/supportClasses/BaseScreenNavigator.as
new file mode 100644
index 0000000000..83801e9ae5
--- /dev/null
+++ b/source/feathers/controls/supportClasses/BaseScreenNavigator.as
@@ -0,0 +1,816 @@
+/*
+Feathers
+Copyright 2012-2014 Joshua Tynjala. All Rights Reserved.
+
+This program is free software. You can redistribute and/or modify it in
+accordance with the terms of the accompanying license agreement.
+*/
+package feathers.controls.supportClasses
+{
+ import feathers.controls.IScreen;
+ import feathers.core.FeathersControl;
+ import feathers.core.IValidating;
+ import feathers.events.FeathersEventType;
+
+ import flash.errors.IllegalOperationError;
+ import flash.geom.Rectangle;
+ import flash.utils.getDefinitionByName;
+
+ import starling.display.DisplayObject;
+ import starling.errors.AbstractMethodError;
+ import starling.events.Event;
+
+ /**
+ * Dispatched when the active screen changes.
+ *
+ * The properties of the event object have the following values:
+ *
+ * | Property | Value |
|---|
+ * bubbles | false |
+ * currentTarget | The Object that defines the
+ * event listener that handles the event. For example, if you use
+ * myButton.addEventListener() to register an event listener,
+ * myButton is the value of the currentTarget. |
+ * data | null |
+ * target | The Object that dispatched the event;
+ * it is not always the Object listening for the event. Use the
+ * currentTarget property to always access the Object
+ * listening for the event. |
+ *
+ *
+ * @eventType starling.events.Event.CHANGE
+ */
+ [Event(name="change",type="starling.events.Event")]
+
+ /**
+ * Dispatched when the current screen is removed and there is no active
+ * screen.
+ *
+ * The properties of the event object have the following values:
+ *
+ * | Property | Value |
|---|
+ * bubbles | false |
+ * currentTarget | The Object that defines the
+ * event listener that handles the event. For example, if you use
+ * myButton.addEventListener() to register an event listener,
+ * myButton is the value of the currentTarget. |
+ * data | null |
+ * target | The Object that dispatched the event;
+ * it is not always the Object listening for the event. Use the
+ * currentTarget property to always access the Object
+ * listening for the event. |
+ *
+ *
+ * @eventType feathers.events.FeathersEventType.CLEAR
+ */
+ [Event(name="clear",type="starling.events.Event")]
+
+ /**
+ * Dispatched when the transition between screens begins.
+ *
+ * The properties of the event object have the following values:
+ *
+ * | Property | Value |
|---|
+ * bubbles | false |
+ * currentTarget | The Object that defines the
+ * event listener that handles the event. For example, if you use
+ * myButton.addEventListener() to register an event listener,
+ * myButton is the value of the currentTarget. |
+ * data | null |
+ * target | The Object that dispatched the event;
+ * it is not always the Object listening for the event. Use the
+ * currentTarget property to always access the Object
+ * listening for the event. |
+ *
+ *
+ * @eventType feathers.events.FeathersEventType.TRANSITION_START
+ */
+ [Event(name="transitionStart",type="starling.events.Event")]
+
+ /**
+ * Dispatched when the transition between screens has completed.
+ *
+ * The properties of the event object have the following values:
+ *
+ * | Property | Value |
|---|
+ * bubbles | false |
+ * currentTarget | The Object that defines the
+ * event listener that handles the event. For example, if you use
+ * myButton.addEventListener() to register an event listener,
+ * myButton is the value of the currentTarget. |
+ * data | null |
+ * target | The Object that dispatched the event;
+ * it is not always the Object listening for the event. Use the
+ * currentTarget property to always access the Object
+ * listening for the event. |
+ *
+ *
+ * @eventType feathers.events.FeathersEventType.TRANSITION_COMPLETE
+ */
+ [Event(name="transitionComplete",type="starling.events.Event")]
+
+ /**
+ * A base class for screen navigator components that isn't meant to be
+ * instantiated directly. It should only be subclassed.
+ *
+ * @see feathers.controls.StackScreenNavigator
+ * @see feathers.controls.ScreenNavigator
+ */
+ public class BaseScreenNavigator extends FeathersControl
+ {
+ /**
+ * @private
+ */
+ protected static var SIGNAL_TYPE:Class;
+
+ /**
+ * The screen navigator will auto size itself to fill the entire stage.
+ *
+ * @see #autoSizeMode
+ */
+ public static const AUTO_SIZE_MODE_STAGE:String = "stage";
+
+ /**
+ * The screen navigator will auto size itself to fit its content.
+ *
+ * @see #autoSizeMode
+ */
+ public static const AUTO_SIZE_MODE_CONTENT:String = "content";
+
+ /**
+ * The default transition function.
+ */
+ protected static function defaultTransition(oldScreen:DisplayObject, newScreen:DisplayObject, completeCallback:Function):void
+ {
+ //in short, do nothing
+ completeCallback();
+ }
+
+ /**
+ * Constructor.
+ */
+ public function BaseScreenNavigator()
+ {
+ super();
+ if(Object(this).constructor == BaseScreenNavigator)
+ {
+ throw new Error(FeathersControl.ABSTRACT_CLASS_ERROR);
+ }
+ if(!SIGNAL_TYPE)
+ {
+ try
+ {
+ SIGNAL_TYPE = Class(getDefinitionByName("org.osflash.signals.ISignal"));
+ }
+ catch(error:Error)
+ {
+ //signals not being used
+ }
+ }
+ }
+
+ /**
+ * @private
+ */
+ protected var _activeScreenID:String;
+
+ /**
+ * The string identifier for the currently active screen.
+ */
+ public function get activeScreenID():String
+ {
+ return this._activeScreenID;
+ }
+
+ /**
+ * @private
+ */
+ protected var _activeScreen:DisplayObject;
+
+ /**
+ * A reference to the currently active screen.
+ */
+ public function get activeScreen():DisplayObject
+ {
+ return this._activeScreen;
+ }
+
+ /**
+ * @private
+ */
+ protected var _screens:Object = {};
+
+ /**
+ * @private
+ */
+ protected var _previousScreenInTransitionID:String;
+
+ /**
+ * @private
+ */
+ protected var _previousScreenInTransition:DisplayObject;
+
+ /**
+ * @private
+ */
+ protected var _nextScreenID:String = null;
+
+ /**
+ * @private
+ */
+ protected var _nextScreenTransition:Function = null;
+
+ /**
+ * @private
+ */
+ protected var _clearAfterTransition:Boolean = false;
+
+ /**
+ * @private
+ */
+ protected var _clipContent:Boolean = false;
+
+ /**
+ * Determines if the navigator's content should be clipped to the width
+ * and height.
+ *
+ * In the following example, clipping is enabled:
+ *
+ *
+ * navigator.clipContent = true;
+ *
+ * @default false
+ */
+ public function get clipContent():Boolean
+ {
+ return this._clipContent;
+ }
+
+ /**
+ * @private
+ */
+ public function set clipContent(value:Boolean):void
+ {
+ if(this._clipContent == value)
+ {
+ return;
+ }
+ this._clipContent = value;
+ this.invalidate(INVALIDATION_FLAG_STYLES);
+ }
+
+ /**
+ * @private
+ */
+ protected var _autoSizeMode:String = AUTO_SIZE_MODE_STAGE;
+
+ [Inspectable(type="String",enumeration="stage,content")]
+ /**
+ * Determines how the screen navigator will set its own size when its
+ * dimensions (width and height) aren't set explicitly.
+ *
+ * In the following example, the screen navigator will be sized to
+ * match its content:
+ *
+ *
+ * navigator.autoSizeMode = ScreenNavigator.AUTO_SIZE_MODE_CONTENT;
+ *
+ * @default ScreenNavigator.AUTO_SIZE_MODE_STAGE
+ *
+ * @see #AUTO_SIZE_MODE_STAGE
+ * @see #AUTO_SIZE_MODE_CONTENT
+ */
+ public function get autoSizeMode():String
+ {
+ return this._autoSizeMode;
+ }
+
+ /**
+ * @private
+ */
+ public function set autoSizeMode(value:String):void
+ {
+ if(this._autoSizeMode == value)
+ {
+ return;
+ }
+ this._autoSizeMode = value;
+ if(this._activeScreen)
+ {
+ if(this._autoSizeMode == AUTO_SIZE_MODE_CONTENT)
+ {
+ this._activeScreen.addEventListener(Event.RESIZE, activeScreen_resizeHandler);
+ }
+ else
+ {
+ this._activeScreen.removeEventListener(Event.RESIZE, activeScreen_resizeHandler);
+ }
+ }
+ this.invalidate(INVALIDATION_FLAG_SIZE);
+ }
+
+ /**
+ * @private
+ */
+ protected var _waitingTransition:Function;
+
+ /**
+ * @private
+ */
+ private var _waitingForTransitionFrameCount:int = 1;
+
+ /**
+ * @private
+ */
+ protected var _isTransitionActive:Boolean = false;
+
+ /**
+ * Indicates whether the screen navigator is currently transitioning
+ * between screens.
+ */
+ public function get isTransitionActive():Boolean
+ {
+ return this._isTransitionActive;
+ }
+
+ /**
+ * @private
+ */
+ override public function dispose():void
+ {
+ this.clearScreenInternal();
+ super.dispose();
+ }
+
+ /**
+ * Removes all screens that were added with addScreen().
+ *
+ * @see #addScreen()
+ */
+ public function removeAllScreens():void
+ {
+ if(this._isTransitionActive)
+ {
+ throw new IllegalOperationError("Cannot remove all screens while a transition is active.");
+ }
+ if(this._activeScreen)
+ {
+ this.clearScreenInternal(defaultTransition);
+ this.dispatchEventWith(FeathersEventType.CLEAR);
+ }
+ for(var id:String in this._screens)
+ {
+ delete this._screens[id];
+ }
+ }
+
+ /**
+ * Determines if the specified screen identifier has been added with
+ * addScreen().
+ *
+ * @see #addScreen()
+ */
+ public function hasScreen(id:String):Boolean
+ {
+ return this._screens.hasOwnProperty(id);
+ }
+
+ /**
+ * Returns a list of the screen identifiers that have been added.
+ */
+ public function getScreenIDs(result:Vector. = null):Vector.
+ {
+ if(result)
+ {
+ result.length = 0;
+ }
+ else
+ {
+ result = new [];
+ }
+ var pushIndex:int = 0;
+ for(var id:String in this._screens)
+ {
+ result[pushIndex] = id;
+ pushIndex++;
+ }
+ return result;
+ }
+
+ /**
+ * @private
+ */
+ override protected function draw():void
+ {
+ var sizeInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_SIZE);
+ var selectionInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_SELECTED);
+ var stylesInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_STYLES);
+
+ sizeInvalid = this.autoSizeIfNeeded() || sizeInvalid;
+
+ if(sizeInvalid || selectionInvalid)
+ {
+ if(this._activeScreen)
+ {
+ if(this._activeScreen.width != this.actualWidth)
+ {
+ this._activeScreen.width = this.actualWidth;
+ }
+ if(this._activeScreen.height != this.actualHeight)
+ {
+ this._activeScreen.height = this.actualHeight;
+ }
+ }
+ }
+
+ if(stylesInvalid || sizeInvalid)
+ {
+ if(this._clipContent)
+ {
+ var clipRect:Rectangle = this.clipRect;
+ if(!clipRect)
+ {
+ clipRect = new Rectangle();
+ }
+ clipRect.width = this.actualWidth;
+ clipRect.height = this.actualHeight;
+ this.clipRect = clipRect;
+ }
+ else
+ {
+ this.clipRect = null;
+ }
+ }
+ }
+
+ /**
+ * If the component's dimensions have not been set explicitly, it will
+ * measure its content and determine an ideal size for itself. If the
+ * explicitWidth or explicitHeight member
+ * variables are set, those value will be used without additional
+ * measurement. If one is set, but not the other, the dimension with the
+ * explicit value will not be measured, but the other non-explicit
+ * dimension will still need measurement.
+ *
+ * Calls setSizeInternal() to set up the
+ * actualWidth and actualHeight member
+ * variables used for layout.
+ *
+ * Meant for internal use, and subclasses may override this function
+ * with a custom implementation.
+ */
+ protected function autoSizeIfNeeded():Boolean
+ {
+ var needsWidth:Boolean = this.explicitWidth !== this.explicitWidth; //isNaN
+ var needsHeight:Boolean = this.explicitHeight !== this.explicitHeight; //isNaN
+ if(!needsWidth && !needsHeight)
+ {
+ return false;
+ }
+
+ if((this._autoSizeMode == AUTO_SIZE_MODE_CONTENT || !this.stage) &&
+ this._activeScreen is IValidating)
+ {
+ IValidating(this._activeScreen).validate();
+ }
+
+ var newWidth:Number = this.explicitWidth;
+ if(needsWidth)
+ {
+ if(this._autoSizeMode == AUTO_SIZE_MODE_CONTENT || !this.stage)
+ {
+ newWidth = this._activeScreen ? this._activeScreen.width : 0;
+ }
+ else
+ {
+ newWidth = this.stage.stageWidth;
+ }
+ }
+
+ var newHeight:Number = this.explicitHeight;
+ if(needsHeight)
+ {
+ if(this._autoSizeMode == AUTO_SIZE_MODE_CONTENT || !this.stage)
+ {
+ newHeight = this._activeScreen ? this._activeScreen.height : 0;
+ }
+ else
+ {
+ newHeight = this.stage.stageHeight;
+ }
+ }
+
+ return this.setSizeInternal(newWidth, newHeight, false);
+ }
+
+ /**
+ * @private
+ */
+ protected function addScreenInternal(id:String, item:IScreenNavigatorItem):void
+ {
+ if(this._screens.hasOwnProperty(id))
+ {
+ throw new ArgumentError("Screen with id '" + id + "' already defined. Cannot add two screens with the same id.");
+ }
+ this._screens[id] = item;
+ }
+
+ /**
+ * @private
+ */
+ protected function removeScreenInternal(id:String):IScreenNavigatorItem
+ {
+ if(!this._screens.hasOwnProperty(id))
+ {
+ throw new ArgumentError("Screen '" + id + "' cannot be removed because it has not been added.");
+ }
+ if(this._isTransitionActive && (id == this._previousScreenInTransitionID || id == this._activeScreenID))
+ {
+ throw new IllegalOperationError("Cannot remove a screen while it is transitioning in or out.")
+ }
+ if(this._activeScreenID == id)
+ {
+ //if someone meant to have a transition, they would have called
+ //clearScreen()
+ this.clearScreenInternal(defaultTransition);
+ this.dispatchEventWith(FeathersEventType.CLEAR);
+ }
+ var item:IScreenNavigatorItem = IScreenNavigatorItem(this._screens[id]);
+ delete this._screens[id];
+ return item;
+ }
+
+ /**
+ * @private
+ */
+ protected function showScreenInternal(id:String, transition:Function, properties:Object = null):DisplayObject
+ {
+ if(!this.hasScreen(id))
+ {
+ throw new ArgumentError("Screen with id '" + id + "' cannot be shown because it has not been defined.");
+ }
+
+ if(this._isTransitionActive)
+ {
+ this._nextScreenID = id;
+ this._nextScreenTransition = transition;
+ this._clearAfterTransition = false;
+ return null;
+ }
+
+ if(this._activeScreenID == id)
+ {
+ return this._activeScreen;
+ }
+
+ this._previousScreenInTransition = this._activeScreen;
+ this._previousScreenInTransitionID = this._activeScreenID;
+ if(this._activeScreen)
+ {
+ this.clearScreenInternal();
+ }
+
+ this._isTransitionActive = true;
+
+ var item:IScreenNavigatorItem = IScreenNavigatorItem(this._screens[id]);
+ this._activeScreen = item.getScreen();
+ this._activeScreenID = id;
+ for(var propertyName:String in properties)
+ {
+ this._activeScreen[propertyName] = properties[propertyName];
+ }
+ if(this._activeScreen is IScreen)
+ {
+ var screen:IScreen = IScreen(this._activeScreen);
+ screen.screenID = this._activeScreenID;
+ screen.owner = this; //subclasses will implement the interface
+ }
+ if(this._autoSizeMode == AUTO_SIZE_MODE_CONTENT || !this.stage)
+ {
+ this._activeScreen.addEventListener(Event.RESIZE, activeScreen_resizeHandler);
+ }
+ this.prepareActiveScreen();
+ this.addChild(this._activeScreen);
+
+ this.invalidate(INVALIDATION_FLAG_SELECTED);
+ if(this._validationQueue && !this._validationQueue.isValidating)
+ {
+ //force a COMPLETE validation of everything
+ //but only if we're not already doing that...
+ this._validationQueue.advanceTime(0);
+ }
+ else if(!this._isValidating)
+ {
+ this.validate();
+ }
+
+ this.dispatchEventWith(FeathersEventType.TRANSITION_START);
+ this._activeScreen.dispatchEventWith(FeathersEventType.TRANSITION_IN_START);
+ if(this._previousScreenInTransition)
+ {
+ this._previousScreenInTransition.dispatchEventWith(FeathersEventType.TRANSITION_OUT_START);
+ }
+ if(transition != null)
+ {
+ //temporarily make the active screen invisible because the
+ //transition doesn't start right away.
+ this._activeScreen.visible = false;
+ this._waitingForTransitionFrameCount = 0;
+ this._waitingTransition = transition;
+ //this is a workaround for an issue with transition performance.
+ //see the comment in the listener for details.
+ this.addEventListener(Event.ENTER_FRAME, waitingForTransition_enterFrameHandler);
+ }
+ else
+ {
+ defaultTransition(this._previousScreenInTransition, this._activeScreen, transitionComplete);
+ }
+
+ this.dispatchEventWith(Event.CHANGE);
+ return this._activeScreen;
+ }
+
+ /**
+ * @private
+ */
+ protected function clearScreenInternal(transition:Function = null):void
+ {
+ if(!this._activeScreen)
+ {
+ //no screen visible.
+ return;
+ }
+
+ if(this._isTransitionActive)
+ {
+ this._nextScreenID = null;
+ this._clearAfterTransition = true;
+ this._nextScreenTransition = transition;
+ return;
+ }
+
+ this.cleanupActiveScreen();
+
+ if(transition != null)
+ {
+ this._isTransitionActive = true;
+ this._previousScreenInTransition = this._activeScreen;
+ this._previousScreenInTransitionID = this._activeScreenID;
+ }
+ this._activeScreen = null;
+ this._activeScreenID = null;
+ if(transition !== null)
+ {
+ this.dispatchEventWith(FeathersEventType.TRANSITION_START);
+ this._previousScreenInTransition.dispatchEventWith(FeathersEventType.TRANSITION_OUT_START);
+
+ this._waitingForTransitionFrameCount = 0;
+ this._waitingTransition = transition;
+ //this is a workaround for an issue with transition performance.
+ //see the comment in the listener for details.
+ this.addEventListener(Event.ENTER_FRAME, waitingForTransition_enterFrameHandler);
+ }
+ this.invalidate(INVALIDATION_FLAG_SELECTED);
+ }
+
+ /**
+ * @private
+ */
+ protected function prepareActiveScreen():void
+ {
+ throw new AbstractMethodError();
+ }
+
+ /**
+ * @private
+ */
+ protected function cleanupActiveScreen():void
+ {
+ throw new AbstractMethodError();
+ }
+
+ /**
+ * @private
+ */
+ protected function transitionComplete(cancelTransition:Boolean = false):void
+ {
+ this._isTransitionActive = false;
+ if(cancelTransition)
+ {
+ if(this._activeScreen)
+ {
+ var item:IScreenNavigatorItem = IScreenNavigatorItem(this._screens[this._activeScreenID]);
+ this.clearScreenInternal();
+ this.removeChild(this._activeScreen, item.canDispose);
+ }
+ this._activeScreen = this._previousScreenInTransition;
+ this._activeScreenID = this._previousScreenInTransitionID;
+ this._previousScreenInTransition = null;
+ this._previousScreenInTransitionID = null;
+ this.prepareActiveScreen();
+ this.dispatchEventWith(FeathersEventType.TRANSITION_CANCEL);
+ }
+ else
+ {
+ if(this._previousScreenInTransition)
+ {
+ this._previousScreenInTransition.dispatchEventWith(FeathersEventType.TRANSITION_OUT_COMPLETE)
+ }
+ if(this._activeScreen)
+ {
+ this._activeScreen.dispatchEventWith(FeathersEventType.TRANSITION_IN_COMPLETE)
+ }
+ this.dispatchEventWith(FeathersEventType.TRANSITION_COMPLETE);
+ if(this._previousScreenInTransition)
+ {
+ item = IScreenNavigatorItem(this._screens[this._previousScreenInTransitionID]);
+ if(this._previousScreenInTransition is IScreen)
+ {
+ var screen:IScreen = IScreen(this._previousScreenInTransition);
+ screen.screenID = null;
+ screen.owner = null;
+ }
+ this._previousScreenInTransition.removeEventListener(Event.RESIZE, activeScreen_resizeHandler);
+ this.removeChild(this._previousScreenInTransition, item.canDispose);
+ this._previousScreenInTransition = null;
+ this._previousScreenInTransitionID = null;
+ }
+ }
+
+ if(this._clearAfterTransition)
+ {
+ this.clearScreenInternal(this._nextScreenTransition);
+ }
+ else if(this._nextScreenID)
+ {
+ this.showScreenInternal(this._nextScreenID, this._nextScreenTransition);
+ }
+
+ this._nextScreenID = null;
+ this._nextScreenTransition = null;
+ this._clearAfterTransition = false;
+ }
+
+ /**
+ * @private
+ */
+ protected function screenNavigator_addedToStageHandler(event:Event):void
+ {
+ this.stage.addEventListener(Event.RESIZE, stage_resizeHandler);
+ }
+
+ /**
+ * @private
+ */
+ protected function screenNavigator_removedFromStageHandler(event:Event):void
+ {
+ this.stage.removeEventListener(Event.RESIZE, stage_resizeHandler);
+ }
+
+ /**
+ * @private
+ */
+ protected function activeScreen_resizeHandler(event:Event):void
+ {
+ if(this._isValidating || this._autoSizeMode != AUTO_SIZE_MODE_CONTENT)
+ {
+ return;
+ }
+ this.invalidate(INVALIDATION_FLAG_SIZE);
+ }
+
+ /**
+ * @private
+ */
+ protected function stage_resizeHandler(event:Event):void
+ {
+ this.invalidate(INVALIDATION_FLAG_SIZE);
+ }
+
+ /**
+ * @private
+ */
+ private function waitingForTransition_enterFrameHandler(event:Event):void
+ {
+ //we need to wait a couple of frames before we can start the
+ //transition to make it as smooth as possible. this feels a little
+ //hacky, to be honest, but I can't figure out why waiting only one
+ //frame won't do the trick. the delay is so small though that it's
+ //virtually impossible to notice.
+ if(this._waitingForTransitionFrameCount < 2)
+ {
+ this._waitingForTransitionFrameCount++;
+ return;
+ }
+ this.removeEventListener(Event.ENTER_FRAME, waitingForTransition_enterFrameHandler);
+ if(this._activeScreen)
+ {
+ this._activeScreen.visible = true;
+ }
+
+ var transition:Function = this._waitingTransition;
+ this._waitingTransition = null;
+ transition(this._previousScreenInTransition, this._activeScreen, transitionComplete);
+ }
+ }
+}
diff --git a/source/feathers/controls/supportClasses/GroupedListDataViewPort.as b/source/feathers/controls/supportClasses/GroupedListDataViewPort.as
new file mode 100644
index 0000000000..499eaab9ee
--- /dev/null
+++ b/source/feathers/controls/supportClasses/GroupedListDataViewPort.as
@@ -0,0 +1,2782 @@
+/*
+Feathers
+Copyright 2012-2014 Joshua Tynjala. All Rights Reserved.
+
+This program is free software. You can redistribute and/or modify it in
+accordance with the terms of the accompanying license agreement.
+*/
+package feathers.controls.supportClasses
+{
+ import feathers.controls.GroupedList;
+ import feathers.controls.Scroller;
+ import feathers.controls.renderers.IGroupedListHeaderOrFooterRenderer;
+ import feathers.controls.renderers.IGroupedListItemRenderer;
+ import feathers.core.FeathersControl;
+ import feathers.core.IFeathersControl;
+ import feathers.core.PropertyProxy;
+ import feathers.data.HierarchicalCollection;
+ import feathers.events.CollectionEventType;
+ import feathers.events.FeathersEventType;
+ import feathers.layout.ILayout;
+ import feathers.layout.IVariableVirtualLayout;
+ import feathers.layout.IVirtualLayout;
+ import feathers.layout.LayoutBoundsResult;
+ import feathers.layout.ViewPortBounds;
+
+ import flash.errors.IllegalOperationError;
+ import flash.geom.Point;
+ import flash.utils.Dictionary;
+
+ import starling.display.DisplayObject;
+ import starling.events.Event;
+ import starling.events.Touch;
+ import starling.events.TouchEvent;
+ import starling.events.TouchPhase;
+
+ /**
+ * @private
+ * Used internally by GroupedList. Not meant to be used on its own.
+ */
+ public class GroupedListDataViewPort extends FeathersControl implements IViewPort
+ {
+ private static const INVALIDATION_FLAG_ITEM_RENDERER_FACTORY:String = "itemRendererFactory";
+
+ private static const HELPER_POINT:Point = new Point();
+ private static const HELPER_VECTOR:Vector. = new [];
+
+ public function GroupedListDataViewPort()
+ {
+ super();
+ this.addEventListener(TouchEvent.TOUCH, touchHandler);
+ this.addEventListener(Event.REMOVED_FROM_STAGE, removedFromStageHandler);
+ }
+
+ private var touchPointID:int = -1;
+
+ private var _viewPortBounds:ViewPortBounds = new ViewPortBounds();
+
+ private var _layoutResult:LayoutBoundsResult = new LayoutBoundsResult();
+
+ private var _minVisibleWidth:Number = 0;
+
+ public function get minVisibleWidth():Number
+ {
+ return this._minVisibleWidth;
+ }
+
+ public function set minVisibleWidth(value:Number):void
+ {
+ if(this._minVisibleWidth == value)
+ {
+ return;
+ }
+ if(value !== value) //isNaN
+ {
+ throw new ArgumentError("minVisibleWidth cannot be NaN");
+ }
+ this._minVisibleWidth = value;
+ this.invalidate(INVALIDATION_FLAG_SIZE);
+ }
+
+ private var _maxVisibleWidth:Number = Number.POSITIVE_INFINITY;
+
+ public function get maxVisibleWidth():Number
+ {
+ return this._maxVisibleWidth;
+ }
+
+ public function set maxVisibleWidth(value:Number):void
+ {
+ if(this._maxVisibleWidth == value)
+ {
+ return;
+ }
+ if(value !== value) //isNaN
+ {
+ throw new ArgumentError("maxVisibleWidth cannot be NaN");
+ }
+ this._maxVisibleWidth = value;
+ this.invalidate(INVALIDATION_FLAG_SIZE);
+ }
+
+ private var actualVisibleWidth:Number = NaN;
+
+ private var explicitVisibleWidth:Number = NaN;
+
+ public function get visibleWidth():Number
+ {
+ return this.actualVisibleWidth;
+ }
+
+ public function set visibleWidth(value:Number):void
+ {
+ if(this.explicitVisibleWidth == value ||
+ (value !== value && this.explicitVisibleWidth !== this.explicitVisibleWidth)) //isNaN
+ {
+ return;
+ }
+ this.explicitVisibleWidth = value;
+ this.invalidate(INVALIDATION_FLAG_SIZE);
+ }
+
+ private var _minVisibleHeight:Number = 0;
+
+ public function get minVisibleHeight():Number
+ {
+ return this._minVisibleHeight;
+ }
+
+ public function set minVisibleHeight(value:Number):void
+ {
+ if(this._minVisibleHeight == value)
+ {
+ return;
+ }
+ if(value !== value) //isNaN
+ {
+ throw new ArgumentError("minVisibleHeight cannot be NaN");
+ }
+ this._minVisibleHeight = value;
+ this.invalidate(INVALIDATION_FLAG_SIZE);
+ }
+
+ private var _maxVisibleHeight:Number = Number.POSITIVE_INFINITY;
+
+ public function get maxVisibleHeight():Number
+ {
+ return this._maxVisibleHeight;
+ }
+
+ public function set maxVisibleHeight(value:Number):void
+ {
+ if(this._maxVisibleHeight == value)
+ {
+ return;
+ }
+ if(value !== value) //isNaN
+ {
+ throw new ArgumentError("maxVisibleHeight cannot be NaN");
+ }
+ this._maxVisibleHeight = value;
+ this.invalidate(INVALIDATION_FLAG_SIZE);
+ }
+
+ private var actualVisibleHeight:Number;
+
+ private var explicitVisibleHeight:Number = NaN;
+
+ public function get visibleHeight():Number
+ {
+ return this.actualVisibleHeight;
+ }
+
+ public function set visibleHeight(value:Number):void
+ {
+ if(this.explicitVisibleHeight == value ||
+ (value !== value && this.explicitVisibleHeight !== this.explicitVisibleHeight)) //isNaN
+ {
+ return;
+ }
+ this.explicitVisibleHeight = value;
+ this.invalidate(INVALIDATION_FLAG_SIZE);
+ }
+
+ protected var _contentX:Number = 0;
+
+ public function get contentX():Number
+ {
+ return this._contentX;
+ }
+
+ protected var _contentY:Number = 0;
+
+ public function get contentY():Number
+ {
+ return this._contentY;
+ }
+
+ public function get horizontalScrollStep():Number
+ {
+ var renderers:Vector. = this._activeItemRenderers;
+ if(!renderers || renderers.length == 0)
+ {
+ renderers = this._activeFirstItemRenderers;
+ }
+ if(!renderers || renderers.length == 0)
+ {
+ renderers = this._activeLastItemRenderers;
+ }
+ if(!renderers || renderers.length == 0)
+ {
+ renderers = this._activeSingleItemRenderers;
+ }
+ if(!renderers || renderers.length == 0)
+ {
+ return 0;
+ }
+ var itemRenderer:IGroupedListItemRenderer = renderers[0];
+ var itemRendererWidth:Number = itemRenderer.width;
+ var itemRendererHeight:Number = itemRenderer.height;
+ if(itemRendererWidth < itemRendererHeight)
+ {
+ return itemRendererWidth;
+ }
+ return itemRendererHeight;
+ }
+
+ public function get verticalScrollStep():Number
+ {
+ var renderers:Vector. = this._activeItemRenderers;
+ if(!renderers || renderers.length == 0)
+ {
+ renderers = this._activeFirstItemRenderers;
+ }
+ if(!renderers || renderers.length == 0)
+ {
+ renderers = this._activeLastItemRenderers;
+ }
+ if(!renderers || renderers.length == 0)
+ {
+ renderers = this._activeSingleItemRenderers;
+ }
+ if(!renderers || renderers.length == 0)
+ {
+ return 0;
+ }
+ var itemRenderer:IGroupedListItemRenderer = renderers[0];
+ var itemRendererWidth:Number = itemRenderer.width;
+ var itemRendererHeight:Number = itemRenderer.height;
+ if(itemRendererWidth < itemRendererHeight)
+ {
+ return itemRendererWidth;
+ }
+ return itemRendererHeight;
+ }
+
+ private var _layoutItems:Vector. = new [];
+
+ private var _typicalItemIsInDataProvider:Boolean = false;
+ private var _typicalItemRenderer:IGroupedListItemRenderer;
+
+ private var _unrenderedItems:Vector.