Package | feathers.controls |
Class | public class AutoComplete |
Inheritance | AutoComplete TextInput FeathersControl starling.display.Sprite |
Product Version : | Feathers 2.1.0 |
The following example creates an AutoComplete
with a
local collection of suggestions:
var input:AutoComplete = new AutoComplete(); input.source = new LocalAutoCompleteSource( new VectorCollection(new <String> [ "Apple", "Banana", "Cherry", "Grape", "Lemon", "Orange", "Watermelon" ])); this.addChild( input );
See also
Property | Defined By | ||
---|---|---|---|
addedEffect : Function
An optional effect that is activated when the component is added to
the stage. | FeathersControl | ||
autoCompleteDelay : Number
The time, in seconds, after the text has changed before requesting
suggestions from the IAutoCompleteSource. | AutoComplete | ||
baseline : Number [read-only]
The baseline measurement of the text, in pixels. | TextInput | ||
currentState : String [read-only]
The current state of the text input. | TextInput | ||
defaultTextEditorFactory : Function [static]
A function used by all UI controls that support text editor to
create an ITextEditor instance. | FeathersControl | ||
defaultTextRendererFactory : Function [static]
A function used by all UI controls that support text renderers to
create an ITextRenderer instance. | FeathersControl | ||
depth : int [read-only]
The component's depth in the display list, relative to the stage. | FeathersControl | ||
displayAsPassword : Boolean
Determines if the entered text will be masked so that it cannot be
seen, such as for a password input. | TextInput | ||
effectsSuspended : Boolean [read-only]
Indicates if effects have been suspended. | FeathersControl | ||
errorString : String
Error text to display in a Callout when the input has
focus. | TextInput | ||
explicitHeight : Number [read-only]
The height value explicitly set by passing a value to the
height setter or by calling the setSize()
function. | FeathersControl | ||
explicitMaxHeight : Number [read-only]
The maximum height value explicitly set by passing a value to the
maxHeight setter. | FeathersControl | ||
explicitMaxWidth : Number [read-only]
The maximum width value explicitly set by passing a value to the
maxWidth setter. | FeathersControl | ||
explicitMinHeight : Number [read-only]
The minimum height value explicitly set by passing a value to the
minHeight setter. | FeathersControl | ||
explicitMinWidth : Number [read-only]
The minimum width value explicitly set by passing a value to the
minWidth setter. | FeathersControl | ||
explicitWidth : Number [read-only]
The width value explicitly set by passing a value to the
width setter or to the setSize() method. | FeathersControl | ||
focusInEffect : Function
An optional effect that is activated when the component receives
focus. | FeathersControl | ||
focusManager : IFocusManager
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The current focus manager for this component. | FeathersControl | ||
focusOutEffect : Function
An optional effect that is activated when the component loses focus. | FeathersControl | ||
focusOwner : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
Used for associating focusable display objects that are not direct
children with an "owner" focusable display object, such as pop-ups. | FeathersControl | ||
globalStyleProvider : IStyleProvider [static]
The default IStyleProvider for all
AutoComplete components. | AutoComplete | ||
hasFocus : Boolean [read-only]
When the FocusManager isn't enabled, hasFocus
can be used instead of FocusManager.focus == textInput
to determine if the text input has focus. | TextInput | ||
height : Number [override]
The height of the component, in pixels. | FeathersControl | ||
hideEffect : Function
An optional effect that is activated when the component is hidden. | FeathersControl | ||
includeInLayout : Boolean
Determines if the ILayout should use this object or ignore it. | FeathersControl | ||
isCreated : Boolean [read-only]
Determines if the component has been initialized and validated for
the first time. | FeathersControl | ||
isEditable : Boolean
Determines if the text input is editable. | TextInput | ||
isEnabled : Boolean
Indicates whether the control is interactive or not. | FeathersControl | ||
isFocusEnabled : Boolean
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
Determines if this component can receive focus. | FeathersControl | ||
isInitialized : Boolean [read-only]
Determines if the component has been initialized yet. | FeathersControl | ||
isQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list. | FeathersControl | ||
isSelectable : Boolean
If the isEditable property is set to false,
the isSelectable property determines if the text is
selectable. | TextInput | ||
isShowingFocus : Boolean [read-only]
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
Indicates if the showFocus() method has been called on
the object when it has focus. | FeathersControl | ||
layoutData : ILayoutData
Extra parameters associated with this display object that will be
used by the layout algorithm. | FeathersControl | ||
listFactory : Function
A function used to generate the pop-up list sub-component. | AutoComplete | ||
listProperties : Object
An object that stores properties for the auto-complete's pop-up list
sub-component, and the properties will be passed down to the pop-up
list when the auto-complete validates. | AutoComplete | ||
maintainTouchFocus : Boolean [read-only]
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
If true, the display object should remain in focus,
even if something else is touched. | FeathersControl | ||
maxChars : int
The maximum number of characters that may be entered. | TextInput | ||
maxHeight : Number
The maximum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | ||
maxWidth : Number
The maximum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | ||
minHeight : Number
The minimum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | ||
minimumAutoCompleteLength : Number
The minimum number of entered characters required to request
suggestions from the IAutoCompleteSource. | AutoComplete | ||
minTouchHeight : Number
If using isQuickHitAreaEnabled, and the hit area's
height is smaller than this value, it will be expanded. | FeathersControl | ||
minTouchWidth : Number
If using isQuickHitAreaEnabled, and the hit area's
width is smaller than this value, it will be expanded. | FeathersControl | ||
minWidth : Number
The minimum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | ||
moveEffect : Function
An optional effect that is activated when the component is moved to
a new position. | FeathersControl | ||
nativeFocus : Object [read-only]
A text editor may be an INativeFocusOwner, so we need to
return the value of its nativeFocus property. | TextInput | ||
nextDownFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.DOWN is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | ||
nextLeftFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.LEFT is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | ||
nextRightFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.RIGHT is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | ||
nextTabFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when the tab key is pressed
when a focus manager is enabled. | FeathersControl | ||
nextUpFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.UP is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | ||
previousTabFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The previous object that will receive focus when the tab key is
pressed while holding shift when a focus manager is enabled. | FeathersControl | ||
prompt : String
The prompt, hint, or description text displayed by the input when the
value of its text is empty. | TextInput | ||
promptFactory : Function
A function used to instantiate the prompt text renderer. | TextInput | ||
promptProperties : Object
An object that stores properties for the input's prompt text
renderer sub-component, and the properties will be passed down to the
text renderer when the input validates. | TextInput | ||
resizeEffect : Function
An optional effect that is activated when the component is resized
with new dimensions. | FeathersControl | ||
restrict : String
Limits the set of characters that may be entered. | TextInput | ||
selectionBeginIndex : int [read-only]
The index of the first character of the selection. | TextInput | ||
selectionEndIndex : int [read-only]
The index of the last character of the selection. | TextInput | ||
showEffect : Function
An optional effect that is activated when the component is shown. | FeathersControl | ||
source : IAutoCompleteSource
The source of the suggestions that appear in the pop-up list. | AutoComplete | ||
styleName : String
The concatenated styleNameList, with values separated
by spaces. | FeathersControl | ||
styleNameList : TokenList [read-only]
Contains a list of all "styles" assigned to this control. | FeathersControl | ||
styleProvider : IStyleProvider
When a component initializes, a style provider may be used to set
properties that affect the component's visual appearance. | FeathersControl | ||
text : String
The text displayed by the text input. | TextInput | ||
textEditorFactory : Function
A function used to instantiate the text editor. | TextInput | ||
textEditorProperties : Object
An object that stores properties for the input's text editor
sub-component, and the properties will be passed down to the
text editor when the input validates. | TextInput | ||
toolTip : String
Text to display in a tool tip to when hovering over this component,
if the ToolTipManager is enabled. | FeathersControl | ||
width : Number [override]
The width of the component, in pixels. | FeathersControl |
Property | Defined By | ||
---|---|---|---|
actualHeight : Number = 0
The final height value that should be used for layout. | FeathersControl | ||
actualMinHeight : Number = 0
The final minimum height value that should be used for layout. | FeathersControl | ||
actualMinWidth : Number = 0
The final minimum width value that should be used for layout. | FeathersControl | ||
actualWidth : Number = 0
The final width value that should be used for layout. | FeathersControl | ||
callout : TextCallout
The TextCallout that displays the value of the
errorString property. | TextInput | ||
currentBackground : DisplayObject
The currently selected background, based on state. | TextInput | ||
currentIcon : DisplayObject
The currently visible icon. | TextInput | ||
defaultStyleProvider : IStyleProvider [read-only]
When the FeathersControl constructor is called, the
styleProvider property is set to this value. | FeathersControl | ||
errorCalloutStyleName : String = "feathers-text-input-error-callout"
The value added to the styleNameList of the error
callout. | TextInput | ||
list : List
The list sub-component. | AutoComplete | ||
listStyleName : String = "feathers-auto-complete-list"
The default value added to the styleNameList of the
pop-up list. | AutoComplete | ||
promptStyleName : String = "feathers-text-input-prompt"
The value added to the styleNameList of the prompt text
renderer. | TextInput | ||
promptTextRenderer : ITextRenderer
The prompt text renderer sub-component. | TextInput | ||
textEditor : ITextEditor
The text editor sub-component. | TextInput | ||
textEditorStyleName : String = "feathers-text-input-text-editor"
The value added to the styleNameList of the text editor. | TextInput |
Method | Defined By | ||
---|---|---|---|
Constructor. | AutoComplete | ||
clearFocus():void
Manually removes focus from the text input control. | TextInput | ||
closeList():void
Closes the pop-up list, if it is open. | AutoComplete | ||
dispose():void [override]
Disposes the display object. | AutoComplete | ||
getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle [override]
Feathers components use an optimized getBounds()
implementation that may sometimes behave differently than regular
Starling display objects. | FeathersControl | ||
getFontStylesForState(state:String):TextFormat
Gets the font styles to be used to display the input's text when the
input's currentState property matches the specified
state value. | TextInput | ||
getIconForState(state:String):DisplayObject
Gets the icon to be used by the text input when the input's
currentState property matches the specified state value. | TextInput | ||
getPromptFontStylesForState(state:String):TextFormat
Gets the font styles to be used to display the input's prompt when
the input's currentState property matches the specified
state value. | TextInput | ||
getSkinForState(state:String):DisplayObject
Gets the skin to be used by the text input when the input's
currentState property matches the specified state value. | TextInput | ||
hideFocus():void
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
| FeathersControl | ||
initializeNow():void
If the component has not yet initialized, initializes immediately. | FeathersControl | ||
invalidate(flag:String):void
Call this function to tell the UI control that a redraw is pending. | FeathersControl | ||
isInvalid(flag:String = null):Boolean
Indicates whether the control is pending validation or not. | FeathersControl | ||
move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single
function call. | FeathersControl | ||
openList():void
Opens the pop-up list, if it isn't already open. | AutoComplete | ||
removeFromParentWithEffect(effect:Function, dispose:Boolean = false):void
Plays an effect before removing the component from its parent. | FeathersControl | ||
resetStyleProvider():void
Resets the styleProvider property to its default value,
which is usually the global style provider for the component. | FeathersControl | ||
resumeEffects():void
Indicates that effects should be re-activated after being suspended. | FeathersControl | ||
selectRange(beginIndex:int, endIndex:int = -1):void
Sets the range of selected characters. | TextInput | ||
setFocus():void
Focuses the text input control so that it may be edited, and selects
all of its text. | TextInput | ||
setFontStylesForState(state:String, format:TextFormat):void
Sets the font styles to be used to display the input's text when the
input's currentState property matches the specified
state value. | TextInput | ||
setIconForState(state:String, icon:DisplayObject):void
Sets the icon to be used by the text input when the input's
currentState property matches the specified state value. | TextInput | ||
setPromptFontStylesForState(state:String, format:TextFormat):void
Sets the font styles to be used to display the input's prompt when
the input's currentState property matches the specified
state value. | TextInput | ||
setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single
function call. | FeathersControl | ||
setSkinForState(state:String, skin:DisplayObject):void
Sets the skin to be used by the text input when the input's
currentState property matches the specified state value. | TextInput | ||
showFocus():void
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
| FeathersControl | ||
suspendEffects():void
Indicates that effects should not be activated temporarily. | FeathersControl | ||
validate():void
Immediately validates the display object, if it is invalid. | FeathersControl |
Method | Defined By | ||
---|---|---|---|
autoSizeIfNeeded():Boolean
If the component's dimensions have not been set explicitly, it will
measure its content and determine an ideal size for itself. | TextInput | ||
clearInvalidationFlag(flag:String):void
Clears an invalidation flag. | FeathersControl | ||
createList():void
Creates and adds the list sub-component and
removes the old instance, if one exists. | AutoComplete | ||
createTextEditor():void
Creates and adds the textEditor sub-component and
removes the old instance, if one exists. | TextInput | ||
draw():void
Override to customize layout and to adjust properties of children. | FeathersControl | ||
focusInHandler(event:Event):void
Default event handler for FeathersEventType.FOCUS_IN
that may be overridden in subclasses to perform additional actions
when the component receives focus. | FeathersControl | ||
focusOutHandler(event:Event):void
Default event handler for FeathersEventType.FOCUS_OUT
that may be overridden in subclasses to perform additional actions
when the component loses focus. | FeathersControl | ||
ignoreNextStyleRestriction():void
The next style that is set will not be restricted. | FeathersControl | ||
initialize():void
Called the first time that the UI control is added to the stage, and
you should override this function to customize the initialization
process. | FeathersControl | ||
layoutChildren():void
Positions and sizes the text input's children. | TextInput | ||
processStyleRestriction(key:Object):Boolean
Used by setters for properties that are considered "styles" to
determine if the setter has been called directly on the component or
from a style provider. | FeathersControl | ||
refreshBackgroundSkin():void
Sets the currentBackground property. | TextInput | ||
refreshFocusIndicator():void
Updates the focus indicator skin by showing or hiding it and
adjusting its position and dimensions. | FeathersControl | ||
refreshIcon():void
Sets the currentIcon property. | TextInput | ||
saveMeasurements(width:Number, height:Number, minWidth:Number = 0, minHeight:Number = 0):Boolean
Saves the dimensions and minimum dimensions calculated for the
component. | FeathersControl | ||
setInvalidationFlag(flag:String):void
Sets an invalidation flag. | FeathersControl | ||
setSizeInternal(width:Number, height:Number, canInvalidate:Boolean):Boolean
Sets the width and height of the control, with the option of
invalidating or not. | FeathersControl |
Event | Summary | Defined By | ||
---|---|---|---|---|
Dispatched when the text input's text property changes. | TextInput | |||
Dispatched when the pop-up list is closed. | AutoComplete | |||
Dispatched after the component has validated for the first time. | FeathersControl | |||
Dispatched when the user presses the Enter key while the text input has focus. | TextInput | |||
Dispatched when the text input receives focus. | TextInput | |||
Dispatched when the text input loses focus. | TextInput | |||
Dispatched after initialize() has been called, but before the first time that draw() has been called. | FeathersControl | |||
Dispatched when the pop-up list is opened. | AutoComplete | |||
Dispatched when the width or height of the control changes. | FeathersControl | |||
Dispatched when the soft keyboard is activated by the text editor. | TextInput | |||
Dispatched when the soft keyboard is about the be activated by the text editor. | TextInput | |||
Dispatched when the soft keyboard is deactivated by the text editor. | TextInput | |||
Dispatched when the display object's state changes. | TextInput |
Style | Defined By | ||
---|---|---|---|
backgroundDisabledSkin : DisplayObject The skin used for the input's disabled state. | TextInput | ||
backgroundEnabledSkin : DisplayObject The skin used for the input's enabled state. | TextInput | ||
backgroundErrorSkin : DisplayObject The skin used for the input's error state. | TextInput | ||
backgroundFocusedSkin : DisplayObject The skin used for the input's focused state. | TextInput | ||
backgroundSkin : DisplayObject The skin used when no other skin is defined for the current state. | TextInput | ||
customErrorCalloutStyleName : String A style name to add to the text input's error callout sub-component. | TextInput | ||
customListStyleName : String A style name to add to the list sub-component of the AutoComplete. | AutoComplete | ||
customPromptStyleName : String A style name to add to the text input's prompt text renderer sub-component. | TextInput | ||
customTextEditorStyleName : String A style name to add to the text input's text editor sub-component. | TextInput | ||
defaultIcon : DisplayObject The icon used when no other icon is defined for the current state. | TextInput | ||
disabledFontStyles : TextFormat The font styles used to display the input's text when the input is disabled. | TextInput | ||
disabledIcon : DisplayObject The icon used for the input's disabled state. | TextInput | ||
enabledIcon : DisplayObject The icon used for the input's enabled state. | TextInput | ||
errorIcon : DisplayObject The icon used for the input's error state. | TextInput | ||
focusedIcon : DisplayObject The icon used for the input's focused state. | TextInput | ||
focusIndicatorSkin : DisplayObject If this component supports focus, this optional skin will be displayed above the component when showFocus() is called. | FeathersControl | ||
focusPadding : Number Quickly sets all focus padding properties to the same value. | FeathersControl | ||
focusPaddingBottom : Number The minimum space, in pixels, between the object's bottom edge and the bottom edge of the focus indicator skin. | FeathersControl | ||
focusPaddingLeft : Number The minimum space, in pixels, between the object's left edge and the left edge of the focus indicator skin. | FeathersControl | ||
focusPaddingRight : Number The minimum space, in pixels, between the object's right edge and the right edge of the focus indicator skin. | FeathersControl | ||
focusPaddingTop : Number The minimum space, in pixels, between the object's top edge and the top edge of the focus indicator skin. | FeathersControl | ||
fontStyles : TextFormat The font styles used to display the input's text. | TextInput | ||
gap : Number The space, in pixels, between the icon and the text editor, if an icon exists. | TextInput | ||
iconPosition : String The location of the icon, relative to the text renderer. | TextInput | ||
padding : Number Quickly sets all padding properties to the same value. | TextInput | ||
paddingBottom : Number The minimum space, in pixels, between the input's bottom edge and the input's content. | TextInput | ||
paddingLeft : Number The minimum space, in pixels, between the input's left edge and the input's content. | TextInput | ||
paddingRight : Number The minimum space, in pixels, between the input's right edge and the input's content. | TextInput | ||
paddingTop : Number The minimum space, in pixels, between the input's top edge and the input's content. | TextInput | ||
popUpContentManager : IPopUpContentManager A manager that handles the details of how to display the pop-up list. | AutoComplete | ||
promptDisabledFontStyles : TextFormat The font styles used to display the input's prompt when the input is disabled. | TextInput | ||
promptFontStyles : TextFormat The font styles used to display the input's prompt text. | TextInput | ||
typicalText : String If not null, the dimensions of the typicalText will be used in the calculation of the text input's full dimensions. | TextInput | ||
verticalAlign : String The location where the text editor is aligned vertically (on the y-axis). | TextInput |
Constant | Defined By | ||
---|---|---|---|
ALTERNATE_STYLE_NAME_SEARCH_TEXT_INPUT : String = "feathers-search-text-input" [static]
An alternate style name to use with TextInput to allow a
theme to give it a search input style. | TextInput | ||
DEFAULT_CHILD_STYLE_NAME_ERROR_CALLOUT : String = "feathers-text-input-error-callout" [static]
The default value added to the styleNameList of the
error callout. | TextInput | ||
DEFAULT_CHILD_STYLE_NAME_LIST : String = "feathers-auto-complete-list" [static]
The default value added to the styleNameList of the pop-up
list. | AutoComplete | ||
DEFAULT_CHILD_STYLE_NAME_PROMPT : String = "feathers-text-input-prompt" [static]
The default value added to the styleNameList of the
prompt text renderer. | TextInput | ||
DEFAULT_CHILD_STYLE_NAME_TEXT_EDITOR : String = "feathers-text-input-text-editor" [static]
The default value added to the styleNameList of the text
editor. | TextInput | ||
INVALIDATION_FLAG_ALL : String = "all" [static]
Flag to indicate that everything is invalid and should be redrawn. | FeathersControl | ||
INVALIDATION_FLAG_DATA : String = "data" [static]
Invalidation flag to indicate that the primary data displayed by the
UI control has changed. | FeathersControl | ||
INVALIDATION_FLAG_FOCUS : String = "focus" [static]
Invalidation flag to indicate that the focus of the UI control has
changed. | FeathersControl | ||
INVALIDATION_FLAG_LAYOUT : String = "layout" [static]
Invalidation flag to indicate that the layout of the UI control has
changed. | FeathersControl | ||
INVALIDATION_FLAG_SCROLL : String = "scroll" [static]
Invalidation flag to indicate that the scroll position of the UI
control has changed. | FeathersControl | ||
INVALIDATION_FLAG_SELECTED : String = "selected" [static]
Invalidation flag to indicate that the selection of the UI control
has changed. | FeathersControl | ||
INVALIDATION_FLAG_SIZE : String = "size" [static]
Invalidation flag to indicate that the dimensions of the UI control
have changed. | FeathersControl | ||
INVALIDATION_FLAG_SKIN : String = "skin" [static]
Invalidation flag to indicate that the skin of the UI control has changed. | FeathersControl | ||
INVALIDATION_FLAG_STATE : String = "state" [static]
Invalidation flag to indicate that the state has changed. | FeathersControl | ||
INVALIDATION_FLAG_STYLES : String = "styles" [static]
Invalidation flag to indicate that the styles or visual appearance of
the UI control has changed. | FeathersControl |
autoCompleteDelay | property |
autoCompleteDelay:Number
The time, in seconds, after the text has changed before requesting
suggestions from the IAutoCompleteSource
.
In the following example, the delay is changed to 1.5 seconds:
input.autoCompleteDelay = 1.5;
The default value is 0.5
.
public function get autoCompleteDelay():Number
public function set autoCompleteDelay(value:Number):void
See also
globalStyleProvider | property |
public static var globalStyleProvider:IStyleProvider
The default IStyleProvider
for all
AutoComplete
components. If null
, falls
back to using TextInput.globalStyleProvider
instead.
The default value is null
.
See also
list | property |
listFactory | property |
listFactory:Function
A function used to generate the pop-up list sub-component. The list
must be an instance of List
. This factory can be used to
change properties on the list 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 list.
The function should have the following signature:
function():List
In the following example, a custom list factory is passed to the
AutoComplete
:
input.listFactory = function():List { var popUpList:List = new List(); popUpList.backgroundSkin = new Image( texture ); return popUpList; };
The default value is null
.
public function get listFactory():Function
public function set listFactory(value:Function):void
See also
listProperties | property |
listProperties:Object
An object that stores properties for the auto-complete's pop-up list
sub-component, and the properties will be passed down to the pop-up
list when the auto-complete validates. For a list of available
properties, refer to
feathers.controls.List
.
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 listFactory
function
instead of using listProperties
will result in better
performance.
In the following example, the list properties are passed to the auto complete:
input.listProperties.backgroundSkin = new Image( texture );
The default value is null
.
public function get listProperties():Object
public function set listProperties(value:Object):void
See also
listStyleName | property |
protected var listStyleName:String = "feathers-auto-complete-list"
The default value added to the styleNameList
of the
pop-up list. This variable is protected
so that
sub-classes can customize the list style name in their constructors
instead of using the default style name defined by
DEFAULT_CHILD_STYLE_NAME_LIST
.
To customize the pop-up list name without subclassing, see
customListStyleName
.
See also
minimumAutoCompleteLength | property |
minimumAutoCompleteLength:Number
The minimum number of entered characters required to request
suggestions from the IAutoCompleteSource
.
In the following example, the minimum number of characters is
changed to 3
:
input.minimumAutoCompleteLength = 3;
The default value is 2
.
public function get minimumAutoCompleteLength():Number
public function set minimumAutoCompleteLength(value:Number):void
See also
source | property |
source:IAutoCompleteSource
The source of the suggestions that appear in the pop-up list.
In the following example, a source of suggestions is provided:
input.source = new LocalAutoCompleteSource( new VectorCollection(new <String> [ "Apple", "Banana", "Cherry", "Grape", "Lemon", "Orange", "Watermelon" ]));
The default value is null
.
public function get source():IAutoCompleteSource
public function set source(value:IAutoCompleteSource):void
AutoComplete | () | Constructor |
public function AutoComplete()
Constructor.
closeList | () | method |
public function closeList():void
Closes the pop-up list, if it is open.
createList | () | method |
protected function createList():void
Creates and adds the list
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 also
dispose | () | method |
override public function dispose():void
Disposes the display object.
openList | () | method |
public function openList():void
Opens the pop-up list, if it isn't already open.
close | Event |
starling.events.Event
starling.events.Event.CLOSE
Dispatched when the pop-up list is closed.
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. |
open | Event |
starling.events.Event
starling.events.Event.OPEN
Dispatched when the pop-up list is opened.
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. |
popUpContentManager | style |
popUpContentManager:IPopUpContentManager
A manager that handles the details of how to display the pop-up list.
In the following example, a pop-up content manager is provided:
input.popUpContentManager = new CalloutPopUpContentManager();
The default value is null
.
customListStyleName | style |
customListStyleName:String
A style name to add to the list sub-component of the
AutoComplete
. Typically used by a theme to provide
different styles to different AutoComplete
instances.
In the following example, a custom list style name is passed to the
AutoComplete
:
input.customListStyleName = "my-custom-list";
In your theme, you can target this sub-component style name to provide different styles than the default:
getStyleProviderForClass( List ).setFunctionForStyleName( "my-custom-list", setCustomListStyles );
The default value is null
.
See also
DEFAULT_CHILD_STYLE_NAME_LIST | Constant |
public static const DEFAULT_CHILD_STYLE_NAME_LIST:String = "feathers-auto-complete-list"
The default value added to the styleNameList
of the pop-up
list.
See also