Package | com.adobe.portfolio.components |
Class | public class Welcome |
Inheritance | Welcome ![]() ![]() |
Default MXML PropertydataProvider
Property | Defined By | ||
---|---|---|---|
![]() | autoGeneratedLabel : String = CANVAS_PROPERTIES
The label string to be used when auto-generating a property context for this
canvas list. | CanvasList | |
![]() | autoGeneratedLabelKey : 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 | |
![]() | autoGenerateProperties : Boolean = false
A boolean indicating whether a property context should be auto-generated for
this canvas list. | CanvasList | |
![]() | backgroundColor : uint [read-only]
The background color of this canvas list. | CanvasList | |
![]() | backgroundGradientColor : uint [read-only]
The secondary color to be used for radial and linear gradient types. | CanvasList | |
![]() | backgroundGradientType : String [read-only]
The background gradient type of this canvas list. | CanvasList | |
![]() | backgroundOpacity : Number [read-only]
The background opacity of this canvas list. | CanvasList | |
closed : Boolean
True if this component is closed; false otherwise. | Welcome | ||
![]() | dataURL : String
The url location of the XML representing this canvas list, or null if it has
no url representation. | CanvasList | |
![]() | dirty : Boolean
True if this canvas has been changed and needs to be saved; false otherwise. | CanvasList | |
![]() | heightIfPresent : Number
heightIfPresent determines the height of this canvas list when the shouldDisplayCanvas is true;
the height is zero otherwise. | CanvasList | |
![]() | swfClass : String
The name of the Flash asset to be drawn over the background of this canvas list. | CanvasList | |
![]() | widthIfPresent : Number
widthIfPresent determines the width of this canvas list when the shouldDisplayCanvas is true;
the width is zero otherwise. | CanvasList |
Method | Defined By | ||
---|---|---|---|
Welcome()
Default constructor
| Welcome | ||
addListenAndWatch():void [override]
A function to add event listeners and change watchers required by this canvas list. | Welcome | ||
![]() | applyPresetPositions(presetDataSet:Vector.<CanvasItemData>):void
Sets the list of items to match those from a preset list. | CanvasList | |
![]() | loseContext():Boolean
Clears the property context for this canvas list as the current property context. | CanvasList | |
![]() | removeListenAndWatch():void
A function to clean up event listeners and change watchers required by this canvas list. | CanvasList | |
![]() | setBlankTemplate():Boolean
Sets the preset layout property list to its blank entry. | CanvasList | |
![]() | setCustomTemplate():Boolean
Sets the preset layout property list to its custom entry. | CanvasList | |
![]() | takeContext():Boolean
Sets the property context for this canvas list as the current property context. | CanvasList |
Method | Defined By | ||
---|---|---|---|
![]() | addImageAction(value:uint):void
Adds an image item to the canvas list. | CanvasList | |
![]() | addImageItem():void
Adds an image item to the canvas list. | CanvasList | |
![]() | addPropertyBindings():void
A function to add event listeners and change watchers for binding portfolio properties to this
canvas list. | CanvasList | |
![]() | addSwfAction(value:uint):void
Adds a swf item to the canvas list. | CanvasList | |
![]() | addSwfItem():void
Adds an swf item to the canvas list. | CanvasList | |
![]() | addTextAction(value:uint):void
Adds a text item to the canvas list. | CanvasList | |
![]() | addTextItem():void
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 | ||
getCurrentSkinState():String [override]
| Welcome | ||
![]() |
Returns the property representing the list of preset layouts. | CanvasList | |
![]() | onAddImageButtonClick(event:MouseEvent):void
Adds an image item to the canvas list. | CanvasList | |
![]() | 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 | ||
![]() | onMouseRoll(event:MouseEvent):void
Event listener for rollover events on this canvas list. | CanvasList | |
onNavHostEvent(event:CollectionManagerEvent):void [override]
Event listener invoked on CollectionManagerEvents. | Welcome | ||
onOpenClick(event:Event):void
Event listener for mouse clicks on the open button. | Welcome | ||
![]() | onRemoveButtonClick(event:MouseEvent):void
Remoeves selected items from the canvas list. | CanvasList | |
![]() | 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 | ||
refreshHideWelcome():void
Updates the hideCheckbox and closed property based on existing
cached session data. | Welcome | ||
![]() | removePropertyBindings():void
A function to clean up event listeners and change watchers for binding portfolio properties to this
canvas list. | CanvasList | |
![]() | setAuthoringMode(value:Boolean):void
A function invoked when authoring mode changes. | CanvasList | |
![]() | setBackgroundColor(value:Number):void
A function invoked when the background color property changes
| CanvasList | |
![]() | setBackgroundGradientIntensity(value:Number):void
A function invoked when the background gradient intensity property changes
| CanvasList | |
![]() | setBackgroundGradientType(value:PropertyValue):void
A function invoked when the background gradient type property changes
| CanvasList | |
![]() | setBackgroundOpacity(value:Number):void
A function invoked when the background opacity property changes
| CanvasList | |
![]() | setCanvasTemplate(value:PropertyValue):void
Sets the list of items to match those from a preset layout. | CanvasList | |
![]() | setCanvasXML(value:String):void
Initializes this canvas list from an XML representation. | CanvasList | |
![]() |
Sets up the property context for this canvas list, auto-generating it
if necessary. | CanvasList | |
![]() | shouldDisplayCanvas():Boolean
Returns true if this canvas list should be displayed; false otherwise. | CanvasList | |
![]() | updateActualHeight():void
Sets the height of this canvas list based on heightIfPresent and shouldDisplayCanvas. | CanvasList | |
![]() | updateActualWidth():void
Sets the width of this canvas list based on widthIfPresent and shouldDisplayCanvas. | CanvasList | |
![]() | updateGradientColor():void
Updates backgroundGradientColor according to the current state of the canvas list. | CanvasList |
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 | ||
---|---|---|---|---|
![]() | 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 | |
![]() | 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 | ||
![]() | 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 |
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 | ||
---|---|---|---|---|
![]() | CanvasList | |||
![]() | CanvasList | |||
![]() | CanvasList | |||
![]() | CanvasList | |||
closed | Welcome |
Constant | Defined By | ||
---|---|---|---|
![]() | BLANK_PRESET_NAME : String = blank [static]
A string literal representing the name of the blank preset layout. | CanvasList | |
![]() | CUSTOM_PRESET_NAME : String = custom [static]
A string literal representing the name of the custom preset layout. | CanvasList | |
![]() | SKIN_PART_ADD_IMAGE_BUTTON : String = addImageButton [static]
A string literal representing the name of the addImageButton skin part. | CanvasList | |
![]() | SKIN_PART_ADD_TEXT_BUTTON : String = addTextButton [static]
A string literal representing the name of the addTextButton skin part. | CanvasList | |
![]() | SKIN_PART_REMOVE_BUTTON : String = removeButton [static]
A string literal representing the name of the removeButton skin part. | CanvasList | |
![]() | SKIN_STATE_AUTHORING_NORMAL : String = authoringNormal [static]
A string literal representing the normal authoring state of this component's skin. | CanvasList | |
![]() | SKIN_STATE_AUTHORING_OVER : String = authoringOver [static]
A string literal representing the over authoring state of this component's skin. | CanvasList | |
![]() | SKIN_STATE_AUTHORING_OVER_AND_SELECTED : String = authoringOverAndSelected [static]
A string literal representing the overAndSelected authoring state of this component's skin. | CanvasList | |
![]() | SKIN_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 | ||
![]() | SKIN_STATE_DISABLED : String = disabled [static]
A string literal representing the disabled consumption state of this component's skin. | CanvasList | |
![]() | SKIN_STATE_NORMAL : String = normal [static]
A string literal representing the normal consumption state of this component's skin. | CanvasList | |
![]() | XML_ELEMENT_NAME : String = CanvasItems [static]
A string literal representing the element name used in the XML
representation of a CanvasList. | CanvasList |
closed | property |
closed:Boolean
True if this component is closed; false otherwise.
This property can be used as the source for data binding.
public function get closed():Boolean
public function set closed(value:Boolean):void
Welcome | () | Constructor |
public function Welcome()
Default constructor
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.
ReturnsPropertyContext |
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.
SKIN_STATE_CLOSED | Constant |
public static const SKIN_STATE_CLOSED:String = closed
A string literal representing the closed state of this component's skin.