Package | com.adobe.portfolio.components.details |
Class | public class DetailsHeaderItem |
Inheritance | DetailsHeaderItem ![]() ![]() |
Implements | mx.managers.IFocusManagerComponent, mx.controls.listClasses.IListItemRenderer, spark.components.IItemRenderer |
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
Property | Defined By | ||
---|---|---|---|
data : Object
The data object to be rendered. | DetailsHeaderItem | ||
detailsField : DetailsField = null
The DetailsField data object being rendered by this component, set through the public
data setter. | DetailsHeaderItem | ||
dragging : Boolean
True if the item renderer is being dragged. | DetailsHeaderItem | ||
field : IField
The IAttachment IField for this header item. | DetailsHeaderItem | ||
itemIndex : int
The index of the item in the data set
that this renderer is visualizing. | DetailsHeaderItem | ||
label : String | DetailsHeaderItem | ||
resizable : Boolean
Indicates if this header item is a resizable field. | DetailsHeaderItem | ||
selected : Boolean
Contains true if the item renderer
can show itself as selected. | DetailsHeaderItem | ||
showsCaret : Boolean
Contains true if the item renderer
can show itself as focused. | DetailsHeaderItem | ||
![]() | skinState : String
The current skin state
| NavSkinnableComponent | |
sortAscending : Boolean
Indicates if this header item is sorted with an ascending sort. | DetailsHeaderItem | ||
sortedField : Boolean
Indicates if this header item is the sort field. | DetailsHeaderItem |
Property | Defined By | ||
---|---|---|---|
![]() | autoListen : AutoListen | NavSkinnableComponent | |
![]() | autoWatch : AutoWatch | NavSkinnableComponent | |
_itemIndex : int = -1 Internal representation of the int referenced by the itemIndex getter and setter. | DetailsHeaderItem | ||
_label : String Internal representation of the string referenced by the label getter and setter. | DetailsHeaderItem | ||
_selected : Boolean = false Internal representation of the Boolean referenced by the selected getter and setter. | DetailsHeaderItem | ||
_showsCaret : Boolean = false Internal representation of the Boolean referenced by the showsCaret getter and setter. | DetailsHeaderItem |
Method | Defined By | ||
---|---|---|---|
Constructor. | DetailsHeaderItem | ||
addListenAndWatch():void [override]
Adds listeners and watchers that are automatically unwatched and unlistened. | DetailsHeaderItem | ||
getCalculatedWidth(field:DetailsField, measureField:UIFTETextField = null):Number
Get the ideal width for this card item. | DetailsHeaderItem | ||
![]() | removeListenAndWatch():void
Uses autoListen and autoWatch to remove all listeners and watchers. | NavSkinnableComponent | |
![]() | setCurrentState(stateName:String, playTransition:Boolean = true):void [override]
Sets the current component state and skin state. | NavSkinnableComponent | |
updateSortState():void
Called when the sort order of the IAttachment fields change. | DetailsHeaderItem |
Method | Defined By | ||
---|---|---|---|
![]() | addListener(listener:IEventDispatcher, type:String, handler:Function, useCapture:Boolean = false, priority:int = 0):void | NavSkinnableComponent | |
![]() | addWatcher(watcher:ChangeWatcher):void | NavSkinnableComponent | |
commitProperties():void [override] | DetailsHeaderItem | ||
![]() | detachSkin():void [override] | NavSkinnableComponent | |
![]() | getCurrentSkinState():String [override] | NavSkinnableComponent | |
![]() | initStates():void | NavSkinnableComponent | |
partAdded(partName:String, instance:Object):void [override] Called when a skin has added a skin part for this instance. | DetailsHeaderItem | ||
![]() | partRemoved(partName:String, instance:Object):void [override] | NavSkinnableComponent |
This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.
Skin Part | Description | Defined By | ||
---|---|---|---|---|
headerItems:spark.components.HGroup | Required: true Part Type: Static The group containing the header items so clicks around the items can be detected. | DetailsHeaderItem | ||
headerName:FieldTextInput | Required: true Part Type: Static The (editable if user-defined) header text. | DetailsHeaderItem | ||
resizeSeparator:spark.components.HGroup | Required: true Part Type: Static A button/region that identifies where columns can be resized from. | DetailsHeaderItem | ||
sortIndicator:spark.components.HGroup | Required: true Part Type: Static An icon to show that this column is being sorted with ascending/descending sort. | DetailsHeaderItem |
Constant | Defined By | ||
---|---|---|---|
collectionMgr : CollectionManager
The navigator's CollectionManager instance. | DetailsHeaderItem |
_itemIndex | property |
protected var _itemIndex:int = -1
Internal representation of the int referenced by the itemIndex getter and setter.
_label | property |
protected var _label:String
Internal representation of the string referenced by the label getter and setter.
_selected | property |
protected var _selected:Boolean = false
Internal representation of the Boolean referenced by the selected getter and setter.
_showsCaret | property |
protected var _showsCaret:Boolean = false
Internal representation of the Boolean referenced by the showsCaret getter and setter.
data | property |
data:Object
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
The data object to be rendered. Only DetailsField objects are supported.
public function get data():Object
public function set data(value:Object):void
detailsField | property |
public var detailsField:DetailsField = null
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
The DetailsField data object being rendered by this component, set through the public data setter.
dragging | property |
dragging:Boolean
True if the item renderer is being dragged.
public function get dragging():Boolean
public function set dragging(value:Boolean):void
field | property |
field:IField
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
The IAttachment IField for this header item.
This property can be used as the source for data binding.
public function get field():IField
public function set field(value:IField):void
itemIndex | property |
itemIndex:int
The index of the item in the data set that this renderer is visualizing.
public function get itemIndex():int
public function set itemIndex(value:int):void
label | property |
label:String
public function get label():String
public function set label(value:String):void
resizable | property |
resizable:Boolean
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
Indicates if this header item is a resizable field.
This property can be used as the source for data binding.
public function get resizable():Boolean
public function set resizable(value:Boolean):void
selected | property |
selected:Boolean
Contains true
if the item renderer
can show itself as selected.
This property can be used as the source for data binding.
public function get selected():Boolean
public function set selected(value:Boolean):void
showsCaret | property |
showsCaret:Boolean
Contains true
if the item renderer
can show itself as focused.
public function get showsCaret():Boolean
public function set showsCaret(value:Boolean):void
sortAscending | property |
sortAscending:Boolean
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
Indicates if this header item is sorted with an ascending sort. This is used by the skin to draw an up (vs down) arrow icon.
This property can be used as the source for data binding.
public function get sortAscending():Boolean
public function set sortAscending(value:Boolean):void
sortedField | property |
sortedField:Boolean
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
Indicates if this header item is the sort field.
This property can be used as the source for data binding.
public function get sortedField():Boolean
public function set sortedField(value:Boolean):void
DetailsHeaderItem | () | Constructor |
public function DetailsHeaderItem()
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
Constructor.
addListenAndWatch | () | method |
override public function addListenAndWatch():void
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
Adds listeners and watchers that are automatically unwatched and unlistened.
commitProperties | () | method |
override protected function commitProperties():void
getCalculatedWidth | () | method |
public function getCalculatedWidth(field:DetailsField, measureField:UIFTETextField = null):Number
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
Get the ideal width for this card item. Usually this is the measured width of the text plus some padding.
Parameters
field:DetailsField — The DetailsField for this card item. This method can be called before the DetailsField is set,
which is why this is passed as an argument.
| |
measureField:UIFTETextField (default = null ) — A field on the stage appropriate for measuring text.
|
Number — Width of the text, sort indicator, resize indicator plus some padding.
|
partAdded | () | method |
override protected function partAdded(partName:String, instance:Object):void
Called when a skin has added a skin part for this instance.
Parameters
partName:String | |
instance:Object |
updateSortState | () | method |
public function updateSortState():void
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
Called when the sort order of the IAttachment fields change.
collectionMgr | Constant |
protected const collectionMgr:CollectionManager
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
The navigator's CollectionManager instance. All host interaction should go through this instance, rather than the INavigatorHost directly.