Packagecom.adobe.portfolio.components.supportClasses
Classpublic class SessionTextArea
InheritanceSessionTextArea Inheritance CustomizableTextArea Inheritance spark.components.TextArea

A text component whose value is loaded and stored in a portfolio's session data, similar to a cookie.

Default MXML Propertycontent

See also

ICollection.getSessionData
ICollection.getSessionData


Public Properties
 PropertyDefined By
 InheritedallowStyling : Boolean
A boolean indicating whether or not this component supports styled text.
CustomizableTextArea
 InheritedforceMeasuredWidth : Number
The number to be used as the measuredWidth when measure() is called for this component.
CustomizableTextArea
 Inheritedmultiline : Boolean
A boolean indicating whether or not this component supports multiline text.
CustomizableTextArea
  sessionKey : String
The key used to load and store session data for this component.
SessionTextArea
Protected Properties
 PropertyDefined By
 InheritedpendingChanges : Boolean = false
True if changes to the text have been made that have not yet been applied.
CustomizableTextArea
Public Methods
 MethodDefined By
  
Default constructor.
SessionTextArea
 Inherited
A function to add event listeners and change watchers required by this canvas list.
CustomizableTextArea
 Inherited
Clears the property context for this text component as the current property context.
CustomizableTextArea
 Inherited
A function to clean up event listeners and change watchers required by this canvas list.
CustomizableTextArea
 Inherited
Sets the property context for this text component as the current property context.
CustomizableTextArea
 Inherited
textAreaHasFocus(focusManager:IFocusManager):Boolean
[static] Return true if a TextArea component currently has focus.
CustomizableTextArea
Protected Methods
 MethodDefined By
 Inherited
[override]
CustomizableTextArea
 Inherited
measure():void
[override]
CustomizableTextArea
 Inherited
onCreationComplete(event:FlexEvent):void
Event listener invoked when this component is created..
CustomizableTextArea
  
[override] Event listener invoked on CollectionManagerEvents.
SessionTextArea
  
An event listener that is called when session data for a portfolio is changed.
SessionTextArea
 Inherited
onTextChanged(event:TextOperationEvent):void
Event listener invoked when this components text is changed by the user.
CustomizableTextArea
 Inherited
partAdded(partName:String, instance:Object):void
[override]
CustomizableTextArea
  
[override] Updates the current session value based on the displayed text.
SessionTextArea
 Inherited
setTextDirection(textStr:String):void
A function that is invoked when the text direction is changed.
CustomizableTextArea
  
[override] Updates the displayed text based on the current session value.
SessionTextArea
  
[override] Returns true if this component should be editable by the user.
SessionTextArea
 Inherited
Updates the editable state of this component based on current state.
CustomizableTextArea
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
 Inherited The disabled state for multiline text. CustomizableTextArea
 Inherited The editable state for multiline text. CustomizableTextArea
 Inherited The normal state for multiline text. CustomizableTextArea
Public Constants
 ConstantDefined By
 InheritedSTATE_DISABLED : String = disabled
[static] A string literal representing the name of the disabled state.
CustomizableTextArea
 InheritedSTATE_DISABLED_MULTILINE : String = disabledMultiline
[static] A string literal representing the name of the disabled multiline state.
CustomizableTextArea
 InheritedSTATE_EDITABLE : String = editable
[static] A string literal representing the name of the editable state.
CustomizableTextArea
 InheritedSTATE_EDITABLE_MULTILINE : String = editableMultiline
[static] A string literal representing the name of the editable multiline state.
CustomizableTextArea
 InheritedSTATE_NORMAL : String = normal
[static] A string literal representing the name of the normal state.
CustomizableTextArea
 InheritedSTATE_NORMAL_MULTILINE : String = normalMultiline
[static] A string literal representing the name of the normal multiline state.
CustomizableTextArea
Protected Constants
 ConstantDefined By
 InheritedcollectionManager : CollectionManager
[static] The navigator's CollectionManager instance.
CustomizableTextArea
Property Detail
sessionKeyproperty
sessionKey:String

The key used to load and store session data for this component.

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


Implementation
    public function get sessionKey():String
    public function set sessionKey(value:String):void
Constructor Detail
SessionTextArea()Constructor
public function SessionTextArea()

Default constructor.

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

Event listener invoked on CollectionManagerEvents.

Parameters

event:CollectionManagerEvent

onSessionDataChanged()method 
protected function onSessionDataChanged(event:SessionDataChangedEvent):void

An event listener that is called when session data for a portfolio is changed.

Parameters

event:SessionDataChangedEvent

See also

ICollection.setSessionData
SessionDataChangedEvent
setDataFromText()method 
override protected function setDataFromText():void

Updates the current session value based on the displayed text. Applies pending text changes to the data model. Subclasses should override this function.

setTextFromData()method 
override protected function setTextFromData():void

Updates the displayed text based on the current session value. Updates this component's text based on the data model. Subclasses should override this function.

shouldBeEditable()method 
override protected function shouldBeEditable():Boolean

Returns true if this component should be editable by the user.

Returns
Boolean