Package | com.adobe.portfolio.components.supportClasses |
Class | public class CanvasItem |
Inheritance | CanvasItem ![]() |
Implements | mx.managers.IFocusManagerComponent, spark.components.IItemRenderer, mx.controls.listClasses.IListItemRenderer, IListenAndWatch |
Property | Defined By | ||
---|---|---|---|
canvasData : CanvasItemData
The CanvasItemData object to be rendered. | CanvasItem | ||
data : Object
The data object to be renderered. | CanvasItem | ||
dragging : Boolean | CanvasItem | ||
imageOpacity : Number [read-only]
The opacity of the image component for this item. | CanvasItem | ||
itemIndex : int | CanvasItem | ||
label : String | CanvasItem | ||
playSWF : Boolean
True if SWF content within this component should be played; false otherwise. | CanvasItem | ||
selected : Boolean | CanvasItem | ||
showsCaret : Boolean | CanvasItem | ||
swfOpacity : Number [read-only]
The opacity of the swf component for this item. | CanvasItem |
Property | Defined By | ||
---|---|---|---|
imageContext : PropertyContext [read-only]
The property context used to represent the image properties for this item. | CanvasItem | ||
swfContext : PropertyContext [read-only]
The property context used to represent the swf properties for this item. | CanvasItem | ||
textContext : PropertyContext [read-only]
The property context used to represent the text properties for this item. | CanvasItem |
Method | Defined By | ||
---|---|---|---|
Default constructor
| CanvasItem | ||
addListenAndWatch():void
A function to add event listeners and change watchers required by this item. | CanvasItem | ||
loseContext():Boolean
Clears the property context for this item as the current property context. | CanvasItem | ||
removeListenAndWatch():void
A function to clean up event listeners and change watchers required by this item. | CanvasItem | ||
takeContext():Boolean
Sets the property context for this item as the current property context. | CanvasItem | ||
takeFocus():void
Gives focus to this item. | CanvasItem |
Method | Defined By | ||
---|---|---|---|
commitProperties():void [override]
| CanvasItem | ||
getCurrentSkinState():String [override]
| CanvasItem | ||
handleContainsPoint(handle:GraphicElement, point:Point):Boolean
Returns true if the given point is contained in the bounds of the given handle. | CanvasItem | ||
onDataPropertyChanged(event:PropertyChangeEvent):void
Event listener called when this item's data changes. | CanvasItem | ||
onMouseDoubleClick(event:MouseEvent):void
Event listener for double-click events on this item. | CanvasItem | ||
onMouseDown(event:MouseEvent):void
Event listener for mouseDown events on this item. | CanvasItem | ||
onMouseRoll(event:MouseEvent):void
Event listener for rollover events on this item. | CanvasItem | ||
onSetImageClick(event:MouseEvent):void
Event listener for click events on the image component skin part. | CanvasItem | ||
onSetSwfClick(event:MouseEvent):void
Event listener for click events on the swf component skin part. | CanvasItem | ||
onTextChange(event:TextOperationEvent):void
Event listener for text change events on the text area skin part. | CanvasItem | ||
partAdded(partName:String, instance:Object):void [override]
| CanvasItem | ||
partRemoved(partName:String, instance:Object):void [override]
| CanvasItem | ||
setAuthoringMode(value:Boolean):void
A function invoked when authoring mode changes. | CanvasItem |
Event | Summary | Defined By | ||
---|---|---|---|---|
Dispatched when the user requests that this item be removed from its parent. | CanvasItem |
This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.
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.
Constant | Defined By | ||
---|---|---|---|
EVENT_REMOVE : String = removeItem [static]
A string literal representing the name of the removeItem event. | CanvasItem | ||
SKIN_PART_HANDLE_BORDER : String = handleBorder [static]
A string literal representing the name of the handle border skin part. | CanvasItem | ||
SKIN_PART_HANDLE_BOTTOM_CENTER : String = handleBC [static]
A string literal representing the name of the bottom-center handle skin part. | CanvasItem | ||
SKIN_PART_HANDLE_BOTTOM_LEFT : String = handleBL [static]
A string literal representing the name of the bottom-left handle skin part. | CanvasItem | ||
SKIN_PART_HANDLE_BOTTOM_RIGHT : String = handleBR [static]
A string literal representing the name of the bottom-right handle skin part. | CanvasItem | ||
SKIN_PART_HANDLE_MIDDLE_LEFT : String = handleML [static]
A string literal representing the name of the middle-left handle skin part. | CanvasItem | ||
SKIN_PART_HANDLE_MIDDLE_RIGHT : String = handleMR [static]
A string literal representing the name of the middle-right handle skin part. | CanvasItem | ||
SKIN_PART_HANDLE_MOVE : String = handleMove [static]
A string literal representing the name of the handle move skin part. | CanvasItem | ||
SKIN_PART_HANDLE_TOP_CENTER : String = handleTC [static]
A string literal representing the name of the top-center handle skin part. | CanvasItem | ||
SKIN_PART_HANDLE_TOP_LEFT : String = handleTL [static]
A string literal representing the name of the top-left handle skin part. | CanvasItem | ||
SKIN_PART_HANDLE_TOP_RIGHT : String = handleTR [static]
A string literal representing the name of the top-right handle skin part. | CanvasItem | ||
SKIN_PART_IMAGE_COMPONENT : String = imageComponent [static]
A string literal representing the name of the image component skin part. | CanvasItem | ||
SKIN_PART_SET_IMAGE_BUTTON : String = setImageButton [static]
A string literal representing the name of the set image button skin part. | CanvasItem | ||
SKIN_PART_SWF_COMPONENT : String = swfComponent [static]
A string literal representing the name of the swf component skin part. | CanvasItem | ||
SKIN_PART_TEXT_AREA : String = textArea [static]
A string literal representing the name of the text area skin part. | CanvasItem | ||
SKIN_STATE_IMAGE_AUTHORING_NORMAL : String = imageAuthoringNormal [static]
A string literal representing the name of the normal image authoring state. | CanvasItem | ||
SKIN_STATE_IMAGE_AUTHORING_OVER : String = imageAuthoringOver [static]
A string literal representing the name of the over image authoring state. | CanvasItem | ||
SKIN_STATE_IMAGE_AUTHORING_OVER_AND_SELECTED : String = imageAuthoringOverAndSelected [static]
A string literal representing the name of the overAndSelected image authoring state. | CanvasItem | ||
SKIN_STATE_IMAGE_AUTHORING_SELECTED : String = imageAuthoringSelected [static]
A string literal representing the name of the selected image authoring state. | CanvasItem | ||
SKIN_STATE_IMAGE_NORMAL : String = imageNormal [static]
A string literal representing the name of the normal image consumption state. | CanvasItem | ||
SKIN_STATE_IMAGE_OVER : String = imageOver [static]
A string literal representing the name of the over image consumption state. | CanvasItem | ||
SKIN_STATE_IMAGE_OVER_AND_SELECTED : String = imageOverAndSelected [static]
A string literal representing the name of the overAndSelected image consumption state. | CanvasItem | ||
SKIN_STATE_IMAGE_SELECTED : String = imageSelected [static]
A string literal representing the name of the selected image comsumption state. | CanvasItem | ||
SKIN_STATE_SWF_AUTHORING_NORMAL : String = swfAuthoringNormal [static]
A string literal representing the name of the normal swf authoring state. | CanvasItem | ||
SKIN_STATE_SWF_AUTHORING_OVER : String = swfAuthoringOver [static]
A string literal representing the name of the over swf authoring state. | CanvasItem | ||
SKIN_STATE_SWF_AUTHORING_OVER_AND_SELECTED : String = swfAuthoringOverAndSelected [static]
A string literal representing the name of the overAndSelected swf authoring state. | CanvasItem | ||
SKIN_STATE_SWF_AUTHORING_SELECTED : String = swfAuthoringSelected [static]
A string literal representing the name of the selected swf authoring state. | CanvasItem | ||
SKIN_STATE_SWF_NORMAL : String = swfNormal [static]
A string literal representing the name of the normal swf consumption state. | CanvasItem | ||
SKIN_STATE_SWF_OVER : String = swfOver [static]
A string literal representing the name of the over swf consumption state. | CanvasItem | ||
SKIN_STATE_SWF_OVER_AND_SELECTED : String = swfOverAndSelected [static]
A string literal representing the name of the overAndSelected swf consumption state. | CanvasItem | ||
SKIN_STATE_SWF_SELECTED : String = swfSelected [static]
A string literal representing the name of the selected swf consumption state. | CanvasItem | ||
SKIN_STATE_TEXT_AUTHORING_NORMAL : String = textAuthoringNormal [static]
A string literal representing the name of the normal text authoring state. | CanvasItem | ||
SKIN_STATE_TEXT_AUTHORING_OVER : String = textAuthoringOver [static]
A string literal representing the name of the over text authoring state. | CanvasItem | ||
SKIN_STATE_TEXT_AUTHORING_OVER_AND_SELECTED : String = textAuthoringOverAndSelected [static]
A string literal representing the name of the overAndSelected text authoring state. | CanvasItem | ||
SKIN_STATE_TEXT_AUTHORING_SELECTED : String = textAuthoringSelected [static]
A string literal representing the name of the selected text authoring state. | CanvasItem | ||
SKIN_STATE_TEXT_NORMAL : String = textNormal [static]
A string literal representing the name of the normal text consumption state. | CanvasItem | ||
SKIN_STATE_TEXT_OVER : String = textOver [static]
A string literal representing the name of the over text consumption state. | CanvasItem | ||
SKIN_STATE_TEXT_OVER_AND_SELECTED : String = textOverAndSelected [static]
A string literal representing the name of the overAndSelected text consumption state. | CanvasItem | ||
SKIN_STATE_TEXT_SELECTED : String = textSelected [static]
A string literal representing the name of the selected text consumption state. | CanvasItem |
Constant | Defined By | ||
---|---|---|---|
collectionManager : CollectionManager [static]
The navigator's CollectionManager instance. | CanvasItem |
canvasData | property |
canvasData:CanvasItemData
The CanvasItemData object to be rendered.
This property can be used as the source for data binding.
public function get canvasData():CanvasItemData
public function set canvasData(value:CanvasItemData):void
data | property |
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 CanvasItemData objects are supported.
public function get data():Object
public function set data(value:Object):void
dragging | property |
dragging:Boolean
public function get dragging():Boolean
public function set dragging(value:Boolean):void
imageContext | property |
imageContext:PropertyContext
[read-only] The property context used to represent the image properties for this item.
protected function get imageContext():PropertyContext
imageOpacity | property |
imageOpacity:Number
[read-only] The opacity of the image component for this item.
This property can be used as the source for data binding.
public function get imageOpacity():Number
itemIndex | property |
itemIndex:int
public function get itemIndex():int
public function set itemIndex(value:int):void
label | property |
label:String
public function get label():String
public function set label(value:String):void
playSWF | property |
playSWF:Boolean
True if SWF content within this component should be played; false otherwise.
public function get playSWF():Boolean
public function set playSWF(value:Boolean):void
selected | property |
selected:Boolean
public function get selected():Boolean
public function set selected(value:Boolean):void
showsCaret | property |
showsCaret:Boolean
public function get showsCaret():Boolean
public function set showsCaret(value:Boolean):void
swfContext | property |
swfContext:PropertyContext
[read-only] The property context used to represent the swf properties for this item.
protected function get swfContext():PropertyContext
swfOpacity | property |
swfOpacity:Number
[read-only] The opacity of the swf component for this item.
This property can be used as the source for data binding.
public function get swfOpacity():Number
textContext | property |
textContext:PropertyContext
[read-only] The property context used to represent the text properties for this item.
protected function get textContext():PropertyContext
CanvasItem | () | Constructor |
public function CanvasItem()
Default constructor
addListenAndWatch | () | method |
public function addListenAndWatch():void
A function to add event listeners and change watchers required by this item.
commitProperties | () | method |
override protected function commitProperties():void
getCurrentSkinState | () | method |
override protected function getCurrentSkinState():String
Returns
String |
handleContainsPoint | () | method |
protected function handleContainsPoint(handle:GraphicElement, point:Point):Boolean
Returns true if the given point is contained in the bounds of the given handle.
Parameters
handle:GraphicElement | |
point:Point |
Boolean |
loseContext | () | method |
public function loseContext():Boolean
Clears the property context for this item as the current property context.
ReturnsBoolean |
See also
onDataPropertyChanged | () | method |
protected function onDataPropertyChanged(event:PropertyChangeEvent):void
Event listener called when this item's data changes.
Parameters
event:PropertyChangeEvent |
onMouseDoubleClick | () | method |
protected function onMouseDoubleClick(event:MouseEvent):void
Event listener for double-click events on this item.
Parameters
event:MouseEvent |
onMouseDown | () | method |
protected function onMouseDown(event:MouseEvent):void
Event listener for mouseDown events on this item.
Parameters
event:MouseEvent |
onMouseRoll | () | method |
protected function onMouseRoll(event:MouseEvent):void
Event listener for rollover events on this item.
Parameters
event:MouseEvent |
onSetImageClick | () | method |
protected function onSetImageClick(event:MouseEvent):void
Event listener for click events on the image component skin part.
Parameters
event:MouseEvent |
onSetSwfClick | () | method |
protected function onSetSwfClick(event:MouseEvent):void
Event listener for click events on the swf component skin part.
Parameters
event:MouseEvent |
onTextChange | () | method |
protected function onTextChange(event:TextOperationEvent):void
Event listener for text change events on the text area skin part.
Parameters
event:TextOperationEvent |
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 |
removeListenAndWatch | () | method |
public function removeListenAndWatch():void
A function to clean up event listeners and change watchers required by this item.
setAuthoringMode | () | method |
protected function setAuthoringMode(value:Boolean):void
A function invoked when authoring mode changes.
Parameters
value:Boolean |
takeContext | () | method |
public function takeContext():Boolean
Sets the property context for this item as the current property context.
ReturnsBoolean |
See also
takeFocus | () | method |
public function takeFocus():void
Gives focus to this item.
removeItem | Event |
flash.events.Event
Dispatched when the user requests that this item be removed from its parent.
collectionManager | Constant |
protected static const collectionManager:CollectionManager
The navigator's CollectionManager instance. All host interaction should go through this instance, rather than the INavigatorHost directly.
EVENT_REMOVE | Constant |
public static const EVENT_REMOVE:String = removeItem
A string literal representing the name of the removeItem event.
SKIN_PART_HANDLE_BORDER | Constant |
public static const SKIN_PART_HANDLE_BORDER:String = handleBorder
A string literal representing the name of the handle border skin part.
SKIN_PART_HANDLE_BOTTOM_CENTER | Constant |
public static const SKIN_PART_HANDLE_BOTTOM_CENTER:String = handleBC
A string literal representing the name of the bottom-center handle skin part.
SKIN_PART_HANDLE_BOTTOM_LEFT | Constant |
public static const SKIN_PART_HANDLE_BOTTOM_LEFT:String = handleBL
A string literal representing the name of the bottom-left handle skin part.
SKIN_PART_HANDLE_BOTTOM_RIGHT | Constant |
public static const SKIN_PART_HANDLE_BOTTOM_RIGHT:String = handleBR
A string literal representing the name of the bottom-right handle skin part.
SKIN_PART_HANDLE_MIDDLE_LEFT | Constant |
public static const SKIN_PART_HANDLE_MIDDLE_LEFT:String = handleML
A string literal representing the name of the middle-left handle skin part.
SKIN_PART_HANDLE_MIDDLE_RIGHT | Constant |
public static const SKIN_PART_HANDLE_MIDDLE_RIGHT:String = handleMR
A string literal representing the name of the middle-right handle skin part.
SKIN_PART_HANDLE_MOVE | Constant |
public static const SKIN_PART_HANDLE_MOVE:String = handleMove
A string literal representing the name of the handle move skin part.
SKIN_PART_HANDLE_TOP_CENTER | Constant |
public static const SKIN_PART_HANDLE_TOP_CENTER:String = handleTC
A string literal representing the name of the top-center handle skin part.
SKIN_PART_HANDLE_TOP_LEFT | Constant |
public static const SKIN_PART_HANDLE_TOP_LEFT:String = handleTL
A string literal representing the name of the top-left handle skin part.
SKIN_PART_HANDLE_TOP_RIGHT | Constant |
public static const SKIN_PART_HANDLE_TOP_RIGHT:String = handleTR
A string literal representing the name of the top-right handle skin part.
SKIN_PART_IMAGE_COMPONENT | Constant |
public static const SKIN_PART_IMAGE_COMPONENT:String = imageComponent
A string literal representing the name of the image component skin part.
SKIN_PART_SET_IMAGE_BUTTON | Constant |
public static const SKIN_PART_SET_IMAGE_BUTTON:String = setImageButton
A string literal representing the name of the set image button skin part.
SKIN_PART_SWF_COMPONENT | Constant |
public static const SKIN_PART_SWF_COMPONENT:String = swfComponent
A string literal representing the name of the swf component skin part.
SKIN_PART_TEXT_AREA | Constant |
public static const SKIN_PART_TEXT_AREA:String = textArea
A string literal representing the name of the text area skin part.
SKIN_STATE_IMAGE_AUTHORING_NORMAL | Constant |
public static const SKIN_STATE_IMAGE_AUTHORING_NORMAL:String = imageAuthoringNormal
A string literal representing the name of the normal image authoring state.
SKIN_STATE_IMAGE_AUTHORING_OVER | Constant |
public static const SKIN_STATE_IMAGE_AUTHORING_OVER:String = imageAuthoringOver
A string literal representing the name of the over image authoring state.
SKIN_STATE_IMAGE_AUTHORING_OVER_AND_SELECTED | Constant |
public static const SKIN_STATE_IMAGE_AUTHORING_OVER_AND_SELECTED:String = imageAuthoringOverAndSelected
A string literal representing the name of the overAndSelected image authoring state.
SKIN_STATE_IMAGE_AUTHORING_SELECTED | Constant |
public static const SKIN_STATE_IMAGE_AUTHORING_SELECTED:String = imageAuthoringSelected
A string literal representing the name of the selected image authoring state.
SKIN_STATE_IMAGE_NORMAL | Constant |
public static const SKIN_STATE_IMAGE_NORMAL:String = imageNormal
A string literal representing the name of the normal image consumption state.
SKIN_STATE_IMAGE_OVER | Constant |
public static const SKIN_STATE_IMAGE_OVER:String = imageOver
A string literal representing the name of the over image consumption state.
SKIN_STATE_IMAGE_OVER_AND_SELECTED | Constant |
public static const SKIN_STATE_IMAGE_OVER_AND_SELECTED:String = imageOverAndSelected
A string literal representing the name of the overAndSelected image consumption state.
SKIN_STATE_IMAGE_SELECTED | Constant |
public static const SKIN_STATE_IMAGE_SELECTED:String = imageSelected
A string literal representing the name of the selected image comsumption state.
SKIN_STATE_SWF_AUTHORING_NORMAL | Constant |
public static const SKIN_STATE_SWF_AUTHORING_NORMAL:String = swfAuthoringNormal
A string literal representing the name of the normal swf authoring state.
SKIN_STATE_SWF_AUTHORING_OVER | Constant |
public static const SKIN_STATE_SWF_AUTHORING_OVER:String = swfAuthoringOver
A string literal representing the name of the over swf authoring state.
SKIN_STATE_SWF_AUTHORING_OVER_AND_SELECTED | Constant |
public static const SKIN_STATE_SWF_AUTHORING_OVER_AND_SELECTED:String = swfAuthoringOverAndSelected
A string literal representing the name of the overAndSelected swf authoring state.
SKIN_STATE_SWF_AUTHORING_SELECTED | Constant |
public static const SKIN_STATE_SWF_AUTHORING_SELECTED:String = swfAuthoringSelected
A string literal representing the name of the selected swf authoring state.
SKIN_STATE_SWF_NORMAL | Constant |
public static const SKIN_STATE_SWF_NORMAL:String = swfNormal
A string literal representing the name of the normal swf consumption state.
SKIN_STATE_SWF_OVER | Constant |
public static const SKIN_STATE_SWF_OVER:String = swfOver
A string literal representing the name of the over swf consumption state.
SKIN_STATE_SWF_OVER_AND_SELECTED | Constant |
public static const SKIN_STATE_SWF_OVER_AND_SELECTED:String = swfOverAndSelected
A string literal representing the name of the overAndSelected swf consumption state.
SKIN_STATE_SWF_SELECTED | Constant |
public static const SKIN_STATE_SWF_SELECTED:String = swfSelected
A string literal representing the name of the selected swf consumption state.
SKIN_STATE_TEXT_AUTHORING_NORMAL | Constant |
public static const SKIN_STATE_TEXT_AUTHORING_NORMAL:String = textAuthoringNormal
A string literal representing the name of the normal text authoring state.
SKIN_STATE_TEXT_AUTHORING_OVER | Constant |
public static const SKIN_STATE_TEXT_AUTHORING_OVER:String = textAuthoringOver
A string literal representing the name of the over text authoring state.
SKIN_STATE_TEXT_AUTHORING_OVER_AND_SELECTED | Constant |
public static const SKIN_STATE_TEXT_AUTHORING_OVER_AND_SELECTED:String = textAuthoringOverAndSelected
A string literal representing the name of the overAndSelected text authoring state.
SKIN_STATE_TEXT_AUTHORING_SELECTED | Constant |
public static const SKIN_STATE_TEXT_AUTHORING_SELECTED:String = textAuthoringSelected
A string literal representing the name of the selected text authoring state.
SKIN_STATE_TEXT_NORMAL | Constant |
public static const SKIN_STATE_TEXT_NORMAL:String = textNormal
A string literal representing the name of the normal text consumption state.
SKIN_STATE_TEXT_OVER | Constant |
public static const SKIN_STATE_TEXT_OVER:String = textOver
A string literal representing the name of the over text consumption state.
SKIN_STATE_TEXT_OVER_AND_SELECTED | Constant |
public static const SKIN_STATE_TEXT_OVER_AND_SELECTED:String = textOverAndSelected
A string literal representing the name of the overAndSelected text consumption state.
SKIN_STATE_TEXT_SELECTED | Constant |
public static const SKIN_STATE_TEXT_SELECTED:String = textSelected
A string literal representing the name of the selected text consumption state.