Packagecom.adobe.portfolio.components.details
Classpublic class Details
InheritanceDetails Inheritance NavSkinnableComponent Inheritance spark.components.supportClasses.SkinnableComponent

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The Details class extends NavSkinnableComponent to implement the Details navigator.



Public Properties
 PropertyDefined By
  detailsFields : ArrayList
An array of DetailFields that corresponds to each of the fields in the IAttachment.
Details
  fieldColumnMinWidth : Number
[read-only] The sum of actual widths of all fields.
Details
  fieldColumnTotalWidth : Number
[read-only] The actual width of all fields, plus any additional space to equal the width of Details.
Details
  horizontalScrollPosition : Number
[read-only] A common horizontalScrollPosition used by both the header and card list.
Details
 InheritedskinState : String
The current skin state
NavSkinnableComponent
Protected Properties
 PropertyDefined By
 InheritedautoListen : AutoListen
NavSkinnableComponent
 InheritedautoWatch : AutoWatch
NavSkinnableComponent
Public Methods
 MethodDefined By
  
Constructor.
Details
  
[override] Adds listeners and watchers that are automatically unwatched and unlistened.
Details
  
Called by DetailsHeaderLayout and DetailsCardLayout classes to decide the layout of each header and card item.
Details
 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
  
updateFieldOrder(movedField:IField, afterFieldName:String):void
Called when user changes field order by dragging/dropping (field) column headers.
Details
  
updateSortOrder(fieldName:String, descending:Boolean):void
Called when user changes sort order by clicking on a (field) column header.
Details
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
  
authoringModeChanged(value:Boolean):void
Details
 Inherited
detachSkin():void
[override]
NavSkinnableComponent
  
fieldsChanged(value:Array):void
Details
 Inherited
[override]
NavSkinnableComponent
  
[override]
Details
 Inherited
initStates():void
NavSkinnableComponent
  
measure():void
[override]
Details
  
onCollectionChange(event:CollectionEvent):void
An event listener to respond to events from the current collection.
Details
  
onColumnResizeStart(event:DataGridEvent):void
Details
  
onHeaderClicked(event:DataGridEvent):void
Details
  
onHeaderResize(event:ResizeEvent):void
Details
  
An event listener to respond to events from the collectionManager.
Details
  
partAdded(partName:String, instance:Object):void
[override] Called when a skin has added a skin part for this instance.
Details
 Inherited
partRemoved(partName:String, instance:Object):void
[override]
NavSkinnableComponent
  
sortChanged(value:Array):void
Details
  
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
[override]
Details
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
  
detailsCards:DetailsCardList
Required: true Part Type: Static
The body portion of the details card list.
Details
  
detailsHeader:DetailsHeader
Required: true Part Type: Static
The header portion of the details card list.
Details
  
measureCanvas:mx.containers.Canvas
Required: true Part Type: Static
A container needed to add an IUITextField for measuring text. When provided, measureField will be created and added to its rawChildren.
Details
Public Constants
 ConstantDefined By
  collectionMgr : CollectionManager
The navigator's CollectionManager instance.
Details
  MAXIMUM_DATA_ITEMS_TO_CHECK : Number = 10
[static] The maximum number of data items that are checked to determine the optimum (default) width of a field/column.
Details
  PREVIEW_ICON_HEIGHT : Number = 50
[static] The height, in pixels, of the icon which is displayed in each row of the details layout.
Details
  PREVIEW_ICON_WIDTH : Number = 75
[static] The width, in pixels, of the icon which is displayed in each row of the details layout.
Details
 InheritedSTATE_DISABLED : String = disabled
[static]
NavSkinnableComponent
 InheritedSTATE_NORMAL : String = normal
[static]
NavSkinnableComponent
Property Detail
detailsFieldsproperty
detailsFields:ArrayList

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

An array of DetailFields that corresponds to each of the fields in the IAttachment.

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


Implementation
    public function get detailsFields():ArrayList
    public function set detailsFields(value:ArrayList):void
fieldColumnMinWidthproperty 
fieldColumnMinWidth:Number  [read-only]

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The sum of actual widths of all fields.

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


Implementation
    public function get fieldColumnMinWidth():Number
fieldColumnTotalWidthproperty 
fieldColumnTotalWidth:Number  [read-only]

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The actual width of all fields, plus any additional space to equal the width of Details.

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


Implementation
    public function get fieldColumnTotalWidth():Number
horizontalScrollPositionproperty 
horizontalScrollPosition:Number  [read-only]

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

A common horizontalScrollPosition used by both the header and card list.

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


Implementation
    public function get horizontalScrollPosition():Number
Constructor Detail
Details()Constructor
public function Details()

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.

authoringModeChanged()method 
protected function authoringModeChanged(value:Boolean):void

Parameters

value:Boolean

fieldsChanged()method 
protected function fieldsChanged(value:Array):void

Parameters

value:Array

getFieldColumnWidths()method 
public function getFieldColumnWidths():Array

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Called by DetailsHeaderLayout and DetailsCardLayout classes to decide the layout of each header and card item.

Returns
Array — an array of width values (Number) corresponding to the width of each field.
initializeAccessibility()method 
override protected function initializeAccessibility():void

measure()method 
override protected function measure():void

onCollectionChange()method 
protected function onCollectionChange(event:CollectionEvent):void

An event listener to respond to events from the current collection.

Parameters

event:CollectionEvent

onColumnResizeStart()method 
protected function onColumnResizeStart(event:DataGridEvent):void

Parameters

event:DataGridEvent

onHeaderClicked()method 
protected function onHeaderClicked(event:DataGridEvent):void

Parameters

event:DataGridEvent

onHeaderResize()method 
protected function onHeaderResize(event:ResizeEvent):void

Parameters

event:ResizeEvent

onHostEvent()method 
protected function onHostEvent(event:CollectionManagerEvent):void

An event listener to respond to events from the collectionManager.

Parameters

event:CollectionManagerEvent

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

sortChanged()method 
protected function sortChanged(value:Array):void

Parameters

value:Array

updateDisplayList()method 
override protected function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void

Parameters

unscaledWidth:Number
 
unscaledHeight:Number

updateFieldOrder()method 
public function updateFieldOrder(movedField:IField, afterFieldName:String):void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Called when user changes field order by dragging/dropping (field) column headers.

Parameters

movedField:IField — The field that is being moved.
 
afterFieldName:String — Determines the location of the moved field. If not an empty string, the moved field is moved before this field. If the empty string, the moved field is moved to the end of all fields.

updateSortOrder()method 
public function updateSortOrder(fieldName:String, descending:Boolean):void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Called when user changes sort order by clicking on a (field) column header.

Parameters

fieldName:String — The field that the sort order is based on.
 
descending:Boolean — Determines if the sort is descending (true) or ascending (false).

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

MAXIMUM_DATA_ITEMS_TO_CHECKConstant 
public static const MAXIMUM_DATA_ITEMS_TO_CHECK:Number = 10

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The maximum number of data items that are checked to determine the optimum (default) width of a field/column.

PREVIEW_ICON_HEIGHTConstant 
public static const PREVIEW_ICON_HEIGHT:Number = 50

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The height, in pixels, of the icon which is displayed in each row of the details layout.

PREVIEW_ICON_WIDTHConstant 
public static const PREVIEW_ICON_WIDTH:Number = 75

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The width, in pixels, of the icon which is displayed in each row of the details layout.