Packagecom.adobe.portfolio.components.details
Classpublic class DetailsHeaderItem
InheritanceDetailsHeaderItem Inheritance NavSkinnableComponent Inheritance spark.components.supportClasses.SkinnableComponent
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

The DetailsHeaderItem class extends NavSkinnableComponent to implement a cell of the header row in the Details navigator.



Public Properties
 PropertyDefined 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
 InheritedskinState : 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
Protected Properties
 PropertyDefined By
 InheritedautoListen : AutoListen
NavSkinnableComponent
 InheritedautoWatch : 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
Public Methods
 MethodDefined By
  
Constructor.
DetailsHeaderItem
  
[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
 Inherited
Uses autoListen and autoWatch to remove all listeners and watchers.
NavSkinnableComponent
 Inherited
setCurrentState(stateName:String, playTransition:Boolean = true):void
[override] Sets the current component state and skin state.
NavSkinnableComponent
  
Called when the sort order of the IAttachment fields change.
DetailsHeaderItem
Protected Methods
 MethodDefined By
 Inherited
addListener(listener:IEventDispatcher, type:String, handler:Function, useCapture:Boolean = false, priority:int = 0):void
NavSkinnableComponent
 Inherited
addWatcher(watcher:ChangeWatcher):void
NavSkinnableComponent
  
[override]
DetailsHeaderItem
 Inherited
detachSkin():void
[override]
NavSkinnableComponent
 Inherited
[override]
NavSkinnableComponent
 Inherited
initStates():void
NavSkinnableComponent
  
partAdded(partName:String, instance:Object):void
[override] Called when a skin has added a skin part for this instance.
DetailsHeaderItem
 Inherited
partRemoved(partName:String, instance:Object):void
[override]
NavSkinnableComponent
Skin Parts

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
Public Constants
 ConstantDefined By
 InheritedSTATE_DISABLED : String = disabled
[static]
NavSkinnableComponent
 InheritedSTATE_NORMAL : String = normal
[static]
NavSkinnableComponent
Protected Constants
 ConstantDefined By
  collectionMgr : CollectionManager
The navigator's CollectionManager instance.
DetailsHeaderItem
Property Detail
_itemIndexproperty
protected var _itemIndex:int = -1

Internal representation of the int referenced by the itemIndex getter and setter.

_labelproperty 
protected var _label:String

Internal representation of the string referenced by the label getter and setter.

_selectedproperty 
protected var _selected:Boolean = false

Internal representation of the Boolean referenced by the selected getter and setter.

_showsCaretproperty 
protected var _showsCaret:Boolean = false

Internal representation of the Boolean referenced by the showsCaret getter and setter.

dataproperty 
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.


Implementation
    public function get data():Object
    public function set data(value:Object):void
detailsFieldproperty 
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.

draggingproperty 
dragging:Boolean

True if the item renderer is being dragged.


Implementation
    public function get dragging():Boolean
    public function set dragging(value:Boolean):void
fieldproperty 
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.


Implementation
    public function get field():IField
    public function set field(value:IField):void
itemIndexproperty 
itemIndex:int

The index of the item in the data set that this renderer is visualizing.


Implementation
    public function get itemIndex():int
    public function set itemIndex(value:int):void
labelproperty 
label:String


Implementation
    public function get label():String
    public function set label(value:String):void
resizableproperty 
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.


Implementation
    public function get resizable():Boolean
    public function set resizable(value:Boolean):void
selectedproperty 
selected:Boolean

Contains true if the item renderer can show itself as selected.

This property can be used as the source for data binding.


Implementation
    public function get selected():Boolean
    public function set selected(value:Boolean):void
showsCaretproperty 
showsCaret:Boolean

Contains true if the item renderer can show itself as focused.


Implementation
    public function get showsCaret():Boolean
    public function set showsCaret(value:Boolean):void
sortAscendingproperty 
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.


Implementation
    public function get sortAscending():Boolean
    public function set sortAscending(value:Boolean):void
sortedFieldproperty 
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.


Implementation
    public function get sortedField():Boolean
    public function set sortedField(value:Boolean):void
Constructor Detail
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.

Method Detail
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.

Returns
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.

Constant Detail
collectionMgrConstant
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.