com.adobe.portfolio.cards.GuideCard

Public Properties

	Property		Defined 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
		skinState : String	NavSkinnableComponent
		visible : Boolean [override] [write-only] Set the visibility of the card	SimpleCard

Protected Properties

Hide Inherited Protected Properties

Show Inherited Protected Properties

	Property		Defined 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
		autoListen : AutoListen	NavSkinnableComponent
		autoWatch : 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
		_skinState : String	NavSkinnableComponent
		thumbnailMgr : ThumbnailManager [static] The navigator's thumbnailManager instance.	SimpleCard

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		GuideCard() Constructor	GuideCard
		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
		removeListenAndWatch():void	NavSkinnableComponent
		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

Show Inherited Protected Methods

	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] Save the current properties of this card.	SimpleCard
		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
		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 instance.	GuideCard
		partRemoved(partName:String, instance:Object):void [override] This function is called when a skin has removed a skin part for this instance.	GuideCard
		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.

Hide Inherited Skin Parts

Show Inherited Skin Parts

	Description	Defined By
icon:mx.controls.Image	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
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
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
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

Public Constants

Hide Inherited Public Constants

Show Inherited Public Constants

	Constant		Defined 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_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
		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
		STATE_DISABLED : String = disabled [static]	NavSkinnableComponent
		STATE_NORMAL : String = normal [static]	NavSkinnableComponent

	Constant	Defined By
		collectionManager : CollectionManager The navigator's CollectionManager 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

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

Parameters

	`partName:String` — The skin part that has been added to the card instance

	`instance:Object` — The card instance that has had the skin part added

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

Parameters

	`partName:String` — The skin part that has been removed from the card instance

	`instance:Object` — The card instance that has had the skin part removed

Constant Detail

PART_NEXT_BUTTON

Constant

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_BUTTON

Constant

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.

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

API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
GuideCard	Properties \| Methods \| Skin Parts \| Skin States \| Constants

Package	com.adobe.portfolio.cards
Class	public class GuideCard
Inheritance	GuideCard SimpleCard NavSkinnableComponent spark.components.supportClasses.SkinnableComponent

	Skin State		Description	Defined By
		normal		SimpleCard
		over		SimpleCard
		overAndSelected		SimpleCard
		selected		SimpleCard