com.adobe.portfolio.components.Header

Package	com.adobe.portfolio.components
Class	public class Header
Inheritance	Header CanvasList spark.components.List

The Header class extends CanvasList and specifies a header-specific xml resource file and designer skin.

Default MXML PropertydataProvider

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		autoGeneratedLabel : String = CANVAS_PROPERTIES	CanvasList
		autoGeneratedLabelKey : String = canvasProperties	CanvasList
		autoGenerateProperties : Boolean = false	CanvasList
		backgroundColor : uint [read-only]	CanvasList
		backgroundGradientColor : uint [read-only]	CanvasList
		backgroundGradientType : String [read-only]	CanvasList
		backgroundOpacity : Number [read-only]	CanvasList
		dataURL : String	CanvasList
		dirty : Boolean	CanvasList
		heightIfPresent : Number	CanvasList
		swfClass : String	CanvasList
		widthIfPresent : Number	CanvasList

Protected Properties

Hide Inherited Protected Properties

Show Inherited Protected Properties

	Property		Defined By
		addedPropertyBindings : Boolean = false	CanvasList
		addImageWatcher : ChangeWatcher	CanvasList
		addTextWatcher : ChangeWatcher	CanvasList
		backgroundColorWatcher : ChangeWatcher	CanvasList
		backgroundGradientIntensityWatcher : ChangeWatcher	CanvasList
		backgroundGradientTypeWatcher : ChangeWatcher	CanvasList
		backgroundOpacityWatcher : ChangeWatcher	CanvasList
		templateWatcher : ChangeWatcher	CanvasList

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		Header()	Header
		addListenAndWatch():void	CanvasList
		applyPresetPositions(presetDataSet:Vector.<CanvasItemData>):void	CanvasList
		loseContext():Boolean	CanvasList
		removeListenAndWatch():void	CanvasList
		setBlankTemplate():Boolean	CanvasList
		setCustomTemplate():Boolean	CanvasList
		takeContext():Boolean	CanvasList

Protected Methods

Show Inherited Protected Methods

	Method		Defined By
		addImageAction(value:uint):void	CanvasList
		addImageItem():void	CanvasList
		addPropertyBindings():void [override] Overrides bindings to the header properties so that they're bound to footer properties instead.	Header
		addTextAction(value:uint):void	CanvasList
		addTextItem():void	CanvasList
		generatePropertyContext():PropertyContext	CanvasList
		getCurrentSkinState():String [override]	CanvasList
		getTemplateProperty():PropertyListValue [override]	Header
		onAddImageButtonClick(event:MouseEvent):void	CanvasList
		onAddTextButtonClick(event:MouseEvent):void	CanvasList
		onMouseRoll(event:MouseEvent):void	CanvasList
		onNavHostEvent(event:NavHostEvent):void	CanvasList
		onRemoveButtonClick(event:MouseEvent):void	CanvasList
		onRemoveItem(event:Event):void	CanvasList
		onRendererChange(event:RendererExistenceEvent):void	CanvasList
		partAdded(partName:String, instance:Object):void [override] Called when a skin has added a skin part for this instance.	CanvasList
		partRemoved(partName:String, instance:Object):void [override] Called when a skin has removed a skin part for this instance.	CanvasList
		removePropertyBindings():void	CanvasList
		setAuthoringMode(value:Boolean):void	CanvasList
		setBackgroundColor(value:Number):void	CanvasList
		setBackgroundGradientIntensity(value:Number):void	CanvasList
		setBackgroundGradientType(value:PropertyValue):void	CanvasList
		setBackgroundOpacity(value:Number):void	CanvasList
		setCanvasTemplate(value:PropertyValue):void [override]	Header
		setCanvasXML(value:String):void	CanvasList
		setupContext():PropertyContext [override]	Header
		shouldDisplayCanvas():Boolean [override]	Header
		updateActualHeight():void	CanvasList
		updateActualWidth():void	CanvasList
		updateGradientColor():void	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.

Hide Inherited Skin Parts

Show Inherited Skin Parts

	Description	Defined By
addImageButton:spark.components.Button	Required: false Part Type: Static	CanvasList
addTextButton:spark.components.Button	Required: false Part Type: Static	CanvasList
removeButton:spark.components.Button	Required: false Part Type: Static	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.

Hide Inherited Skin States

Show Inherited Skin States

	Skin State		Description	Defined By
		authoringNormal		CanvasList
		authoringOver		CanvasList
		authoringOverAndSelected		CanvasList
		authoringSelected		CanvasList

Public Constants

Hide Inherited Public Constants

Show Inherited Public Constants

	Constant		Defined By
		BLANK_PRESET_NAME : String = blank [static]	CanvasList
		CUSTOM_PRESET_NAME : String = custom [static]	CanvasList
		SKIN_PART_ADD_IMAGE_BUTTON : String = addImageButton [static]	CanvasList
		SKIN_PART_ADD_TEXT_BUTTON : String = addTextButton [static]	CanvasList
		SKIN_PART_REMOVE_BUTTON : String = removeButton [static]	CanvasList
		SKIN_STATE_AUTHORING_NORMAL : String = authoringNormal [static]	CanvasList
		SKIN_STATE_AUTHORING_OVER : String = authoringOver [static]	CanvasList
		SKIN_STATE_AUTHORING_OVER_AND_SELECTED : String = authoringOverAndSelected [static]	CanvasList
		SKIN_STATE_AUTHORING_SELECTED : String = authoringSelected [static]	CanvasList
		SKIN_STATE_NORMAL : String = normal [static]	CanvasList
		XML_ELEMENT_NAME : String = CanvasItems [static]	CanvasList

Protected Constants

Hide Inherited Protected Constants

Show Inherited Protected Constants

	Constant		Defined By
		collectionManager : CollectionManager The navigator's CollectionManager instance.	CanvasList

Constructor Detail

Header

()

Constructor

public function Header()

Method Detail

addPropertyBindings

()

method

override protected function addPropertyBindings():void

Overrides bindings to the header properties so that they're bound to footer properties instead.

getTemplateProperty

()

method

override protected function getTemplateProperty():PropertyListValue

Returns

PropertyListValue

setCanvasTemplate

()

method

override protected function setCanvasTemplate(value:PropertyValue):void

Parameters

value:PropertyValue

setupContext

()

method

override protected function setupContext():PropertyContext

Returns

PropertyContext

shouldDisplayCanvas

()

method

override protected function shouldDisplayCanvas():Boolean

Returns

Boolean

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

API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Header	Properties \| Methods \| Skin Parts \| Skin States \| Constants