Packagecom.adobe.portfolio.components
Classpublic class OneUp
InheritanceOneUp Inheritance spark.components.SkinnableDataContainer

Default MXML PropertydataProvider


Public Properties
 PropertyDefined By
  bindableDataGroup : DataGroup
[read-only]
OneUp
  cardProvider : ICardProvider
[read-only]
OneUp
Protected Properties
 PropertyDefined By
  autoListen : AutoListen
OneUp
  cardLayout : ICardLayout
OneUp
  cardLayoutHelper : CardLayoutHelper
OneUp
Public Methods
 MethodDefined By
  
OneUp()
Default constructor for OneUp.
OneUp
  
setCurrentState(stateName:String, playTransition:Boolean = true):void
[override] Sets the state of the skin as well as the state of this instance.
OneUp
Protected Methods
 MethodDefined By
  
getCurrentSkinState():String
[override] Returns the current state of this instance, since its skins should have a matching set of states.
OneUp
  
handleFocusChange(event:NavHostEvent):void
OneUp
  
onCreationComplete(event:FlexEvent):void
OneUp
  
onHandledFocus(evt:NavLayoutEvent):void
onHandledFocus is used to ensure that the layout has successfully handled the layout of its initial focused attachment before transitioning in the remaining pieces of UI.
OneUp
  
onNavHostEvent(event:NavHostEvent):void
OneUp
  
onResize(event:ResizeEvent):void
OneUp
  
partAdded(partName:String, instance:Object):void
[override] Called when a skin has added a skin part for this instance.
OneUp
  
partRemoved(partName:String, instance:Object):void
[override] Called when a skin has removed a skin part for this instance.
OneUp
  
resizeCachedThumbs():void
OneUp
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
  
nextButton:mx.core.IButton
Required: false Part Type: Static
A button for navigating to the next attachment, optionally provided by this instance's skin.
OneUp
  
prevButton:mx.core.IButton
Required: false Part Type: Static
A button for navigating to the previous attachment, optionally provided by this instance's skin.
OneUp
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
  
empty
OneUp
  
normal
OneUp
  
preview
OneUp
Public Constants
 ConstantDefined By
  PART_NEXT_BUTTON : String = nextButton
[static]
OneUp
  PART_PREV_BUTTON : String = prevButton
[static] String literals used to represent the skin parts exposed by OneUp to its skins.
OneUp
  SKIN_STATE_EMPTY : String = empty
[static]
OneUp
  SKIN_STATE_NORMAL : String = normal
[static]
OneUp
  SKIN_STATE_PREVIEW : String = preview
[static]
OneUp
  STATE_NORMAL : String = normal
[static] String literals used to represent the states of OneUp and its skins.
OneUp
  STATE_PREVIEW : String = preview
[static]
OneUp
Protected Constants
 ConstantDefined By
  collectionMgr : CollectionManager
The navigator's CollectionManager instance.
OneUp
Property Detail
autoListenproperty
protected var autoListen:AutoListen

bindableDataGroupproperty 
bindableDataGroup:DataGroup  [read-only]

This property can be used as the source for data binding.


Implementation
    public function get bindableDataGroup():DataGroup
cardLayoutproperty 
protected var cardLayout:ICardLayout

cardLayoutHelperproperty 
protected var cardLayoutHelper:CardLayoutHelper

cardProviderproperty 
cardProvider:ICardProvider  [read-only]

This property can be used as the source for data binding.


Implementation
    public function get cardProvider():ICardProvider
Constructor Detail
OneUp()Constructor
public function OneUp()

Default constructor for OneUp.

Method Detail
getCurrentSkinState()method
override protected function getCurrentSkinState():String

Returns the current state of this instance, since its skins should have a matching set of states.

Returns
String
handleFocusChange()method 
protected function handleFocusChange(event:NavHostEvent):void

Parameters

event:NavHostEvent

onCreationComplete()method 
protected function onCreationComplete(event:FlexEvent):void

Parameters

event:FlexEvent

onHandledFocus()method 
protected function onHandledFocus(evt:NavLayoutEvent):void

onHandledFocus is used to ensure that the layout has successfully handled the layout of its initial focused attachment before transitioning in the remaining pieces of UI.

Parameters

evt:NavLayoutEvent

onNavHostEvent()method 
protected function onNavHostEvent(event:NavHostEvent):void

Parameters

event:NavHostEvent

onResize()method 
protected function onResize(event:ResizeEvent):void

Parameters

event:ResizeEvent

partAdded()method 
override protected function partAdded(partName:String, instance:Object):void

Called when a skin has added a skin part for this instance.

Parameters

partName:String
 
instance:Object

partRemoved()method 
override protected function partRemoved(partName:String, instance:Object):void

Called when a skin has removed a skin part for this instance.

Parameters

partName:String
 
instance:Object

resizeCachedThumbs()method 
protected function resizeCachedThumbs():void

setCurrentState()method 
override public function setCurrentState(stateName:String, playTransition:Boolean = true):void

Sets the state of the skin as well as the state of this instance.

Parameters

stateName:String
 
playTransition:Boolean (default = true)

Constant Detail
collectionMgrConstant
protected const collectionMgr:CollectionManager

The navigator's CollectionManager instance. All host interaction should go through this instance, rather than the INavigatorHost directly.

PART_NEXT_BUTTONConstant 
public static const PART_NEXT_BUTTON:String = nextButton

PART_PREV_BUTTONConstant 
public static const PART_PREV_BUTTON:String = prevButton

String literals used to represent the skin parts exposed by OneUp to its skins. XXX They should match the names of the SkinPart vars below.

SKIN_STATE_EMPTYConstant 
public static const SKIN_STATE_EMPTY:String = empty

SKIN_STATE_NORMALConstant 
public static const SKIN_STATE_NORMAL:String = normal

SKIN_STATE_PREVIEWConstant 
public static const SKIN_STATE_PREVIEW:String = preview

STATE_NORMALConstant 
public static const STATE_NORMAL:String = normal

String literals used to represent the states of OneUp and its skins. XXX They should match the SkinState references above.

STATE_PREVIEWConstant 
public static const STATE_PREVIEW:String = preview




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

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