Package | mx.controls.advancedDataGridClasses |
Class | public class AdvancedDataGridItemRenderer |
Inheritance | AdvancedDataGridItemRenderer UITextField FlexTextField flash.text.TextField |
Implements | IDataRenderer, IDropInListItemRenderer, ILayoutManagerClient, IListItemRenderer, IStyleClient |
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
You can override the default item renderer by creating a custom item renderer.
See also
Property | Defined By | ||
---|---|---|---|
automationDelegate : Object
The delegate object which is handling the automation related functionality. | UITextField | ||
automationEnabled : Boolean [read-only]
True if this component is enabled for automation, false
otherwise. | UITextField | ||
automationName : String
Name that can be used as an identifier for this object. | UITextField | ||
automationOwner : DisplayObjectContainer [read-only]
The owner of this component for automation purposes. | UITextField | ||
automationParent : DisplayObjectContainer [read-only]
The parent of this component for automation purposes. | UITextField | ||
automationValue : Array [read-only]
This value generally corresponds to the rendered appearance of the
object and should be usable for correlating the identifier with
the object as it appears visually within the application. | UITextField | ||
automationVisible : Boolean [read-only]
True if this component is visible for automation, false
otherwise. | UITextField | ||
baselinePosition : Number [read-only]
The y-coordinate of the baseline of the first line of text. | UITextField | ||
className : String [read-only]
The name of this instance's class, such as
"DataGridItemRenderer". | UITextField | ||
data : Object
The implementation of the data property as
defined by the IDataRenderer interface. | AdvancedDataGridItemRenderer | ||
document : Object
A reference to the document object associated with this UITextField object. | UITextField | ||
enabled : Boolean
A Boolean value that indicates whether the component is enabled. | UITextField | ||
enableIME : Boolean [read-only]
A flag that indicates whether the IME should
be enabled when the component receives focus. | UITextField | ||
explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates. | UITextField | ||
explicitMaxHeight : Number [read-only]
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates, if the maxHeight property
is set. | UITextField | ||
explicitMaxWidth : Number [read-only]
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates, if the maxWidth property
is set. | UITextField | ||
explicitMinHeight : Number [read-only]
The minimum recommended height of the component to be considered
by the parent during layout. | UITextField | ||
explicitMinWidth : Number [read-only]
The minimum recommended width of the component to be considered
by the parent during layout. | UITextField | ||
explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates. | UITextField | ||
focusPane : Sprite
A single Sprite object that is shared among components
and used as an overlay for drawing the focus indicator. | UITextField | ||
ignorePadding : Boolean
If true, the paddingLeft and
paddingRight styles will not add space
around the text of the component. | UITextField | ||
imeMode : String
Specifies the IME (input method editor) mode. | UITextField | ||
includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container. | UITextField | ||
inheritingStyles : Object
The beginning of this UITextField's chain of inheriting styles. | UITextField | ||
initialized : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required)
| UITextField | ||
isPopUp : Boolean
Set to true by the PopUpManager to indicate
that component has been popped up. | UITextField | ||
listData : BaseListData
The implementation of the listData property as
defined by the IDropInListItemRenderer interface. | AdvancedDataGridItemRenderer | ||
maxHeight : Number [read-only]
The maximum recommended height of the component to be considered
by the parent during layout. | UITextField | ||
maxWidth : Number [read-only]
The maximum recommended width of the component to be considered
by the parent during layout. | UITextField | ||
measuredHeight : Number [read-only]
The default height of the component, in pixels. | UITextField | ||
measuredMinHeight : Number
The default minimum height of the component, in pixels. | UITextField | ||
measuredMinWidth : Number
The default minimum width of the component, in pixels. | UITextField | ||
measuredWidth : Number [read-only]
The default width of the component, in pixels. | UITextField | ||
minHeight : Number [read-only]
The minimum recommended height of the component to be considered
by the parent during layout. | UITextField | ||
minWidth : Number [read-only]
The minimum recommended width of the component to be considered
by the parent during layout. | UITextField | ||
moduleFactory : IFlexModuleFactory
The moduleFactory that is used to create TextFields in the correct SWF context. | UITextField | ||
nestLevel : int
Depth of this object in the containment hierarchy. | UITextField | ||
nonInheritingStyles : Object
The beginning of this UITextField's chain of non-inheriting styles. | UITextField | ||
nonZeroTextHeight : Number [read-only]
Unlike textHeight, this returns a non-zero value
even when the text is empty. | UITextField | ||
owner : DisplayObjectContainer
By default, set to the parent container of this object. | UITextField | ||
parent : DisplayObjectContainer [override] [read-only]
The parent container or component for this component. | UITextField | ||
percentHeight : Number
Specifies the height of a component as a percentage
of its parent's size. | UITextField | ||
percentWidth : Number
Specifies the width of a component as a percentage
of its parent's size. | UITextField | ||
processedDescriptors : Boolean
Set to true after the createChildren()
method creates any internal component children. | UITextField | ||
styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object. | AdvancedDataGridItemRenderer | ||
styleName : Object
The class style used by this component. | UITextField | ||
systemManager : ISystemManager
Returns the SystemManager object used by this component. | UITextField | ||
toolTip : String
Text to display in the ToolTip. | UITextField | ||
tweeningProperties : Array
Array of properties that are currently being tweened on this object. | UITextField | ||
updateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required)
| UITextField |
Method | Defined By | ||
---|---|---|---|
Constructor. | AdvancedDataGridItemRenderer | ||
clearStyle(styleProp:String):void
Deletes a style property from this component instance. | AdvancedDataGridItemRenderer | ||
getClassStyleDeclarations():Array
Finds the type selectors for this UIComponent instance. | AdvancedDataGridItemRenderer | ||
getExplicitOrMeasuredHeight():Number
A convenience method for determining whether to use the
explicit or measured height
| UITextField | ||
getExplicitOrMeasuredWidth():Number
A convenience method for determining whether to use the
explicit or measured width
| UITextField | ||
getStyle(styleProp:String):* [override]
Gets a style property that has been set anywhere in this
component's style lookup chain. | AdvancedDataGridItemRenderer | ||
getTextStyles():TextFormat
Returns the TextFormat object that represents
character formatting information for this UITextField object. | UITextField | ||
Returns a UITextFormat object that contains formatting information for this component. | UITextField | ||
initialize():void
Initializes this component. | UITextField | ||
initProtoChain():void
Sets up the inheritingStyles
and nonInheritingStyles objects
and their proto chains so that the getStyle() method can work. | AdvancedDataGridItemRenderer | ||
invalidateDisplayList():void
Marks a component so that its updateDisplayList()
method gets called during a later screen update. | UITextField | ||
invalidateProperties():void
Marks a component so that its commitProperties()
method gets called during a later screen update. | UITextField | ||
invalidateSize():void
Marks a component so that its measure()
method gets called during a later screen update. | UITextField | ||
move(x:Number, y:Number):void
Moves the component to a specified position within its parent. | UITextField | ||
notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void
Propagates style changes to the children. | AdvancedDataGridItemRenderer | ||
owns(child:DisplayObject):Boolean
Returns true if the child is parented or owned by this object. | UITextField | ||
parentChanged(p:DisplayObjectContainer):void
This function is called when a UITextField object is assigned
a parent. | UITextField | ||
regenerateStyleCache(recursive:Boolean):void
Builds or rebuilds the CSS style cache for this component
and, if the recursive parameter is true,
for all descendants of this component as well. | AdvancedDataGridItemRenderer | ||
registerEffects(effects:Array):void
For each effect event, registers the EffectManager
as one of the event listeners. | AdvancedDataGridItemRenderer | ||
replayAutomatableEvent(event:Event):Boolean
Replays the specified event. | UITextField | ||
setActualSize(w:Number, h:Number):void
Sizes the object. | UITextField | ||
setColor(color:uint):void
Sets the font color of the text. | UITextField | ||
setFocus():void
Sets the focus to this component. | UITextField | ||
setStyle(styleProp:String, newValue:*):void [override]
Sets a style property on this component instance. | AdvancedDataGridItemRenderer | ||
setVisible(visible:Boolean, noEvent:Boolean = false):void
Sets the visible property of this UITextField object. | UITextField | ||
styleChanged(styleProp:String):void
Detects changes to style properties. | UITextField | ||
toString():String [override]
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application. | FlexTextField | ||
truncateToFit(truncationIndicator:String = null):Boolean
Truncate text to make it fit horizontally in the area defined for the control,
and append an ellipsis, three periods (...), to the text. | UITextField | ||
validateDisplayList():void
If Flex calls LayoutManager.invalidateDisplayList()
method on this ILayoutManagerClient instance,
this function is called when it's time to update the display list. | AdvancedDataGridItemRenderer | ||
validateNow():void
Validate and update the properties and layout of this object
and redraw it, if necessary. | UITextField | ||
validateProperties():void
If Flex calls the LayoutManager.invalidateProperties()
method on this ILayoutManagerClient,
this function is called when it's time to commit property values. | AdvancedDataGridItemRenderer | ||
validateSize(recursive:Boolean = false):void
If Flex calls the LayoutManager.invalidateSize()
method on this ILayoutManagerClient,
this function is called when it's time to do measurements. | AdvancedDataGridItemRenderer |
Method | Defined By | ||
---|---|---|---|
toolTipShowHandler(event:ToolTipEvent):void
The event handler to position the tooltip. | AdvancedDataGridItemRenderer |
Event | Summary | Defined By | ||
---|---|---|---|---|
Dispatched when the data property changes. | AdvancedDataGridItemRenderer |
data | property |
data:Object
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
The implementation of the data
property as
defined by the IDataRenderer interface.
The value is ignored. Only the listData
property is used.
This property can be used as the source for data binding.
public function get data():Object
public function set data(value:Object):void
See also
listData | property |
listData:BaseListData
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
The implementation of the listData
property as
defined by the IDropInListItemRenderer interface.
The text of the renderer is set to the label
property of this property.
This property can be used as the source for data binding.
public function get listData():BaseListData
public function set listData(value:BaseListData):void
See also
styleDeclaration | property |
styleDeclaration:CSSStyleDeclaration
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Storage for the inline inheriting styles on this object.
This CSSStyleDeclaration is created the first time that
the setStyle()
method
is called on this component to set an inheriting style.
public function get styleDeclaration():CSSStyleDeclaration
public function set styleDeclaration(value:CSSStyleDeclaration):void
AdvancedDataGridItemRenderer | () | Constructor |
public function AdvancedDataGridItemRenderer()
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Constructor.
clearStyle | () | method |
public function clearStyle(styleProp:String):void
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Deletes a style property from this component instance.
This does not necessarily cause the getStyle()
method
to return undefined
.
Parameters
styleProp:String — The name of the style property.
|
getClassStyleDeclarations | () | method |
public function getClassStyleDeclarations():Array
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Finds the type selectors for this UIComponent instance. The algorithm walks up the superclass chain. For example, suppose that class MyButton extends Button. A MyButton instance first looks for a MyButton type selector then, it looks for a Button type selector. then, it looks for a UIComponent type selector. (The superclass chain is considered to stop at UIComponent, not Object.)
ReturnsArray — An Array of type selectors for this UIComponent instance.
|
getStyle | () | method |
override public function getStyle(styleProp:String):*
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Gets a style property that has been set anywhere in this component's style lookup chain.
This same method is used to get any kind of style property, so the value returned can be a Boolean, String, Number, int, uint (for an RGB color), Class (for a skin), or any kind of object. Therefore the return type is simply specified as *.
If you are getting a particular style property, you know its type and often want to store the result in a variable of that type. No casting from * to that type is necessary.
var backgroundColor:uint = getStyle("backgroundColor");
If the style property has not been set anywhere in the
style lookup chain, the value returned by getStyle()
is undefined
.
Note that undefined
is a special value that is
not the same as false
, ""
,
NaN
, 0
, or null
.
No valid style value is ever undefined
.
You can use the method
IStyleManager2.isValidStyleValue()
to test whether the value was set.
Parameters
styleProp:String — Name of the style property.
|
* — Style value.
|
initProtoChain | () | method |
public function initProtoChain():void
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Sets up the inheritingStyles
and nonInheritingStyles
objects
and their proto chains so that the getStyle()
method can work.
notifyStyleChangeInChildren | () | method |
public function notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Propagates style changes to the children. You typically never need to call this method.
Parameters
styleProp:String — String specifying the name of the style property.
| |
recursive:Boolean — Recursivly notify all children of this component.
|
regenerateStyleCache | () | method |
public function regenerateStyleCache(recursive:Boolean):void
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Builds or rebuilds the CSS style cache for this component
and, if the recursive
parameter is true
,
for all descendants of this component as well.
The Flex framework calls this method in the following situations:
addChild()
or addChildAt()
methods.styleName
property
of a UIComponent.setStyle()
method of CSSStyleDeclaration.Building the style cache is a computation-intensive operation,
so avoid changing styleName
or
setting selector styles unnecessarily.
This method is not called when you set an instance style
by calling the setStyle()
method of UIComponent.
Setting an instance style is a relatively fast operation
compared with setting a selector style.
You do not need to call or override this method.
Parameters
recursive:Boolean — Recursively regenerates the style cache for
all children of this component.
|
registerEffects | () | method |
public function registerEffects(effects:Array):void
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
For each effect event, registers the EffectManager as one of the event listeners. You typically never need to call this method.
Parameters
effects:Array — The names of the effect events.
|
setStyle | () | method |
override public function setStyle(styleProp:String, newValue:*):void
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Sets a style property on this component instance.
This can override a style that was set globally.
Calling the setStyle()
method can result in decreased performance.
Use it only when necessary.
Parameters
styleProp:String — Name of the style property.
| |
newValue:* — New value for the style.
|
toolTipShowHandler | () | method |
protected function toolTipShowHandler(event:ToolTipEvent):void
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
The event handler to position the tooltip.
Parameters
event:ToolTipEvent — The event object.
|
validateDisplayList | () | method |
public function validateDisplayList():void
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
If Flex calls LayoutManager.invalidateDisplayList()
method on this ILayoutManagerClient instance,
this function is called when it's time to update the display list.
validateProperties | () | method |
public function validateProperties():void
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
If Flex calls the LayoutManager.invalidateProperties()
method on this ILayoutManagerClient,
this function is called when it's time to commit property values.
validateSize | () | method |
public function validateSize(recursive:Boolean = false):void
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
If Flex calls the LayoutManager.invalidateSize()
method on this ILayoutManagerClient,
this function is called when it's time to do measurements.
Parameters
recursive:Boolean (default = false ) — If true , call this method
on the object's children.
|
dataChange | Event |
mx.events.FlexEvent
mx.events.FlexEvent.DATA_CHANGE
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Dispatched when the data
property changes.
When you use a component as an item renderer,
the data
property contains the data to display.
You can listen for this event and update the component
when the data
property changes.
FlexEvent.DATA_CHANGE
constant defines the value of the
type
property of the event object for a dataChange
event.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
cancelable | 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 . |
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. |