Packagecom.adobe.portfolio.cards
Interfacepublic interface ISimpleCard extends flash.events.IEventDispatcher, mx.core.IVisualElement
Implementors SimpleCard

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

ISimpleCard is an interface that describes the minimum capabilities of a SimpleCard. Typically layouts and skins will use this interface instead of referencing SimpleCard directly.


Public Properties
 PropertyDefined By
  colorPalette : ColorPalette
[read-only] The color palette being used by this object.
ISimpleCard
  compressedSize : uint
[read-only] The size of this card's underlying attachment as it is currently compressed in the Navigator file.
ISimpleCard
  creationDate : Date
[read-only] The creation date of this card's underlying attachment.
ISimpleCard
  data : Object
The data object to be renderered.
ISimpleCard
  delayThumbnailGeneration : Boolean
[write-only] Delay the creation of the thumbnail image for this card.
ISimpleCard
  description : String
The description of this card's underlying attachment.
ISimpleCard
  doubleClickEnabled : Boolean
[write-only] Enable double clicking events.
ISimpleCard
  downSampleOK : Boolean
true if it is OK to scale down the image; otherwise false.
ISimpleCard
  dropShadowPreference : String
[read-only] Returns the preferred drop shadow effect for the card
ISimpleCard
  enableThumbnailGeneration : Boolean
Allow the creation of the thumbnail image for this card.
ISimpleCard
  fileName : String
[read-only] The file name of this card's underlying attachment.
ISimpleCard
  modDate : Date
[read-only] The modification date of this card's underlying attachment.
ISimpleCard
  padding : Point
[read-only] Get the padding around a card.
ISimpleCard
  previewComponent : IPreview
[read-only] Returns the preview component for this card.
ISimpleCard
  rollOverPreference : String
[read-only] Returns the preferred roll over effect for the card
ISimpleCard
  selected : Boolean
true if the item renderer can show itself as selected; otherwise false.
ISimpleCard
  size : uint
[read-only] The size of this card's underlying attachment, if it were to be uncompressed.
ISimpleCard
Public Methods
 MethodDefined By
  
getDimensionsUsingPreview(maxWidth:Number, maxHeight:Number):Point
Returns the width and height dimensions to use for the folder card.
ISimpleCard
  
invalidatePreview(invalidateModel:Boolean = false, generateThumb:Boolean = true):void
invalidates the current preview
ISimpleCard
  
setFocus():void
Give this simpleCard the focus.
ISimpleCard
  
updateRenderer(oldRenderer:ISimpleCard):void
Update the renderer to use for the basicCard
ISimpleCard
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
ISimpleCard
  
over
ISimpleCard
  
overAndSelected
ISimpleCard
  
selected
ISimpleCard
Property Detail
colorPaletteproperty
colorPalette:ColorPalette  [read-only]

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
compressedSizeproperty 
compressedSize:uint  [read-only]

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
creationDateproperty 
creationDate:Date  [read-only]

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
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 renderered. 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  [write-only]

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

Delay the creation of the thumbnail image for this card.


Implementation
    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]

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

Enable double clicking events.


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

true if it is OK to scale down the image; otherwise false.


Implementation
    public function get downSampleOK():Boolean
    public function set downSampleOK(value:Boolean):void
dropShadowPreferenceproperty 
dropShadowPreference:String  [read-only]

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

Returns the preferred drop shadow effect for the card


Implementation
    public function get dropShadowPreference():String
enableThumbnailGenerationproperty 
enableThumbnailGeneration:Boolean

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

Allow the creation of the thumbnail image for this card.


Implementation
    public function get enableThumbnailGeneration():Boolean
    public function set enableThumbnailGeneration(value:Boolean):void
fileNameproperty 
fileName:String  [read-only]

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
modDateproperty 
modDate:Date  [read-only]

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
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 padding around a card.


Implementation
    public function get padding():Point
previewComponentproperty 
previewComponent:IPreview  [read-only]

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

Returns the preview component for this card.


Implementation
    public function get previewComponent():IPreview
rollOverPreferenceproperty 
rollOverPreference:String  [read-only]

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

Returns the preferred roll over effect for the card


Implementation
    public function get rollOverPreference():String
selectedproperty 
selected:Boolean

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

true if the item renderer can show itself as selected; otherwise 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
sizeproperty 
size:uint  [read-only]

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
Method Detail
getDimensionsUsingPreview()method
public function getDimensionsUsingPreview(maxWidth:Number, maxHeight:Number):Point

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

Returns the width and height dimensions to use for the folder card. This will be based on the preview image, but is constrained by the fitWidth and fitHeight parameters.

Parameters

maxWidth:Number — The maximum width to allow
 
maxHeight:Number — The maximum height to allow

Returns
Point — The width and height to the image returns as an (x,y) pair.
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

invalidates the current preview

Parameters

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

setFocus()method 
public function setFocus():void

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

Give this simpleCard the focus.

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 basicCard

Parameters

oldRenderer:ISimpleCard — The renderer to use.




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

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