com.adobe.portfolio.cards.PlaceholderCard

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 [override] The data object being rendered by the basicCard.	BasicCard
		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 [override] [read-only] Determines if the attachement supports calculating the number of pages it contains.	BasicCard
		attachment : IAttachment = null The IAttachment data object being rendered by this component.	SimpleCard
		autoListen : AutoListen	NavSkinnableComponent
		autoWatch : AutoWatch	NavSkinnableComponent
		infoMap : Dictionary [static] The dictionary for the BasicCard's info state	BasicCard
		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 [override] [read-only] Returns the preferred PreviewState.	BasicCard
		prefersMediaPreview : Boolean [override] [read-only] Does this card's attachment have a preferredPreviewState of AUDIO or VIDEO	BasicCard
		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
		zoomLarge : IEffect The Flex effect to run when zooming to a large card size	BasicCard
		zoomNormal : IEffect The Flex effect to run when zooming to a medium card size	BasicCard
		zoomToLarge : Boolean = false Boolean switch indicating whether to run a large or normal zoom effect.	BasicCard

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		PlaceholderCard() Constructor	PlaceholderCard
		addListenAndWatch():void	NavSkinnableComponent
		getDimensionsUsingPreview(fitWidth:Number, fitHeight:Number):Point [override] Find the proper dimensions for the card image.	PlaceholderCard
		invalidatePreview(invalidateModel:Boolean = false, generateThumb:Boolean = true):void Invalidate the current preview state for the card	SimpleCard
		invalidateSkinState():void [override] Mark the SkinState as invalid.	BasicCard
		removeListenAndWatch():void	NavSkinnableComponent
		setCurrentState(stateName:String, playTransition:Boolean = true):void [override] Sets the state of the skin as well as the state of this instance.	BasicCard
		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 [override] Update the renderer to use for the basicCard	BasicCard

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 state of this instance, which is a variant of the component state depending on whether or not the component is selected.	BasicCard
		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
		initZoom():void Initialize zoom effects and set up event listener for such events.	BasicCard
		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
		onDeleteClick(evt:Event):void The event handler for the clicking the delete button events.	BasicCard
		onEnableDynamicThumbnails(value:Boolean):void Handle the enabling of dynamic thumbnails.	SimpleCard
		onExtractClick(evt:Event):void The event handler for clicking the extract button events.	BasicCard
		onExtractOrDeleteClick(event:Event):void The event handler for the handling either clicking the delete button events.	BasicCard
		onHostPropertyChange(event:PropertyChangeEvent):void [override] A listener for PropertyChangeEvents on the collectionManager.	BasicCard
		onIconChange(event:Event):void Handle icon change events	SimpleCard
		onInfoClick(evt:Event):void The event handler for clicking the info button events.	BasicCard
		onInfoCloseClick(evt:Event):void The event handler for closing the BasicCard's info state.	BasicCard
		onPreviewClick(evt:Event):void The event handler for clicking the preview button events.	BasicCard
		partAdded(partName:String, instance:Object):void [override] Called when a skin has added a skin part for this instance.	BasicCard
		partRemoved(partName:String, instance:Object):void [override] Called when a skin has removed a skin part for this instance.	BasicCard
		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
		setExtractOrDeleteInfo():void For an extractOrDelete button control set the label to either delete (file or folder, depending on the attachment type) or extract, depending on the authoring mode.	BasicCard
		updatePreview(oldRenderer:ISimpleCard):void Update the preview for this card.	SimpleCard
		updatePreviewModelListeners(adding:Boolean):void Update the listeners for preview model events.	SimpleCard
		zoomCard(zoomToLarge:Boolean):void Set the zoomToLarge Boolean switch for the BasicCard and play the relevant zoom effect (zoomLarge or zoomNormal)	BasicCard

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
deleteButton:spark.components.Button	Required: false Part Type: Static deleteButton is the button control to delete the attachment represented by a card. It is an optional skin part, so not necessarily implemented for all skins.	BasicCard
extractButton:spark.components.Button	Required: false Part Type: Static extractButton is the button control to initiate save an attachment to a user-specified location. It is an optional skin part, so not necessarily implemented for all skins.	BasicCard
extractOrDeleteButton:spark.components.Button	Required: false Part Type: Static extractOrDeleteButton behave like deleteButton when in authoring mode, and extractButton otherwise.	BasicCard
icon:mx.controls.Image	Required: false Part Type: Static The icon image for the card	SimpleCard
infoButton:spark.components.Button	Required: false Part Type: Static infoButton is the button control to toggle the info state of a card. When in the info state, the thumbnail is replaced with additional metadata. It is an optional skin part, so not necessarily implemented for all skins.	BasicCard
infoCloseButton:spark.components.Button	Required: false Part Type: Static infoCloseButton is the button control for closing the Info state (information on the card) for a card.	BasicCard
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
previewButton:spark.components.Button	Required: false Part Type: Static previewButton is the button control to initiate a full preview in the viewing application. It is an optional skin part, so not necessarily implemented for all skins.	BasicCard
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.

Hide Inherited Skin States

Show Inherited Skin States

	Skin State		Description	Defined By
		infoNormal		BasicCard
		infoOver		BasicCard
		infoOverAndSelected		BasicCard
		infoSelected		BasicCard
		largeNormal		BasicCard
		largeOver		BasicCard
		largeOverAndSelected		BasicCard
		largeSelected		BasicCard
		mediumNormal		BasicCard
		mediumOver		BasicCard
		mediumOverAndSelected		BasicCard
		mediumSelected		BasicCard
		normal		BasicCard
		over		BasicCard
		overAndSelected		BasicCard
		selected		BasicCard
		smallNormal		BasicCard
		smallOver		BasicCard
		smallOverAndSelected		BasicCard
		smallSelected		BasicCard

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
		DEFAULT_SMALL_DIMENSION : Number = 152 [static] String literal used to represent the default dimensions for the small state of BasicCard.	BasicCard
		PART_DELETE_BUTTON : String = deleteButton [static] String literal used to represent the deleteButton skin part exposed by BasicCard to its skins.	BasicCard
		PART_EXTRACT_BUTTON : String = extractButton [static] String literal used to represent the extractButton skin part exposed by BasicCard to its skins.	BasicCard
		PART_EXTRACT_OR_DELETE_BUTTON : String = extractOrDeleteButton [static] String literal used to represent the extractOrDeleteButton skin part exposed by BasicCard to its skins.	BasicCard
		PART_ICON : String = icon [static] A string literal used to represent the icon skin part exposed by SimpleCard	SimpleCard
		PART_INFO_BUTTON : String = infoButton [static] String literal used to represent the infoButton skin part exposed by BasicCard to its skins.	BasicCard
		PART_INFO_CLOSE_BUTTON : String = infoCloseButton [static] String literal used to represent the infoCloseButton skin part exposed by BasicCard to its skins.	BasicCard
		PART_PREVIEW : String = preview [static] A string literal used to represent the preview skin part exposed by SimpleCard	SimpleCard
		PART_PREVIEW_BUTTON : String = previewButton [static] String literal used to represent the previewButton skin part exposed by BasicCard to its skins.	BasicCard
		PART_RIBBON : String = ribbon [static] A string literal used to represent the ribbon skin part exposed by SimpleCard	SimpleCard
		SKIN_STATE_INFO_NORMAL : String = infoNormal [static] String literals used to represent the normal "info" state of BasicCard.	BasicCard
		SKIN_STATE_INFO_OVER : String = infoOver [static] String literals used to represent the over "info" state of BasicCard.	BasicCard
		SKIN_STATE_INFO_OVER_AND_SELECTED : String = infoOverAndSelected [static] String literals used to represent the over and selected "info" state of BasicCard.	BasicCard
		SKIN_STATE_INFO_SELECTED : String = infoSelected [static] String literals used to represent the selected "info" state of BasicCard.	BasicCard
		SKIN_STATE_LARGE_NORMAL : String = largeNormal [static] String literal used to represent the large card normal state of a BasicCard skin.	BasicCard
		SKIN_STATE_LARGE_OVER : String = largeOver [static] String literal used to represent the large card over state of a BasicCard skin.	BasicCard
		SKIN_STATE_LARGE_OVER_AND_SELECTED : String = largeOverAndSelected [static] String literal used to represent the large card over and selected state of a BasicCard skin.	BasicCard
		SKIN_STATE_LARGE_SELECTED : String = largeSelected [static] String literal used to represent the large card selected state of a BasicCard skin.	BasicCard
		SKIN_STATE_MEDIUM_NORMAL : String = mediumNormal [static] String literal used to represent the medium card normal state of a BasicCard skin.	BasicCard
		SKIN_STATE_MEDIUM_OVER : String = mediumOver [static] String literal used to represent the medium card over state of a BasicCard skin.	BasicCard
		SKIN_STATE_MEDIUM_OVER_AND_SELECTED : String = mediumOverAndSelected [static] String literal used to represent the medium card over and selected state of a BasicCard skin.	BasicCard
		SKIN_STATE_MEDIUM_SELECTED : String = mediumSelected [static] String literal used to represent the medium card selected state of a BasicCard skin.	BasicCard
		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
		SKIN_STATE_SMALL_NORMAL : String = smallNormal [static] String literal used to represent the small card normal state of a BasicCard skin.	BasicCard
		SKIN_STATE_SMALL_OVER : String = smallOver [static] String literal used to represent the small card over state of a BasicCard skin.	BasicCard
		SKIN_STATE_SMALL_OVER_AND_SELECTED : String = smallOverAndSelected [static] String literal used to represent the small card over and selected state of a BasicCard skin.	BasicCard
		SKIN_STATE_SMALL_SELECTED : String = smallSelected [static] String literal used to represent the small card selected state of a BasicCard skin.	BasicCard
		STATE_DISABLED : String = disabled [static]	NavSkinnableComponent
		STATE_INFO : String = info [static] String literal used to represent the "info" state of BasicCard.	BasicCard
		STATE_LARGE : String = large [static] String literal used to represent the "large" state of BasicCard.	BasicCard
		STATE_MEDIUM : String = medium [static] String literal used to represent the "medium" state of BasicCard.	BasicCard
		STATE_NORMAL : String = normal [static]	NavSkinnableComponent
		STATE_SMALL : String = small [static] String literal used to represent the "small" state of BasicCard.	BasicCard

Protected Constants

Hide Inherited Protected Constants

Show Inherited Protected Constants

	Constant		Defined By
		collectionManager : CollectionManager The navigator's CollectionManager instance.	SimpleCard

Constructor Detail

PlaceholderCard

()

Constructor

public function PlaceholderCard()

Language Version :

ActionScript 3.0

Product Version :

Portfolio 10.0

Runtime Versions :

Flash Player 10.1, AIR 2.0

Constructor

Method Detail

getDimensionsUsingPreview

()

method

override 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

Find the proper dimensions for the card image. Placeholder cards don't have previews, so fit them to the specified size.

Parameters

	`fitWidth:Number` — The maximum width to allow

	`fitHeight:Number` — The maximum height to allow

Returns

Point

Thu Oct 14 2010, 03:29 PM -07:00

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

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