Packagecom.adobe.portfolio.cards
Classpublic class GuideCard
InheritanceGuideCard Inheritance SimpleCard 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 GuideCard class extends SimpleCard to support next/previous card navigation and is used by the Linear navigator.



Public Properties
 PropertyDefined By
 InheritedcolorPalette : ColorPalette
The color palette being used by this object.
SimpleCard
 InheritedcompressedSize : uint
The size of this card's underlying attachment as it is currently compressed in the Navigator file.
SimpleCard
 InheritedcreationDate : Date
The creation date of this card's underlying attachment.
SimpleCard
 Inheriteddata : Object
The data object to be renderered.
SimpleCard
 InheriteddelayThumbnailGeneration : Boolean
Indicates whether generation of the thumbnail image should be delayed or not.
SimpleCard
 Inheriteddescription : String
The description of this card's underlying attachment.
SimpleCard
 InheriteddoubleClickEnabled : Boolean
[override] [write-only] Enable double clicking events.
SimpleCard
 InheriteddownSampleOK : Boolean
true if it is OK to scale down the image; otherwise false.
SimpleCard
 Inheriteddragging : Boolean
Is true if the item renderer is being dragged; otherwise false.
SimpleCard
 InheriteddropShadowPreference : String
The drop shadow effect preference.
SimpleCard
 InheritedenableThumbnailGeneration : Boolean
Indicates whether generation of the thumbnail image is enabled or not.
SimpleCard
 InheritedfileName : String
The file name of this card's underlying attachment.
SimpleCard
 InheritedgenerateThumb : Boolean
Indicates whether or not to generate a thumbnail image for the card
SimpleCard
 InheritedisOpen : Boolean
Is true if the attachment is open in a native editor; otherwise false.
SimpleCard
 InheriteditemIndex : int
The index of the item in the data set that this renderer is visualizing.
SimpleCard
 Inheritedlabel : String
The String to display in the item renderer.
SimpleCard
 InheritedmaintainAspectRatio : Boolean
Is true if the aspect ratio of the card should be maintained by setLayoutBoundsSize; otherwise it is false.
SimpleCard
 InheritedmodDate : Date
The modification date of this card's underlying attachment.
SimpleCard
 InheritednumAttachments : int
The number of attachments in a folder
SimpleCard
 Inheritedpadding : Point
[read-only] Get the horizontal and vertical padding for this UI component.
SimpleCard
 Inheritedpreview : Preview
[write-only]
SimpleCard
 InheritedpreviewComponent : IPreview
[read-only] Returns the preview component for this card.
SimpleCard
 InheritedrollOverPreference : String
A string specifying the preferred type of rollover effect on this component.
SimpleCard
 Inheritedselected : Boolean
Is true if the item renderer can show itself as selected; otherwise it is false.
SimpleCard
 InheritedshowsCaret : Boolean
Is true if the item renderer can show itself as focused; otherwise it is false.
SimpleCard
 Inheritedsize : uint
The size of this card's underlying attachment, if it were to be uncompressed.
SimpleCard
 InheritedskinState : String
The current skin state
NavSkinnableComponent
 Inheritedvisible : Boolean
[override] [write-only]
SimpleCard
Protected Properties
 PropertyDefined By
 InheritedallowMultiPage : Boolean
[read-only] Specifies whether or not this card should use a multi-page preview state.
SimpleCard
 Inheritedattachment : IAttachment = null
The IAttachment data object being rendered by this component.
SimpleCard
 InheritedautoListen : AutoListen
NavSkinnableComponent
 InheritedautoWatch : AutoWatch
NavSkinnableComponent
 InheritedinvalidPreview : Boolean
If true the preview for this card is invalid.
SimpleCard
 InheritedmouseIsOver : Boolean
Returns true if the mouse is over the card; returns false otherwise.
SimpleCard
 InheritedpreferredPreviewState : String
[read-only] The preferred preview state for this card
SimpleCard
 InheritedprefersMediaPreview : Boolean
[read-only] Returns true if this card supports in-place multimedia playback for it's current attachment; false otherwise.
SimpleCard
 InheritedpreviewMultiPageModel : IPreviewMultiPageModel
[read-only] Get a preview model that supports multipage preview of attachments, or null if multipage preview is not supported by the current preview model.
SimpleCard
Public Methods
 MethodDefined By
  
Constructor
GuideCard
 Inherited
Creates autoListen and autoWatch for automatically tracking listeners and watchers.
NavSkinnableComponent
 Inherited
invalidatePreview(invalidateModel:Boolean = false, generateThumb:Boolean = true):void
Invalidate the current preview state for the card
SimpleCard
 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
 Inherited
setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void
[override] Sets the layout size of the card.
SimpleCard
 Inherited
toString():String
[override] The String to display in the item renderer.
SimpleCard
 Inherited
updateRenderer(oldRenderer:ISimpleCard):void
Update the renderer to use for the card
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
 Inherited
[override]
SimpleCard
 Inherited
detachSkin():void
[override]
NavSkinnableComponent
 Inherited
Returns the file extension for the attachment.
SimpleCard
 Inherited
Generate a thumbnail image for the underlying attachment.
SimpleCard
 Inherited
Get the aspect ratio of the thumbnail for the attachment.
SimpleCard
 Inherited
[override]
SimpleCard
 Inherited
Get the size of the preview image
SimpleCard
 Inherited
Have the collectionManager handle modal previe experience for the underlying attachment.
SimpleCard
 Inherited
hostPageCountChanged(val:uint):void
This function is called if the page count of the multipage model has changed
SimpleCard
 Inherited
Initialize the page count for the preview multipage model to the page count of the underlying attachement.
SimpleCard
 Inherited
initStates():void
NavSkinnableComponent
 Inherited
invalidatePreviewFromSetData(invalidateModel:Boolean = false, generateThumb:Boolean = true):void
Invalidate the preview because a new data object to be rendered has been set
SimpleCard
 Inherited
Returns the MIME type for the attachment.
SimpleCard
 Inherited
onAspectRatioChanged(event:PropertyChangeEvent):void
The event handler for changes in aspect ratio of the thumbnail.
SimpleCard
 Inherited
onAttachmentChange(evt:Event):void
Handles changes in the underlying attachment events
SimpleCard
 Inherited
onChildrenChanged(event:CollectionEvent):void
An event listener that's called when this attachments children dispatches a collectionChange event.
SimpleCard
 Inherited
onEnableDynamicThumbnails(value:Boolean):void
Handle the enabling of dynamic thumbnails.
SimpleCard
 Inherited
onHostPropertyChange(event:PropertyChangeEvent):void
A listener for PropertyChangeEvents on the collectionManager.
SimpleCard
 Inherited
onIconChange(event:Event):void
Handle icon change events from the underlying attachment
SimpleCard
  
partAdded(partName:String, instance:Object):void
[override]
GuideCard
  
partRemoved(partName:String, instance:Object):void
[override]
GuideCard
 Inherited
setAspectRatio(value:Number, mediaValue:Boolean = false):void
Set the aspect ratio of the thumbnail for the attachment.
SimpleCard
 Inherited
setAspectRatioField(value:Number):void
Set the aspect ratio of the appropriate field for the attachment
SimpleCard
 Inherited
updatePreview(oldRenderer:ISimpleCard):void
Update the preview for this card.
SimpleCard
 Inherited
updatePreviewModelListeners(adding:Boolean):void
Update the listeners for preview model events.
SimpleCard
Styles
 Style Description Defined By
 InheritedType: Class
Name of the skin class to use for this component when its data is set to a folder attachment.
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
 Inherited
icon:spark.primitives.BitmapImage
Required: false Part Type: Static
The icon image for the card
SimpleCard
  
nextButton:mx.core.IButton
Required: false Part Type: Static
A button for navigating to the next attachment, optionally provided by this instance's skin.
GuideCard
 Inherited
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.

See also

SimpleCard
  
prevButton:mx.core.IButton
Required: false Part Type: Static
A button for navigating to the previous attachment, optionally provided by this instance's skin.
GuideCard
 Inherited
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
 InheritedSimpleCard
 InheritedSimpleCard
 InheritedSimpleCard
 InheritedSimpleCard
Public Constants
 ConstantDefined By
 InheritedASPECT_RATIO_FIELD : String = adobe:AspectRatio
[static] A string literal representing the name for the aspect ratio field
SimpleCard
 InheritedPART_ICON : String = icon
[static] A string literal used to represent the icon skin part exposed by SimpleCard
SimpleCard
  PART_NEXT_BUTTON : String = nextButton
[static] A string literal used to represent the next attachment button skin parts exposed by OneUp to its skins.
GuideCard
  PART_PREV_BUTTON : String = prevButton
[static] A string literal used to represent the previous attachment button skin parts exposed by OneUp to its skins.
GuideCard
 InheritedPART_PREVIEW : String = preview
[static] A string literal used to represent the preview skin part exposed by SimpleCard
SimpleCard
 InheritedPART_RIBBON : String = ribbon
[static] A string literal used to represent the ribbon skin part exposed by SimpleCard
SimpleCard
 InheritedSKIN_STATE_NORMAL : String = normal
[static] A string literal used to represent the normal skin state of the SimpleCard
SimpleCard
 InheritedSKIN_STATE_OVER : String = over
[static] A string literal used to represent the "over" skin state of the SimpleCard
SimpleCard
 InheritedSKIN_STATE_OVER_AND_SELECTED : String = overAndSelected
[static] A string literal used to represent the over and selected skin state of the SimpleCard
SimpleCard
 InheritedSKIN_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
 InheritedcollectionManager : CollectionManager
The navigator's CollectionManager instance.
SimpleCard
 Inheritedlogger : ILogger
A logger that can be used by this instance to log warnings, errors, or additional information.
SimpleCard
 InheritedthumbnailMgr : ThumbnailManager
[static] The navigator's thumbnailManager instance.
SimpleCard
Constructor Detail
GuideCard()Constructor
public function GuideCard()

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

Constructor

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

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

Parameters

partName:String
 
instance:Object

Constant Detail
PART_NEXT_BUTTONConstant
public static const PART_NEXT_BUTTON:String = nextButton

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 next attachment button skin parts exposed by OneUp to its skins.

PART_PREV_BUTTONConstant 
public static const PART_PREV_BUTTON:String = prevButton

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 previous attachment button skin parts exposed by OneUp to its skins.