Packagecom.adobe.portfolio.components
Classpublic class Welcome
InheritanceWelcome Inheritance CanvasList Inheritance spark.components.List

The Welcome class extends CanvasList to add support for user-customizable swf items, a close state, and Don't-show-again behavior.

Default MXML PropertydataProvider



Public Properties
 PropertyDefined By
 InheritedautoGeneratedLabel : String = CANVAS_PROPERTIES
The label string to be used when auto-generating a property context for this canvas list.
CanvasList
 InheritedautoGeneratedLabelKey : String = canvasProperties
The key for a localized string to be used for the label string when auto-generating a property context for this canvas list.
CanvasList
 InheritedautoGenerateProperties : Boolean = false
A boolean indicating whether a property context should be auto-generated for this canvas list.
CanvasList
 InheritedbackgroundColor : uint
[read-only] The background color of this canvas list.
CanvasList
 InheritedbackgroundGradientColor : uint
[read-only] The secondary color to be used for radial and linear gradient types.
CanvasList
 InheritedbackgroundGradientType : String
[read-only] The background gradient type of this canvas list.
CanvasList
 InheritedbackgroundOpacity : Number
[read-only] The background opacity of this canvas list.
CanvasList
  closed : Boolean
True if this component is closed; false otherwise.
Welcome
 InheriteddataURL : String
The url location of the XML representing this canvas list, or null if it has no url representation.
CanvasList
 Inheriteddirty : Boolean
True if this canvas has been changed and needs to be saved; false otherwise.
CanvasList
 InheritedheightIfPresent : Number
heightIfPresent determines the height of this canvas list when the shouldDisplayCanvas is true; the height is zero otherwise.
CanvasList
 InheritedswfClass : String
The name of the Flash asset to be drawn over the background of this canvas list.
CanvasList
 InheritedwidthIfPresent : Number
widthIfPresent determines the width of this canvas list when the shouldDisplayCanvas is true; the width is zero otherwise.
CanvasList
Protected Properties
 PropertyDefined By
 InheritedaddedPropertyBindings : Boolean = false
true if property bindings have been setup for this canvas list; false otherwise.
CanvasList
 InheritedaddImageWatcher : ChangeWatcher
A ChangeWatcher used to detect when the add image property action is invoked by the user.
CanvasList
 InheritedaddSwfWatcher : ChangeWatcher
A ChangeWatcher used to detect when the add swf property action is invoked by the user.
CanvasList
 InheritedaddTextWatcher : ChangeWatcher
A ChangeWatcher used to detect when the add text property action is invoked by the user.
CanvasList
 InheritedbackgroundColorWatcher : ChangeWatcher
A ChangeWatcher used to detect changes to the background color property.
CanvasList
 InheritedbackgroundGradientIntensity : Number
[read-only] The gradient intensity used to determine the secondary color for radial and linear gradient types.
CanvasList
 InheritedbackgroundGradientIntensityWatcher : ChangeWatcher
A ChangeWatcher used to detect changes to the gradient intensity property.
CanvasList
 InheritedbackgroundGradientTypeWatcher : ChangeWatcher
A ChangeWatcher used to detect changes to the gradient type property.
CanvasList
 InheritedbackgroundOpacityWatcher : ChangeWatcher
A ChangeWatcher used to detect changes to the background opacity property.
CanvasList
 InheritedtemplateWatcher : ChangeWatcher
A ChangeWatcher used to detect changes to the preset layout list property.
CanvasList
Public Methods
 MethodDefined By
  
Default constructor
Welcome
  
[override] A function to add event listeners and change watchers required by this canvas list.
Welcome
 Inherited
applyPresetPositions(presetDataSet:Vector.<CanvasItemData>):void
Sets the list of items to match those from a preset list.
CanvasList
 Inherited
loseContext():Boolean
Clears the property context for this canvas list as the current property context.
CanvasList
 Inherited
A function to clean up event listeners and change watchers required by this canvas list.
CanvasList
 Inherited
Sets the preset layout property list to its blank entry.
CanvasList
 Inherited
Sets the preset layout property list to its custom entry.
CanvasList
 Inherited
takeContext():Boolean
Sets the property context for this canvas list as the current property context.
CanvasList
Protected Methods
 MethodDefined By
 Inherited
addImageAction(value:uint):void
Adds an image item to the canvas list.
CanvasList
 Inherited
Adds an image item to the canvas list.
CanvasList
 Inherited
A function to add event listeners and change watchers for binding portfolio properties to this canvas list.
CanvasList
 Inherited
addSwfAction(value:uint):void
Adds a swf item to the canvas list.
CanvasList
 Inherited
addSwfItem():void
Adds an swf item to the canvas list.
CanvasList
 Inherited
addTextAction(value:uint):void
Adds a text item to the canvas list.
CanvasList
 Inherited
Adds a text item to the canvas list.
CanvasList
  
[override] Returns an auto-generated property context that can be used to represent this canvas lists properties.
Welcome
  
[override]
Welcome
 Inherited
Returns the property representing the list of preset layouts.
CanvasList
 Inherited
onAddImageButtonClick(event:MouseEvent):void
Adds an image item to the canvas list.
CanvasList
 Inherited
onAddTextButtonClick(event:MouseEvent):void
Adds a text item to the canvas list.
CanvasList
  
onCloseClick(event:Event):void
Event listener for mouse clicks on the close button.
Welcome
  
onHideChanged(event:Event):void
Event listener for changes to the hide checkbox.
Welcome
 Inherited
onMouseRoll(event:MouseEvent):void
Event listener for rollover events on this canvas list.
CanvasList
  
[override] Event listener invoked on CollectionManagerEvents.
Welcome
  
onOpenClick(event:Event):void
Event listener for mouse clicks on the open button.
Welcome
 Inherited
onRemoveButtonClick(event:MouseEvent):void
Remoeves selected items from the canvas list.
CanvasList
 Inherited
onRemoveItem(event:Event):void
Event listener invoked when a canvas item dispatches a remove event.
CanvasList
  
onRendererChange(event:RendererExistenceEvent):void
[override] Event listener called when canvas item renderers are added or removed.
Welcome
  
partAdded(partName:String, instance:Object):void
[override]
Welcome
  
partRemoved(partName:String, instance:Object):void
[override]
Welcome
  
Updates the hideCheckbox and closed property based on existing cached session data.
Welcome
 Inherited
A function to clean up event listeners and change watchers for binding portfolio properties to this canvas list.
CanvasList
 Inherited
setAuthoringMode(value:Boolean):void
A function invoked when authoring mode changes.
CanvasList
 Inherited
setBackgroundColor(value:Number):void
A function invoked when the background color property changes
CanvasList
 Inherited
A function invoked when the background gradient intensity property changes
CanvasList
 Inherited
A function invoked when the background gradient type property changes
CanvasList
 Inherited
setBackgroundOpacity(value:Number):void
A function invoked when the background opacity property changes
CanvasList
 Inherited
Sets the list of items to match those from a preset layout.
CanvasList
 Inherited
setCanvasXML(value:String):void
Initializes this canvas list from an XML representation.
CanvasList
 Inherited
Sets up the property context for this canvas list, auto-generating it if necessary.
CanvasList
 Inherited
Returns true if this canvas list should be displayed; false otherwise.
CanvasList
 Inherited
Sets the height of this canvas list based on heightIfPresent and shouldDisplayCanvas.
CanvasList
 Inherited
Sets the width of this canvas list based on widthIfPresent and shouldDisplayCanvas.
CanvasList
 Inherited
Updates backgroundGradientColor according to the current state of the canvas list.
CanvasList
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
 Inherited
addImageButton:spark.components.Button
Required: false Part Type: Static
addImageButton is the button control used to add an image item to this canvas list. It is an optional skin part, so not necessarily implemented for all skins.
CanvasList
 Inherited
addTextButton:spark.components.Button
Required: false Part Type: Static
addTextButton is the button control used to add a text item to this canvas list. It is an optional skin part, so not necessarily implemented for all skins.
CanvasList
  
closeButton:mx.core.IButton
Required: false Part Type: Static
A button used to dismiss the Welcome component.
Welcome
  
hideCheckbox:spark.components.CheckBox
Required: false Part Type: Static
A checkbox used to indicate that the Welcome component should not be displayed by default.
Welcome
  
openButton:mx.core.IButton
Required: false Part Type: Static
A button used to display the Welcome component.
Welcome
 Inherited
removeButton:spark.components.Button
Required: false Part Type: Static
removeButton is the button control used to remove selected items from this canvas list. It is an optional skin part, so not necessarily implemented for all skins.
CanvasList
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
 InheritedCanvasList
 InheritedCanvasList
 InheritedCanvasList
 InheritedCanvasList
  
closed
Welcome
Public Constants
 ConstantDefined By
 InheritedBLANK_PRESET_NAME : String = blank
[static] A string literal representing the name of the blank preset layout.
CanvasList
 InheritedCUSTOM_PRESET_NAME : String = custom
[static] A string literal representing the name of the custom preset layout.
CanvasList
 InheritedSKIN_PART_ADD_IMAGE_BUTTON : String = addImageButton
[static] A string literal representing the name of the addImageButton skin part.
CanvasList
 InheritedSKIN_PART_ADD_TEXT_BUTTON : String = addTextButton
[static] A string literal representing the name of the addTextButton skin part.
CanvasList
 InheritedSKIN_PART_REMOVE_BUTTON : String = removeButton
[static] A string literal representing the name of the removeButton skin part.
CanvasList
 InheritedSKIN_STATE_AUTHORING_NORMAL : String = authoringNormal
[static] A string literal representing the normal authoring state of this component's skin.
CanvasList
 InheritedSKIN_STATE_AUTHORING_OVER : String = authoringOver
[static] A string literal representing the over authoring state of this component's skin.
CanvasList
 InheritedSKIN_STATE_AUTHORING_OVER_AND_SELECTED : String = authoringOverAndSelected
[static] A string literal representing the overAndSelected authoring state of this component's skin.
CanvasList
 InheritedSKIN_STATE_AUTHORING_SELECTED : String = authoringSelected
[static] A string literal representing the selected authoring state of this component's skin.
CanvasList
  SKIN_STATE_CLOSED : String = closed
[static] A string literal representing the closed state of this component's skin.
Welcome
 InheritedSKIN_STATE_DISABLED : String = disabled
[static] A string literal representing the disabled consumption state of this component's skin.
CanvasList
 InheritedSKIN_STATE_NORMAL : String = normal
[static] A string literal representing the normal consumption state of this component's skin.
CanvasList
 InheritedXML_ELEMENT_NAME : String = CanvasItems
[static] A string literal representing the element name used in the XML representation of a CanvasList.
CanvasList
Protected Constants
 ConstantDefined By
 InheritedcollectionManager : CollectionManager
The navigator's CollectionManager instance.
CanvasList
Property Detail
closedproperty
closed:Boolean

True if this component is closed; false otherwise.

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


Implementation
    public function get closed():Boolean
    public function set closed(value:Boolean):void
Constructor Detail
Welcome()Constructor
public function Welcome()

Default constructor

Method Detail
addListenAndWatch()method
override public function addListenAndWatch():void

A function to add event listeners and change watchers required by this canvas list.

generatePropertyContext()method 
override protected function generatePropertyContext():PropertyContext

Returns an auto-generated property context that can be used to represent this canvas lists properties.

Returns
PropertyContext
getCurrentSkinState()method 
override protected function getCurrentSkinState():String

Returns
String
onCloseClick()method 
protected function onCloseClick(event:Event):void

Event listener for mouse clicks on the close button.

Parameters

event:Event

onHideChanged()method 
protected function onHideChanged(event:Event):void

Event listener for changes to the hide checkbox.

Parameters

event:Event

onNavHostEvent()method 
override protected function onNavHostEvent(event:CollectionManagerEvent):void

Event listener invoked on CollectionManagerEvents.

Parameters

event:CollectionManagerEvent

onOpenClick()method 
protected function onOpenClick(event:Event):void

Event listener for mouse clicks on the open button.

Parameters

event:Event

onRendererChange()method 
override protected function onRendererChange(event:RendererExistenceEvent):void

Event listener called when canvas item renderers are added or removed.

Parameters

event:RendererExistenceEvent

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

refreshHideWelcome()method 
protected function refreshHideWelcome():void

Updates the hideCheckbox and closed property based on existing cached session data.

Constant Detail
SKIN_STATE_CLOSEDConstant
public static const SKIN_STATE_CLOSED:String = closed

A string literal representing the closed state of this component's skin.