mx.core
Class UIComponent
Direct Known Subclasses
           mx.containers.FormHeading, mx.controls.ComboBase, mx.controls.DateChooser, mx.controls.HRule, mx.controls.MediaController, mx.controls.MediaDisplay, mx.controls.MenuBar, mx.controls.NumericStepper, mx.controls.SimpleButton, mx.controls.TextInput, mx.controls.ToolTip, mx.controls.VRule, mx.controls.alertClasses.AlertForm, mx.controls.listclasses.SelectableRow, mx.controls.menuclasses.MenuBarItem, mx.controls.scrollClasses.ScrollBar, mx.core.View, mx.managers.FocusManager

class UIComponent
extends mx.core.UIObject

The UIComponent class is the base class for all Flex components other than the Label and ProgerssBar controls. A UIComponent can participate in tabbing, accept low-level events like keyboard and mouse input, and be disabled so that it does not receive mouse and keyboard input. The UIComponent class is not used as an MXML tag.

Common MXML Syntax Inherited from UIComponent

All user interface components in Flex extend the UIObject class. Flex components inherit the following properties from the UIComponent class. 

 <mx:tagname
   enabled="value"
   tabIndex="value"
   focusIn="value"
   focusOut="value"
   hide="value"
   invalid="value"
   keyDown="value"
   keyUp="value"
   resize="value"
   show="value"
   valid="value"
   valueChanged="value"
   
   >
   ...
     child tags
   ...
 </mx:UIComponent>

See Also
mx.core.UIObject


Methods
      getFocus() : Object
Gets the object that currently has focus.
      getFocusManager() : Object
Gets the current FocusManager.
      setFocus() : Void
Sets the focus to this object.

Methods inherited from class mx.core.UIObject
createAccessibilityImplementation  measure  doLater  cancelAllDoLaters  invalidate  invalidateStyle  invalidateProperties  invalidateSize  redraw  move  setSize  setSizeNoLayout  drawRect  fillRect  destroyLabel  createClassObject  createEmptyObject  destroyObject  getStyle  setMask  swapDepths 


Properties
staticversion:String  
ComponentVersion is for internal use only.
      enabled:Boolean  
Whether the component can accept user interaction.
      tabIndex:Number  
Number that specifies the component`s tabbing order in relation to other components in an application.

Properties inherited from class mx.core.UIObject
version  nestLevel  dispatchEvent  addEventListener  handleEvent  removeEventListener  kStretch  styleName  className  setStyle  parentApplication  isDocument  parentDocument  documentDescriptor  descriptor  instanceIndices  repeaterIndices  getRepeaterItem  id  width  height  x  y  minHeight  minWidth  preferredHeight  preferredWidth  maxHeight  maxWidth  widthFlex  heightFlex  visible  scaleX  scaleY  alpha  depth  mouseX  mouseY  toolTip  baselinePosition 


Effects
showEffectComponent becomes visible.
hideEffectComponent becomes invisible.
focusInEffectComponent gains keyboard focus.
focusOutEffectComponent loses keyboard focus.

Effects inherited from class mx.core.UIObject
creationCompleteEffect  moveEffect  resizeEffect  mouseDownEffect  mouseOverEffect  mouseOutEffect  mouseUpEffect 


Events
focusInBroadcast when an object receives focus. Target contains a reference to the component that triggered the event. Type contains the name of the event.
focusOutBroadcast when an object loses focus. Target contains a reference to the component that triggered the event. Type contains the name of the event.
keyDownBroadcast when a key is pressed. Target contains a reference to the component that triggered the event. Type contains the name of the event.
keyUpBroadcast when a key is released. Target contains a reference to the component that triggered the event. Type contains the name of the event.
showBroadcast when the component becomes visible. Target contains a reference to the component that triggered the event. Type contains the name of the event.
hideBroadcast when an object`s state changes from visible to invisible. Target contains a reference to the component that triggered the event. Type contains the name of the event.
validCalled internally by Flex or by component authors. Target contains a reference to the component that triggered the event. Type contains the name of the event.
invalidBroadcast when objects should be redrawn on the screen. This is called internally by Flex or by component authors. Target contains a reference to the component that triggered the event. Type contains the name of the event.
valueCommittedBroadcast when values are changed programmatically. Target contains a reference to the component that triggered the event. Type contains the name of the event.

Events inherited from class: mx.core.UIObject
initialize  creationComplete  resize  move  draw  load  unload  mouseDown  mouseUp  mouseMove  mouseOver  mouseOut  mouseDownSomewhere  mouseUpSomewhere  mouseMoveSomewhere  mouseChangeSomewhere  effectStart  effectEnd  dragBegin  dragComplete  dragEnter  dragOver  dragExit  dragDrop 


Styles
backgroundColor Type: Number   Format: Color   CSS Inheritance: yes
Background color of the List. This style is defined on a class style declaration.
backgroundDisabledColor Type: Number   Format: Color   CSS Inheritance: yes
Background color of DataGrid, List, Tree, and Menu components when disabled. The default value is 0xEFEEEF (light gray).
backgroundImage Type: String   Format: File   CSS Inheritance: no
Background image of a control.
backgroundAlpha Type: Number   CSS Inheritance: no
Alpha level of the SWF file or image defined by backgroundImage. Valid values range from 0 to 100. The default value is 100.
backgroundSize Type: String   CSS Inheritance: no
Scales the image specified by backgroundImage to different percentage sizes. By default, the value is auto, which maintains the original size of the image. A value of 100% stretches the image to fit the entire screen. You must include the percent sign with the value.
barColor Type: Number   Format: Color   CSS Inheritance: yes
Color of the outer bar.
borderCapColor Type: Number   Format: Color   CSS Inheritance: yes
Outside left and outside right color for skins.
borderColor Type: Number   Format: Color   CSS Inheritance: yes
Black section of a three-dimensional border or the color section of a two-dimensional border.
buttonColor Type: Number   Format: Color   CSS Inheritance: yes
Face of a button and a section of the three dimensional border. The default value is 0xEFEEEF (light gray).
borderStyle CSS Inheritance: yes
Bounding box style. The possible values are: "none", "solid", "inset" and "outset". The default value is "inset".
disabledColor Type: Number   Format: Color   CSS Inheritance: yes
Disabled color of the ComboBox.
errorColor Type: Number   Format: Color   CSS Inheritance: yes
Color of the error text.
highlightColor Type: Number   Format: Color   CSS Inheritance: yes
Color of the control when it is in focus.
lineHeight Type: Number   Format: Length   CSS Inheritance: no
Height of the specified line.
modalTransparency Type: Number   CSS Inheritance: yes
Modality is simulated by creating a large transparent window underneath the TitleWindow component. Due to the way transparent windows are rendered, you may notice a slight dimming of the objects under the transparent window. The effective transparency can be set by changing the modalTransparency value from 0 (fully transparent) to 100 (opaque). If you make the window partially transparent, you can also set the color of the window by changing the Modal skin in the default theme.
scrollTrackColor Type: Number   Format: Color   CSS Inheritance: yes
Scroll track for a scroll bar. The default value is 0xEFEEEF (light gray).
shadowColor Type: Number   Format: Color   CSS Inheritance: yes
Bottom inside color of a button`s skin. A section of the three-dimensional border. The default value is 0x848384 (dark gray).
shadowCapColor Type: Number   Format: Color   CSS Inheritance: yes
Left and right inside edges of a button`s skin.
symbolColor Type: Number   Format: Color   CSS Inheritance: yes
The check mark of a check box or the dot of a radio button. The default value is 0x000000 (black).
symbolBackgroundColor Type: Number   Format: Color   CSS Inheritance: yes
Background color of check boxes and radio buttons. The default value is 0xFFFFFF (white).
symbolBackgroundDisabledColor Type: Number   Format: Color   CSS Inheritance: yes
Background color of check boxes and radio buttons when disabled. The default value is 0xEFEEEF (light gray).
symbolBackgroundPressedColor Type: Number   Format: Color   CSS Inheritance: yes
Background color of check boxes and radio buttons when pressed. The default value is 0xFFFFFF (white).
symbolDisabledColor Type: Number   Format: Color   CSS Inheritance: yes
Disabled check mark or radio button dot color. The default value is 0x848384 (dark gray).
themeColor Type: Number   Format: Color   CSS Inheritance: yes
Background of a component. Possible values are "haloGreen", "haloBlue", and "haloOrange".

Styles inherited from class mx.core.UIObject
color  fontFamily  fontSize  fontStyle  fontWeight  textAlign  textDecoration  textIndent  marginLeft  marginRight  horizontalGap  verticalGap 


Method Detail

getFocus

getFocus() : Object

Gets the object that currently has focus. It might not be this object.

Returns
     Object that has focus.

getFocusManager

getFocusManager() : Object

Gets the current FocusManager.

setFocus

setFocus() : Void

Sets the focus to this object.


Property Detail

enabled

enabled:Boolean  

Whether the component can accept user interaction. The default is true.

tabIndex

tabIndex:Number  

Number that specifies the component`s tabbing order in relation to other components in an application.

version

static version:String  

ComponentVersion is for internal use only.