Packagecom.adobe.portfolio.cards
Classpublic class SimpleCard
InheritanceSimpleCard Inheritance NavSkinnableComponent Inheritance spark.components.supportClasses.SkinnableComponent
Implements mx.managers.IFocusManagerComponent, mx.controls.listClasses.IListItemRenderer, spark.components.IItemRenderer, ISimpleCard
Subclasses BasicCard, DetailsCard, GuideCard, PreviewCard

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

SimpleCard is a skinnable renderer for an IAttachment. It implements IListItemRenderer, so it can be used as an item renderer for relevant containers. The skin is not required to provide all the relevant controls, which allows this object to act as the core for both simple (mini-nav) and complex (basic click-through card) rendering.


Public Properties
 PropertyDefined By
  adjustAspectRatio : Boolean
Is true if the aspect ratio of the simple card can be changed; otherwise it is false.
SimpleCard
  colorPalette : ColorPalette
The color palette being used by this object.
SimpleCard
  compressedSize : uint
The size of this card's underlying attachment as it is currently compressed in the Navigator file.
SimpleCard
  creationDate : Date
The creation date of this card's underlying attachment.
SimpleCard
  data : Object
The data object to be rendered.
SimpleCard
  delayThumbnailGeneration : Boolean
Indicates whether generation of the thumbnail image should be delayed or not.
SimpleCard
  description : String
The description of this card's underlying attachment.
SimpleCard
  doubleClickEnabled : Boolean
[override] [write-only] Enables and disables double click events for this card.
SimpleCard
  downSampleOK : Boolean
Indicates whether it is OK to reduce the size of the image.
SimpleCard
  dragging : Boolean
Is true if the item renderer is being dragged; otherwise false.
SimpleCard
  dropShadowPreference : String
The drop shadow effect preference.
SimpleCard
  enableThumbnailGeneration : Boolean
Indicates whether generation of the thumbnail image is enabled or not.
SimpleCard
  fileName : String
The file name of this card's underlying attachment.
SimpleCard
  generateThumb : Boolean
Indicates whether or not to generate a thumbnail image for the card
SimpleCard
  isOpen : Boolean
Is true if the attachment is open in a native editor; otherwise false.
SimpleCard
  itemIndex : int
The index of the item in the data set that this renderer is visualizing.
SimpleCard
  label : String
The String to display in the item renderer.
SimpleCard
  mediumPreviewHasGlow : Boolean
[read-only] A boolean specifying if the skin should apply a glow to the mid-level preview
SimpleCard
  modDate : Date
The modification date of this card's underlying attachment.
SimpleCard
  padding : Point
[read-only] Get the horizontal and vertical padding for this UI component.
SimpleCard
  previewComponent : IPreview
[read-only] The preview component for the simpleCard
SimpleCard
  rollOverPreference : String
A string specifying the preferred type of rollover effect on this component.
SimpleCard
  selected : Boolean
Is true if the item renderer can show itself as selected; otherwise it is false.
SimpleCard
  showsCaret : Boolean
Is true if the item renderer can show itself as focused; otherwise it is false.
SimpleCard
  size : uint
The size of this card's underlying attachment, if it were to be uncompressed.
SimpleCard
 InheritedskinState : String
NavSkinnableComponent
  visible : Boolean
[override] [write-only] Set the visibility of the card
SimpleCard
Protected Properties
 PropertyDefined By
  allowMultiPage : Boolean
[read-only] Should this card use a multi-page preview state.
SimpleCard
  attachment : IAttachment = null
The IAttachment data object being rendered by this component.
SimpleCard
 InheritedautoListen : AutoListen
NavSkinnableComponent
 InheritedautoWatch : AutoWatch
NavSkinnableComponent
  invalidPreview : Boolean
If true the preview for this card is invalid.
SimpleCard
  mouseIsOver : Boolean
Returns true if the mouse is over the card; returns false otherwise.
SimpleCard
  preferredPreviewState : String
[read-only] The preferred preview state for this card
SimpleCard
  prefersMediaPreview : Boolean
[read-only] Does this card's attachment have a preferredPreviewState of AUDIO or VIDEO
SimpleCard
  previewMultiPageModel : IPreviewMultiPageModel
[read-only] Get a preview model that supports multipage preview of attachments
SimpleCard
 Inherited_skinState : String
NavSkinnableComponent
  thumbnailMgr : ThumbnailManager
[static] The navigator's thumbnailManager instance.
SimpleCard
Public Methods
 MethodDefined By
  
SimpleCard()
Default constructor for SimpleCard.
SimpleCard
 Inherited
addListenAndWatch():void
NavSkinnableComponent
  
getDimensionsUsingPreview(fitWidth:Number, fitHeight:Number):Point
Get the dimensions of the preview image.
SimpleCard
  
invalidatePreview(invalidateModel:Boolean = false, generateThumb:Boolean = true):void
Invalidate the current preview state for the card
SimpleCard
 Inherited
removeListenAndWatch():void
NavSkinnableComponent
 Inherited
setCurrentState(stateName:String, playTransition:Boolean = true):void
[override]
NavSkinnableComponent
  
setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void
[override] Sets the layout size of the card.
SimpleCard
  
toString():String
[override] The String to display in the item renderer.
SimpleCard
  
updateRenderer(oldRenderer:ISimpleCard):void
Update the renderer to use for the simpleCard
SimpleCard
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
  
commitProperties():void
[override] Save the current properties of this card.
SimpleCard
 Inherited
detachSkin():void
[override]
NavSkinnableComponent
  
extensionFromAttachment():String
Returns the file extension for the attachment.
SimpleCard
  
generateThumbnail():void
Generate a thumbnail image for the underlying attachment.
SimpleCard
  
getAspectRatio():Number
Get the aspect ratio of the thumbnail for the attachment.
SimpleCard
  
getCurrentSkinState():String
[override] Returns the current skin state of this instance, which is a variant of the component state depending on whether or not the component is selected.
SimpleCard
  
getPreviewSize():Point
Get the size of the preview image
SimpleCard
  
handlePreview():void
Have the collectionManager handle the preview for the underlying attachment.
SimpleCard
  
hostPageCountChanged(val:uint):void
This function is called if the page count of the multipage model has changed
SimpleCard
  
initPageCount():void
Initialize the page count for the preview multipage model to the page count of the underlying attachement.
SimpleCard
 Inherited
initStates():void
NavSkinnableComponent
  
invalidatePreviewFromSetData():void
Invalidate the preview because a new data object to be rendered has been set
SimpleCard
  
mimeTypeFromAttachment():String
Returns the MIME type for the attachment.
SimpleCard
  
onAspectRatioChanged(event:PropertyChangeEvent):void
The event handler for changes in aspect ratio of the thumbnail.
SimpleCard
  
onAttachmentChange(evt:Event):void
Handles changes in the underlying attachement events
SimpleCard
  
onEnableDynamicThumbnails(value:Boolean):void
Handle the enabling of dynamic thumbnails.
SimpleCard
  
onHostPropertyChange(event:PropertyChangeEvent):void
A listener for PropertyChangeEvents on the collectionManager.
SimpleCard
  
onIconChange(event:Event):void
Handle icon change events
SimpleCard
  
partAdded(partName:String, instance:Object):void
[override] This function is called when a skin has added a skin part for this card instance.
SimpleCard
  
partRemoved(partName:String, instance:Object):void
[override] This function is called when a skin has removed a skin part for this card instance.
SimpleCard
  
setAspectRatio(value:Number, mediaValue:Boolean = false):void
Set the aspect ratio of the thumbnail for the attachment.
SimpleCard
  
setAspectRatioField(value:Number):void
Set the aspect ratio of the appropriate field for the attachment
SimpleCard
  
updatePreview(oldRenderer:ISimpleCard):void
Update the preview for this card.
SimpleCard
  
updatePreviewModelListeners(adding:Boolean):void
Update the listeners for preview model events.
SimpleCard
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
  
icon:mx.controls.Image
Required: false Part Type: Static
The icon image for the card
SimpleCard
  
paddingGroup:mx.core.UIComponent
Required: false Part Type: Static
A UI Component whose left/right/top/bottom values can be adjusted to fit card UI to a particular aspect ratio without affecting the bounds of the card.
SimpleCard
  
ribbon:spark.components.Group
Required: false Part Type: Static
A skin part representing the ribbon component that should be visible when the user is editing the attament in an external application.
SimpleCard
Skin States

To skin the component, implement a skin that defines the following states. Although you must implement all skin states, a skin state can be empty. An empty skin state specifies no changes to the default skin state.


 Skin State Description Defined By
  
normal
SimpleCard
  
over
SimpleCard
  
overAndSelected
SimpleCard
  
selected
SimpleCard
Public Constants
 ConstantDefined By
  ASPECT_RATIO_FIELD : String = adobe:AspectRatio
[static] A string literal representing the name for the aspect ratio field
SimpleCard
  PART_ICON : String = icon
[static] A string literal used to represent the icon skin part exposed by SimpleCard
SimpleCard
  PART_PREVIEW : String = preview
[static] A string literal used to represent the preview skin part exposed by SimpleCard
SimpleCard
  PART_RIBBON : String = ribbon
[static] A string literal used to represent the ribbon skin part exposed by SimpleCard
SimpleCard
  SKIN_STATE_NORMAL : String = normal
[static] A string literal used to represent the normal skin state of the SimpleCard
SimpleCard
  SKIN_STATE_OVER : String = over
[static] A string literal used to represent the "over" skin state of the SimpleCard
SimpleCard
  SKIN_STATE_OVER_AND_SELECTED : String = overAndSelected
[static] A string literal used to represent the over and selected skin state of the SimpleCard
SimpleCard
  SKIN_STATE_SELECTED : String = selected
[static] A string literal used to represent the selected skin state of the SimpleCard
SimpleCard
 InheritedSTATE_DISABLED : String = disabled
[static]
NavSkinnableComponent
 InheritedSTATE_NORMAL : String = normal
[static]
NavSkinnableComponent
Protected Constants
 ConstantDefined By
  collectionManager : CollectionManager
The navigator's CollectionManager instance.
SimpleCard
Property Detail
adjustAspectRatioproperty
adjustAspectRatio:Boolean

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

Is true if the aspect ratio of the simple card can be changed; otherwise it is false.


Implementation
    public function get adjustAspectRatio():Boolean
    public function set adjustAspectRatio(value:Boolean):void
allowMultiPageproperty 
allowMultiPage:Boolean  [read-only]

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

Should this card use a multi-page preview state.


Implementation
    protected function get allowMultiPage():Boolean
attachmentproperty 
protected var attachment:IAttachment = null

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

The IAttachment data object being rendered by this component. It is set through the public data setter.

colorPaletteproperty 
colorPalette:ColorPalette

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

The color palette being used by this object.

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


Implementation
    public function get colorPalette():ColorPalette
    public function set colorPalette(value:ColorPalette):void
compressedSizeproperty 
compressedSize:uint

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

The size of this card's underlying attachment as it is currently compressed in the Navigator file.

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


Implementation
    public function get compressedSize():uint
    public function set compressedSize(value:uint):void
creationDateproperty 
creationDate:Date

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

The creation date of this card's underlying attachment.

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


Implementation
    public function get creationDate():Date
    public function set creationDate(value:Date):void
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 IAttachment objects are supported.

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


Implementation
    public function get data():Object
    public function set data(value:Object):void
delayThumbnailGenerationproperty 
delayThumbnailGeneration:Boolean

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

Indicates whether generation of the thumbnail image should be delayed or not.


Implementation
    public function get delayThumbnailGeneration():Boolean
    public function set delayThumbnailGeneration(value:Boolean):void
descriptionproperty 
description:String

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

The description of this card's underlying attachment.

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


Implementation
    public function get description():String
    public function set description(value:String):void
doubleClickEnabledproperty 
doubleClickEnabled:Boolean  [write-only] [override]

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

Enables and disables double click events for this card.


Implementation
    public function set doubleClickEnabled(value:Boolean):void
downSampleOKproperty 
downSampleOK:Boolean

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

Indicates whether it is OK to reduce the size of the image.


Implementation
    public function get downSampleOK():Boolean
    public function set downSampleOK(value:Boolean):void
draggingproperty 
dragging:Boolean

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

Is true if the item renderer is being dragged; otherwise false.


Implementation
    public function get dragging():Boolean
    public function set dragging(value:Boolean):void
dropShadowPreferenceproperty 
dropShadowPreference:String

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

The drop shadow effect preference. This is a string specifying the preferred location for a drop shadow effect on this component. This is used as a hint to skins when specifying filters. The possible values are "none", "bottom", and "rear".

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


Implementation
    public function get dropShadowPreference():String
    public function set dropShadowPreference(value:String):void

See also

CardFactory
enableThumbnailGenerationproperty 
enableThumbnailGeneration:Boolean

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

Indicates whether generation of the thumbnail image is enabled or not.


Implementation
    public function get enableThumbnailGeneration():Boolean
    public function set enableThumbnailGeneration(value:Boolean):void
fileNameproperty 
fileName:String

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

The file name of this card's underlying attachment.

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


Implementation
    public function get fileName():String
    public function set fileName(value:String):void
generateThumbproperty 
generateThumb:Boolean

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

Indicates whether or not to generate a thumbnail image for the card


Implementation
    public function get generateThumb():Boolean
    public function set generateThumb(value:Boolean):void
invalidPreviewproperty 
protected var invalidPreview:Boolean

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

If true the preview for this card is invalid.

isOpenproperty 
isOpen:Boolean

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

Is true if the attachment is open in a native editor; otherwise false.

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


Implementation
    public function get isOpen():Boolean
    public function set isOpen(value:Boolean):void
itemIndexproperty 
itemIndex:int

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

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

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

The String to display in the item renderer.

The host component of the item renderer can use the itemToLabel() method to convert the data item to a String for display by the item renderer.

For controls like List and ButtonBar, you can use the labelField or labelFunction properties to specify the field of the data item that contains the String. Otherwise the host component uses the toString() method to convert the data item to a String.


Implementation
    public function get label():String
    public function set label(value:String):void
mediumPreviewHasGlowproperty 
mediumPreviewHasGlow:Boolean  [read-only]

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

A boolean specifying if the skin should apply a glow to the mid-level preview

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


Implementation
    public function get mediumPreviewHasGlow():Boolean
modDateproperty 
modDate:Date

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

The modification date of this card's underlying attachment.

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


Implementation
    public function get modDate():Date
    public function set modDate(value:Date):void
mouseIsOverproperty 
mouseIsOver:Boolean

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

Returns true if the mouse is over the card; returns false otherwise.


Implementation
    protected function get mouseIsOver():Boolean
    protected function set mouseIsOver(value:Boolean):void
paddingproperty 
padding:Point  [read-only]

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

Get the horizontal and vertical padding for this UI component.


Implementation
    public function get padding():Point
preferredPreviewStateproperty 
preferredPreviewState:String  [read-only]

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

The preferred preview state for this card


Implementation
    protected function get preferredPreviewState():String
prefersMediaPreviewproperty 
prefersMediaPreview:Boolean  [read-only]

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

Does this card's attachment have a preferredPreviewState of AUDIO or VIDEO


Implementation
    protected function get prefersMediaPreview():Boolean
previewComponentproperty 
previewComponent:IPreview  [read-only]

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

The preview component for the simpleCard


Implementation
    public function get previewComponent():IPreview
previewMultiPageModelproperty 
previewMultiPageModel:IPreviewMultiPageModel  [read-only]

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

Get a preview model that supports multipage preview of attachments


Implementation
    protected function get previewMultiPageModel():IPreviewMultiPageModel
rollOverPreferenceproperty 
rollOverPreference:String

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

A string specifying the preferred type of rollover effect on this component. This is used as a hint to skins when specifying filters. Possible values are "none", "glow", and "scale".

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


Implementation
    public function get rollOverPreference():String
    public function set rollOverPreference(value:String):void

See also

CardFactory
selectedproperty 
selected:Boolean

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

Is true if the item renderer can show itself as selected; otherwise it is false.

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

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

Is true if the item renderer can show itself as focused; otherwise it is false.


Implementation
    public function get showsCaret():Boolean
    public function set showsCaret(value:Boolean):void
sizeproperty 
size:uint

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

The size of this card's underlying attachment, if it were to be uncompressed.

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


Implementation
    public function get size():uint
    public function set size(value:uint):void
thumbnailMgrproperty 
protected static var thumbnailMgr:ThumbnailManager

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

The navigator's thumbnailManager instance.

visibleproperty 
visible:Boolean  [write-only] [override]

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

Set the visibility of the card


Implementation
    public function set visible(value:Boolean):void
Constructor Detail
SimpleCard()Constructor
public function SimpleCard()

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

Default constructor for SimpleCard.

Method Detail
commitProperties()method
override protected function commitProperties():void

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

Save the current properties of this card.

extensionFromAttachment()method 
protected function extensionFromAttachment():String

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

Returns the file extension for the attachment. If the attachment is a folder, this returns null.

Returns
String
generateThumbnail()method 
protected function generateThumbnail():void

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

Generate a thumbnail image for the underlying attachment.

getAspectRatio()method 
protected function getAspectRatio():Number

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

Get the aspect ratio of the thumbnail for the attachment.

Returns
Number — The aspect ratio as a single number representing width/height
getCurrentSkinState()method 
override protected function getCurrentSkinState():String

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

Returns the current skin state of this instance, which is a variant of the component state depending on whether or not the component is selected.

Returns
String
getDimensionsUsingPreview()method 
public function getDimensionsUsingPreview(fitWidth:Number, fitHeight:Number):Point

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

Get the dimensions of the preview image.

getDimensionsUsingPreview() takes into consideration both the padding and the aspect ratio when calculating the dimensions. The padding does not affect the aspect ratio.

Parameters

fitWidth:Number — The maximum width to allow
 
fitHeight:Number — The maximum height to allow

Returns
Point — The width and height of the preview image as an ordered pair: (width, height).
getPreviewSize()method 
protected function getPreviewSize():Point

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

Get the size of the preview image

Returns
Point — the width and height of the preview image as an (x,y) pair.
handlePreview()method 
protected function handlePreview():void

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

Have the collectionManager handle the preview for the underlying attachment.

hostPageCountChanged()method 
protected function hostPageCountChanged(val:uint):void

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

This function is called if the page count of the multipage model has changed

Parameters

val:uint — If 0 then do nothing; otherwise invalidate the preview.

initPageCount()method 
protected function initPageCount():void

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

Initialize the page count for the preview multipage model to the page count of the underlying attachement.

invalidatePreview()method 
public function invalidatePreview(invalidateModel:Boolean = false, generateThumb:Boolean = true):void

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

Invalidate the current preview state for the card

Parameters

invalidateModel:Boolean (default = false) — If true then nulify the preview model.
 
generateThumb:Boolean (default = true) — If true then generate a thumbnail image.

invalidatePreviewFromSetData()method 
protected function invalidatePreviewFromSetData():void

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

Invalidate the preview because a new data object to be rendered has been set

mimeTypeFromAttachment()method 
protected function mimeTypeFromAttachment():String

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

Returns the MIME type for the attachment. If the attachment is a folder, this returns null.

Returns
String
onAspectRatioChanged()method 
protected function onAspectRatioChanged(event:PropertyChangeEvent):void

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

The event handler for changes in aspect ratio of the thumbnail.

Parameters

event:PropertyChangeEvent — the change in aspect ratio event

onAttachmentChange()method 
protected function onAttachmentChange(evt:Event):void

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

Handles changes in the underlying attachement events

Parameters

evt:Event — The change in the underlying attachement event

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

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

Handle the enabling of dynamic thumbnails. This function makes sure that cards supporting multi-page start listening for page events.

Parameters

value:Boolean — If true cards supporting multi-page will start listening for page events.

onHostPropertyChange()method 
protected function onHostPropertyChange(event:PropertyChangeEvent):void

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

A listener for PropertyChangeEvents on the collectionManager.

Parameters

event:PropertyChangeEvent — The host's PropertyChangeEvent to be handled.

onIconChange()method 
protected function onIconChange(event:Event):void

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

Handle icon change events

Parameters

event:Event — icon change event

partAdded()method 
override protected function partAdded(partName:String, instance:Object):void

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

This function is called when a skin has added a skin part for this card instance.

Parameters

partName:String
 
instance:Object

partRemoved()method 
override protected function partRemoved(partName:String, instance:Object):void

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

This function is called when a skin has removed a skin part for this card instance.

Parameters

partName:String
 
instance:Object

setAspectRatio()method 
protected function setAspectRatio(value:Number, mediaValue:Boolean = false):void

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

Set the aspect ratio of the thumbnail for the attachment.

Parameters

value:Number — The aspect ratio as a single number representing width/height
 
mediaValue:Boolean (default = false) — Set to true if the card for an audio or video attachment; otherwise set to false.

setAspectRatioField()method 
protected function setAspectRatioField(value:Number):void

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

Set the aspect ratio of the appropriate field for the attachment

Parameters

value:Number — The aspect ratio as a single number representing width/height

setLayoutBoundsSize()method 
override public function setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void

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

Sets the layout size of the card. This is the size that the card element uses to draw on screen.

If the width and/or height parameters are left unspecified, Flex sets the element's layout size to its preferred width and/or preferred height.

Note that calls to the setLayoutBoundSize() method can affect the layout position, so call setLayoutBoundPosition() after calling setLayoutBoundSize().

Parameters

width:Number — The desired width for the card
 
height:Number — The desired height for the card
 
postLayoutTransform:Boolean (default = true) — When postLayoutTransform is true, the specified sizes are those of the card's bounding box. The bounding box is in card's parent coordinate space and is calculated from the card's layout size, layout position and layout transform matrix.

toString()method 
override public function toString():String

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

The String to display in the item renderer.

For controls that do not have labelField or labelFunction properties to specify the field of the data item that contains the string to display, use toString() to convert the data item to a string.

Returns
String — The String to display in the item renderer.
updatePreview()method 
protected function updatePreview(oldRenderer:ISimpleCard):void

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

Update the preview for this card.

Parameters

oldRenderer:ISimpleCard — The previous simpleCard renderer to use as the basis for the updated preview

updatePreviewModelListeners()method 
protected function updatePreviewModelListeners(adding:Boolean):void

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

Update the listeners for preview model events.

Parameters

adding:Boolean — Set to true if you are adding attachments

updateRenderer()method 
public function updateRenderer(oldRenderer:ISimpleCard):void

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

Update the renderer to use for the simpleCard

Parameters

oldRenderer:ISimpleCard — The renderer to use.

Constant Detail
ASPECT_RATIO_FIELDConstant
public static const ASPECT_RATIO_FIELD:String = adobe:AspectRatio

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

A string literal representing the name for the aspect ratio field

collectionManagerConstant 
protected const collectionManager: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.

PART_ICONConstant 
public static const PART_ICON:String = icon

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

A string literal used to represent the icon skin part exposed by SimpleCard

PART_PREVIEWConstant 
public static const PART_PREVIEW:String = preview

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

A string literal used to represent the preview skin part exposed by SimpleCard

PART_RIBBONConstant 
public static const PART_RIBBON:String = ribbon

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

A string literal used to represent the ribbon skin part exposed by SimpleCard

SKIN_STATE_NORMALConstant 
public static const SKIN_STATE_NORMAL:String = normal

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

A string literal used to represent the normal skin state of the SimpleCard

SKIN_STATE_OVERConstant 
public static const SKIN_STATE_OVER:String = over

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

A string literal used to represent the "over" skin state of the SimpleCard

SKIN_STATE_OVER_AND_SELECTEDConstant 
public static const SKIN_STATE_OVER_AND_SELECTED:String = overAndSelected

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

A string literal used to represent the over and selected skin state of the SimpleCard

SKIN_STATE_SELECTEDConstant 
public static const SKIN_STATE_SELECTED:String = selected

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

A string literal used to represent the selected skin state of the SimpleCard




Copyright Adobe Systems Incorporated, all rights reserved, for internal use only

Mon Oct 11 2010, 01:58 PM -07:00