student-ar-fl-core-UIComponent.ax [swf] flex
Dispatched after the component is moved. @eventType fl.events.ComponentEvent.MOVE @includeExample examples/@ax-student-ar-fl-core-UIComponent.MOVE.1.as -noswf @langversion 3.0 @playerversion Flash 9.0.28.0
Dispatched after the component is resized. @eventType fl.events.ComponentEvent.RESIZE @includeExample examples/@ax-student-ar-fl-core-UIComponent.RESIZE.1.as -noswf @langversion 3.0 @playerversion Flash 9.0.28.0
Dispatched after the component visibility changes from invisible to visible. @eventType fl.events.ComponentEvent.SHOW @includeExample examples/@ax-student-ar-fl-core-UIComponent.HIDE.1.as -noswf
see: #event:hide @langversion 3.0 @playerversion Flash 9.0.28.0
Dispatched after the component visibility changes from visible to invisible. @eventType fl.events.ComponentEvent.HIDE @includeExample examples/@ax-student-ar-fl-core-UIComponent.HIDE.1.as -noswf
see: #event:show @langversion 3.0 @playerversion Flash 9.0.28.0
The skin to be used to display focus indicators. @default focusRectSkin @langversion 3.0 @playerversion Flash 9.0.28.0
The padding that separates the outside boundaries of the component from the outside edges of the focus indicator, in pixels. @default 2 @langversion 3.0 @playerversion Flash 9.0.28.0
The TextFormat object to use to render the component label. @default TextFormat("_sans", 11, 0x000000, false, false, false, '', '', TextFormatAlign.LEFT, 0, 0, 0, 0) @langversion 3.0 @playerversion Flash 9.0.28.0
The TextFormat object to use to render the component label when the button is disabled. @default TextFormat("_sans", 11, 0x999999, false, false, false, '', '', TextFormatAlign.LEFT, 0, 0, 0, 0) @langversion 3.0 @playerversion Flash 9.0.28.0
The @ax-student-ar-fl-core-UIComponent class is the base class for all visual components, both interactive and noninteractive. Interactive components are defined as components that receive user input such as keyboard or mouse activity. Noninteractive components are used to display data; they do not respond to user interaction. The ProgressBar and UILoader components are examples of noninteractive components. <p>The Tab and arrow keys can be used to move focus to and over an interactive component; an interactive component can accept low-level events such as input from mouse and keyboard devices. An interactive component can also be disabled so that it cannot receive mouse and keyboard input.</p> @langversion 3.0 @playerversion Flash 9.0.28.0
The version number of the components. @includeExample examples/@ax-student-ar-fl-core-UIComponent.version.1.as -noswf @langversion 3.0 @playerversion Flash 9.0.28.0
@private (internal) Indicates whether the current execution stack is within a call later phase. @default false @langversion 3.0 @playerversion Flash 9.0.28.0
@private Used when components are nested, and we want the parent component to handle draw focus, not the child. @default null @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
@private (testing) @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
@private @langversion 3.0 @playerversion Flash 9.0.28.0
@private @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected)
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
@private @langversion 3.0 @playerversion Flash 9.0.28.0
@private @langversion 3.0 @playerversion Flash 9.0.28.0
Retrieves the default style map for the current component. The style map contains the type that is appropriate for the component, depending on the style that the component uses. For example, the <code>disabledTextFormat</code> style contains a value of <code>null</code> or a TextFormat object. You can use these styles and call <code>setStyle()</code> on the current component. The following code overrides the default <code>disabledTextFormat</code> style on the specified component: <listing>componentInstance.setStyle("disabledTextFormat", new TextFormat());</listing>
returns: Default styles object. @includeExample examples/@ax-student-ar-fl-core-UIComponent.getStyleDefinition.1.as -noswf
see: #getStyle()
see: #setStyle()
see: fl.managers.StyleManager StyleManager @internal [kenos] This is vague. What are "these styles" that you can use "and call setStyle on the current component"? @langversion 3.0 @playerversion Flash 9.0.28.0
Merges the styles from multiple classes into one object. If a style is defined in multiple objects, the first occurrence that is found is used.
parameter: list A comma-delimited list of objects that contain the default styles to be merged.
returns: A default style object that contains the merged styles. @langversion 3.0 @playerversion Flash 9.0.28.0
@private @internal (Placeholder for mixin by @fileAccImpl) Creates the Accessibility class to be associated with the current component. @langversion 3.0 @playerversion Flash 9.0.28.0
Creates a new @ax-student-ar-fl-core-UIComponent component instance. @langversion 3.0 @playerversion Flash 9.0.28.0
@private (internal) @langversion 3.0 @playerversion Flash 9.0.28.0
@private (setter) @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
Gets or sets a value that indicates whether the component can accept user interaction. A value of <code>true</code> indicates that the component can accept user interaction; a value of <code>false</code> indicates that it cannot. <p>If you set the <code>enabled</code> property to <code>false</code>, the color of the container is dimmed and user input is blocked (with the exception of the Label and ProgressBar components).</p> @default true @langversion 3.0 @playerversion Flash 9.0.28.0
@private (setter) @langversion 3.0 @playerversion Flash 9.0.28.0
Sets the component to the specified width and height.
parameter: width The width of the component, in pixels.
parameter: height The height of the component, in pixels. @langversion 3.0 @playerversion Flash 9.0.28.0
Gets or sets the width of the component, in pixels. <p>Setting this property causes a <code>resize</code> event to be dispatched. See the <code>resize</code> event for detailed information about when it is dispatched.</p> <p>If the <code>scaleX</code> property of the component is not 1.0, the width of the component that is obtained from its internal coordinates will not match the width value from the parent coordinates. For example, a component that is 100 pixels in width and has a <code>scaleX</code> of 2 has a value of 100 pixels in the parent, but internally stores a value indicating that it is 50 pixels wide.</p>
see: #height
see: #event:resize @langversion 3.0 @playerversion Flash 9.0.28.0
@private (setter) @langversion 3.0 @playerversion Flash 9.0.28.0
Gets or sets the height of the component, in pixels. <p>Setting this property causes a <code>resize</code> event to be dispatched. See the <code>resize</code> event for detailed information about when it is dispatched.</p> <p>If the <code>scaleY</code> property of the component is not 1.0, the height of the component that is obtained from its internal coordinates will not match the height value from the parent coordinates. For example, a component that is 100 pixels in height and has a <code>scaleY</code> of 2 has a value of 100 pixels in the parent, but internally stores a value indicating that it is 50 pixels in height.</p> @langversion 3.0 @playerversion Flash 9.0.28.0
@private (setter) @langversion 3.0 @playerversion Flash 9.0.28.0
Sets a style property on this component instance. This style may override a style that was set globally. <p>Calling this method can result in decreased performance. Use it only when necessary.</p>
parameter: style The name of the style property.
parameter: value The value of the style. @includeExample examples/@ax-student-ar-fl-core-UIComponent.setStyle.1.as -noswf @includeExample examples/@ax-student-ar-fl-core-UIComponent.setStyle.2.as -noswf
see: #getStyle()
see: #clearStyle() @langversion 3.0 @playerversion Flash 9.0.28.0
Deletes a style property from this component instance. <p>This does not necessarily cause the <code>getStyle()</code> method to return a value of <code>undefined</code>.</p>
parameter: style The name of the style property.
see: #getStyle()
see: #setStyle() @langversion 3.0 @playerversion Flash 9.0.28.0
Retrieves a style property that is set in the style lookup chain of the component. <p>The type that this method returns varies depending on the style property that the method retrieves. The range of possible types includes Boolean; String; Number; int; a uint for an RGB color; a Class for a skin; or any kind of object.</p> <p>If you call this method to retrieve a particular style property, it will be of a known type that you can store in a variable of the same type. Type casting is not necessary. Instead, a simple assignment statement like the following will work:</p> <listing>var backgroundColor:uint = getStyle("backgroundColor");</listing> <p>If the style property is not set in the style lookup chain, this method returns a value of <code>undefined</code>. Note that <code>undefined</code> is a special value that is not the same as <code>false</code>, "", <code>NaN</code>, 0, or <code>null</code>. No valid style value is ever <code>undefined</code>. You can use the static method <code>StyleManager.isValidStyleValue()</code> to test whether a value was set.</p>
parameter: style The name of the style property.
returns: Style value. @includeExample examples/@ax-student-ar-fl-core-UIComponent.getStyle.1.as -noswf
see: #clearStyle()
see: #setStyle() @langversion 3.0 @playerversion Flash 9.0.28.0
Moves the component to the specified position within its parent. This has the same effect as changing the component location by setting its <code>x</code> and <code>y</code> properties. Calling this method triggers the <code>ComponentEvent.MOVE</code> event to be dispatched. <p>To override the <code>updateDisplayList()</code> method in a custom component, use the <code>move()</code> method instead of setting the <code>x</code> and <code>y</code> properties. This is because a call to the <code>move()</code> method causes a <code>move</code> event object to be dispatched immediately after the move operation is complete. In contrast, when you change the component location by setting the <code>x</code> and <code>y</code> properties, the event object is dispatched on the next screen refresh.</p>
parameter: x The x coordinate value that specifies the position of the component within its parent, in pixels. This value is calculated from the left.
parameter: y The y coordinate value that specifies the position of the component within its parent, in pixels. This value is calculated from the top.
see: #x
see: #y @langversion 3.0 @playerversion Flash 9.0.28.0
Gets or sets the x coordinate that represents the position of the component along the x axis within its parent container. This value is described in pixels and is calculated from the left. <p>Setting this property causes the <code>ComponentEvent.MOVE</code> event to be dispatched.</p> @default 0
see: #move()
see: #y @langversion 3.0 @playerversion Flash 9.0.28.0
@private (setter) @langversion 3.0 @playerversion Flash 9.0.28.0
Gets or sets the y coordinate that represents the position of the component along the y axis within its parent container. This value is described in pixels and is calculated from the top. <p>Setting this property causes the <code>move</code> event to be dispatched.</p>
see: #move()
see: #x @langversion 3.0 @playerversion Flash 9.0.28.0 @internal [kenos] Should this have a default value of 0, like the x property?
@private (setter) @langversion 3.0 @playerversion Flash 9.0.28.0
Multiplies the current width of the component by a scale factor.
see: #scaleY @langversion 3.0 @playerversion Flash 9.0.28.0
@private (setter) @langversion 3.0 @playerversion Flash 9.0.28.0
Multiplies the current height of the component by a scale factor.
see: #scaleX @langversion 3.0 @playerversion Flash 9.0.28.0
@private (setter) @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
@private (setter) @langversion 3.0 @playerversion Flash 9.0.28.0
Gets or sets a value that indicates whether the current component instance is visible. A value of <code>true</code> indicates that the current component is visible; a value of <code>false</code> indicates that it is not. <p>When this property is set to <code>true</code>, the object dispatches a <code>show</code> event. When this property is set to <code>false</code>, the object dispatches a <code>hide</code> event. In either case, the children of the object do not generate a <code>show</code> or <code>hide</code> event unless the object specifically writes an implementation to do so.</p> @default true
see: #event:hide
see: #event:show @langversion 3.0 @playerversion Flash 9.0.28.0
@private (setter) @langversion 3.0 @playerversion Flash 9.0.28.0
Validates and updates the properties and layout of this object, redrawing it if necessary. <p>Properties that require substantial computation are normally not processed until the script finishes executing. This is because setting one property could require the processing of other properties. For example, setting the <code>width</code> property may require that the widths of the children or parent of the object also be recalculated. And if the script recalculates the width of the object more than once, these interdependent properties may also require recalculating. Use this method to manually override this behavior.</p> @langversion 3.0 @playerversion Flash 9.0.28.0
Marks a property as invalid and redraws the component on the next frame unless otherwise specified.
parameter: property The property to be invalidated.
parameter: callLater A Boolean value that indicates whether the component should be redrawn on the next frame. The default value is <code>true</code>. @langversion 3.0 @playerversion Flash 9.0.28.0
@private (internal) Sets the inherited style value to the specified style name and invalidates the styles of the component.
parameter: name Style name.
parameter: style Style value. @langversion 3.0 @playerversion Flash 9.0.28.0
Gets or sets a Boolean value that indicates whether the component can receive focus after the user clicks it. A value of <code>true</code> indicates that it can receive focus; a value of <code>false</code> indicates that it cannot. <p>If this property is <code>false</code>, focus is transferred to the first parent whose <code>mouseFocusEnabled</code> property is set to <code>true</code>.</p> @default true
see: #mouseFocusEnabled @langversion 3.0 @playerversion Flash 9.0.28.0 @internal [kenos] This is described as being the same thing as the property below. Is this correct?
@private (setter) @langversion 3.0 @playerversion Flash 9.0.28.0
Gets or sets a value that indicates whether the component can receive focus after the user clicks it. A value of <code>true</code> indicates that it can receive focus; a value of <code>false</code> indicates that it cannot. <p>If this property is <code>false</code>, focus is transferred to the first parent whose <code>mouseFocusEnabled</code> property is set to <code>true</code>.</p> @default true
see: #focusEnabled @langversion 3.0 @playerversion Flash 9.0.28.0
@private (setter) @langversion 3.0 @playerversion Flash 9.0.28.0
Gets or sets the FocusManager that controls focus for this component and its peers. Each pop-up component maintains its own focus loop and FocusManager instance. Use this property to access the correct FocusManager for this component.
returns: The FocusManager that is associated with the current component; otherwise this property returns <code>null</code>. @langversion 3.0 @playerversion Flash 9.0.28.0
@private (setter) @langversion 3.0 @playerversion Flash 9.0.28.0
Shows or hides the focus indicator on this component. <p>The @ax-student-ar-fl-core-UIComponent class implements this method by creating and positioning an instance of the class that is specified by the <code>focusSkin</code> style.</p>
parameter: focused Indicates whether to show or hide the focus indicator. If this value is <code>true</code>, the focus indicator is shown; if this value is <code>false</code>, the focus indicator is hidden. @langversion 3.0 @playerversion Flash 9.0.28.0
Sets the focus to this component. The component may in turn give the focus to a subcomponent. <p><strong>Note:</strong> Only the TextInput and TextArea components show a focus indicator when this method sets the focus. All components show a focus indicator when the user tabs to the component.</p> @langversion 3.0 @playerversion Flash 9.0.28.0
Retrieves the object that currently has focus. <p>Note that this method does not necessarily return the component that has focus. It may return the internal subcomponent of the component that has focus. To get the component that has focus, use the <code>focusManager.focus</code> property.</p>
returns: The object that has focus; otherwise, this method returnsnull
. @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
Initiates an immediate draw operation, without invalidating everything as <code>invalidateNow</code> does. @internal what is "invalidateNow"? i cannot find it in the API. @internal [kenos] Additionally, is the immediate draw operation on this component and does invalidating "everything" mean invalidating the entire component? @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
Returns the specified style for a component, considering all styles set on the global level, component level and instance level. <p>For example, if a component has a style set at the global level to <code>myStyle</code> and you call <code>getStyle("myStyle")</code> on an instance that does not have an instance setting, it returns null. If you call <code>getStyleValue("myStyle")</code>, it returns "myStyle", because it is active at the global level.</p> @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
@private @langversion 3.0 @playerversion Flash 9.0.28.0
@private @langversion 3.0 @playerversion Flash 9.0.28.0
@private @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) Triggers initialization of this component's accessibility code. <p>This method is called from the constructor via ENTER_FRAME event to initialize accessibility support for this component</p> @langversion 3.0 @playerversion Flash 9.0.28.0
@private (protected) Initializes this component's accessibility code. <p>This method is called from the constructor to hook in the component's accessibility code, which resides in a separate class in the fl.accessibility package. Each subclass that supports accessibility must override this method because the hook-in process uses a different static variable in each subclass.</p> @langversion 3.0 @playerversion Flash 9.0.28.0
(C) Æliens 27/08/2009
You may not copy or print any of this material without explicit permission of the author or the publisher. In case of other copyright issues, contact the author.