Package | com.adobe.portfolio.cards |
Class | public class FolderCard |
Inheritance | FolderCard ![]() ![]() ![]() ![]() |
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
Property | Defined By | ||
---|---|---|---|
![]() | 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 to be renderered. | 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]
Enable double clicking events. | SimpleCard | |
![]() | downSampleOK : Boolean
true if it is OK to scale down the image;
otherwise false. | 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 | |
![]() | maintainAspectRatio : Boolean
Is true if the aspect ratio of the card should be
maintained by setLayoutBoundsSize; otherwise it is false. | SimpleCard | |
![]() | modDate : Date
The modification date of this card's underlying attachment. | SimpleCard | |
![]() | numAttachments : int
The number of attachments in a folder
| SimpleCard | |
![]() | padding : Point [read-only]
Get the horizontal and vertical padding for this UI component. | SimpleCard | |
![]() | preview : Preview [write-only] | SimpleCard | |
![]() | previewComponent : IPreview [read-only]
Returns the preview component for this card. | 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 | |
showCloseButton : Boolean
Property that controls the visibility of the closeButton (if present)
| FolderCard | ||
![]() | 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
The current skin state
| NavSkinnableComponent | |
![]() | visible : Boolean [override] [write-only]
| SimpleCard |
Method | Defined By | ||
---|---|---|---|
Constructor
| FolderCard | ||
![]() | addListenAndWatch():void
Creates autoListen and autoWatch for automatically tracking listeners and watchers. | NavSkinnableComponent | |
![]() | invalidatePreview(invalidateModel:Boolean = false, generateThumb:Boolean = true):void
Invalidate the current preview state for the card
| SimpleCard | |
![]() | invalidateSkinState():void [override]
| BasicCard | |
![]() | removeListenAndWatch():void
Uses autoListen and autoWatch to remove all listeners and watchers. | NavSkinnableComponent | |
![]() | setCurrentState(stateName:String, playTransition:Boolean = true):void [override]
Set the current state of the card
| BasicCard | |
setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void [override]
If maintainAspectRatio is true, then this call will attempt to prevent
the card dimensions from exceeding its preferred (measured) dimensions.
Sets the layout size of the card. | FolderCard | ||
![]() | toString():String [override]
The String to display in the item renderer. | SimpleCard | |
![]() | updateRenderer(oldRenderer:ISimpleCard):void [override]
Update the renderer to use for the card
| BasicCard |
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]
| 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]
| FolderCard | ||
![]() | getPreviewSize():Point
Get the size of the preview image
| SimpleCard | |
![]() | handlePreview():void
Have the collectionManager handle modal previe experience
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(invalidateModel:Boolean = false, generateThumb:Boolean = true):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 attachment events
| SimpleCard | |
![]() | onChildrenChanged(event:CollectionEvent):void
An event listener that's called when this attachments children dispatches
a collectionChange event. | SimpleCard | |
onCloseButton(event:MouseEvent):void | FolderCard | ||
![]() | 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 from the underlying attachment
| 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] | FolderCard | ||
partRemoved(partName:String, instance:Object):void [override] | FolderCard | ||
![]() | 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 |
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 | ||
---|---|---|---|---|
closeButton:spark.components.Button | Required: false Part Type: Static closeButton is the button control to close the folder. It is an optional skin part, so not necessarily implemented for all skins. | FolderCard | ||
![]() | 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:spark.primitives.BitmapImage | 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. See also | 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 |
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.
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_SIMPLE : String = simple [static]
The string literal used to specify a simple state. | FolderCard | ||
![]() | STATE_SMALL : String = small [static]
String literal used to represent the "small" state of BasicCard. | BasicCard |
showCloseButton | property |
showCloseButton:Boolean
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.1 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
Property that controls the visibility of the closeButton (if present)
This property can be used as the source for data binding.
public function get showCloseButton():Boolean
public function set showCloseButton(value:Boolean):void
FolderCard | () | Constructor |
public function FolderCard()
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
Constructor
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
String |
onCloseButton | () | method |
protected function onCloseButton(event:MouseEvent):void
Parameters
event:MouseEvent |
partAdded | () | method |
override protected function partAdded(partName:String, instance:Object):void
Parameters
partName:String | |
instance:Object |
partRemoved | () | method |
override protected function partRemoved(partName:String, instance:Object):void
Parameters
partName:String | |
instance:Object |
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 |
If maintainAspectRatio is true
, then this call will attempt to prevent
the card dimensions from exceeding its preferred (measured) dimensions.
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().
If maintainAspectRatio is true, then this call will attempt to size the card around its preview component by reducing the width or height, or by adjusting the layout values of paddingGroup.
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.
|
STATE_SIMPLE | Constant |
public static const STATE_SIMPLE:String = simple
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
The string literal used to specify a simple state.