ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Hide Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes

Language Reference only
Filters: AIR 32.0 and earlier, Flash Player 32.0 and earlier, Flash Lite 4
Flex 4.6 and earlier, Flash Pro CS6 and earlier
Hide Filters
flashx.textLayout.edit 

SelectionManager  - AS3

Packagesx

Top Level
adobe.utils
air.desktop
air.net
air.update
air.update.events
coldfusion.air
coldfusion.air.errors
coldfusion.air.events
coldfusion.service
coldfusion.service.events
coldfusion.service.mxml
com.adobe.acm.solutions.authoring.domain.extensions
com.adobe.acm.solutions.ccr.domain.extensions
com.adobe.consulting.pst.vo
com.adobe.dct.component
com.adobe.dct.component.datadictionary
com.adobe.dct.component.datadictionaryElement
com.adobe.dct.component.dataElementsPanel
com.adobe.dct.component.toolbars
com.adobe.dct.event
com.adobe.dct.exp
com.adobe.dct.model
com.adobe.dct.service
com.adobe.dct.service.provider
com.adobe.dct.transfer
com.adobe.dct.util
com.adobe.dct.view
com.adobe.ep.taskmanagement.domain
com.adobe.ep.taskmanagement.event
com.adobe.ep.taskmanagement.filter
com.adobe.ep.taskmanagement.services
com.adobe.ep.taskmanagement.util
com.adobe.ep.ux.attachmentlist.component
com.adobe.ep.ux.attachmentlist.domain
com.adobe.ep.ux.attachmentlist.domain.events
com.adobe.ep.ux.attachmentlist.domain.renderers
com.adobe.ep.ux.attachmentlist.skin
com.adobe.ep.ux.attachmentlist.skin.renderers
com.adobe.ep.ux.content.event
com.adobe.ep.ux.content.factory
com.adobe.ep.ux.content.handlers
com.adobe.ep.ux.content.managers
com.adobe.ep.ux.content.model.asset
com.adobe.ep.ux.content.model.preview
com.adobe.ep.ux.content.model.relation
com.adobe.ep.ux.content.model.search
com.adobe.ep.ux.content.model.toolbar
com.adobe.ep.ux.content.search
com.adobe.ep.ux.content.services
com.adobe.ep.ux.content.services.load
com.adobe.ep.ux.content.services.permissions
com.adobe.ep.ux.content.services.preview
com.adobe.ep.ux.content.services.providers
com.adobe.ep.ux.content.services.query
com.adobe.ep.ux.content.services.relationships
com.adobe.ep.ux.content.services.search.lccontent
com.adobe.ep.ux.content.services.version
com.adobe.ep.ux.content.view
com.adobe.ep.ux.content.view.components.activate
com.adobe.ep.ux.content.view.components.grid
com.adobe.ep.ux.content.view.components.grid.hover
com.adobe.ep.ux.content.view.components.grid.hover.component
com.adobe.ep.ux.content.view.components.grid.renderers
com.adobe.ep.ux.content.view.components.relationships
com.adobe.ep.ux.content.view.components.review
com.adobe.ep.ux.content.view.components.search.renderers
com.adobe.ep.ux.content.view.components.searchpod
com.adobe.ep.ux.content.view.components.toolbar
com.adobe.ep.ux.content.view.components.toolbar.controlRenderers
com.adobe.ep.ux.content.view.components.version
com.adobe.ep.ux.documentsubmit.component
com.adobe.ep.ux.documentsubmit.domain
com.adobe.ep.ux.documentsubmit.skin
com.adobe.ep.ux.taskaction.component
com.adobe.ep.ux.taskaction.domain
com.adobe.ep.ux.taskaction.domain.events
com.adobe.ep.ux.taskaction.skin
com.adobe.ep.ux.taskdetails.component
com.adobe.ep.ux.taskdetails.domain
com.adobe.ep.ux.taskdetails.skin
com.adobe.ep.ux.tasklist.component
com.adobe.ep.ux.tasklist.domain
com.adobe.ep.ux.tasklist.skin
com.adobe.ep.ux.webdocumentviewer.domain
com.adobe.exm.expression
com.adobe.exm.expression.error
com.adobe.exm.expression.event
com.adobe.exm.expression.impl
com.adobe.fiber.runtime.lib
com.adobe.fiber.services
com.adobe.fiber.services.wrapper
com.adobe.fiber.styles
com.adobe.fiber.util
com.adobe.fiber.valueobjects
com.adobe.gravity.binding
com.adobe.gravity.context
com.adobe.gravity.flex.bundleloader
com.adobe.gravity.flex.progress
com.adobe.gravity.flex.serviceloader
com.adobe.gravity.framework
com.adobe.gravity.init
com.adobe.gravity.service.bundleloader
com.adobe.gravity.service.logging
com.adobe.gravity.service.manifest
com.adobe.gravity.service.progress
com.adobe.gravity.tracker
com.adobe.gravity.ui
com.adobe.gravity.utility
com.adobe.gravity.utility.async
com.adobe.gravity.utility.error
com.adobe.gravity.utility.events
com.adobe.gravity.utility.factory
com.adobe.gravity.utility.flex.async
com.adobe.gravity.utility.logging
com.adobe.gravity.utility.message
com.adobe.gravity.utility.sequence
com.adobe.gravity.utility.url
com.adobe.guides.control
com.adobe.guides.domain
com.adobe.guides.i18n
com.adobe.guides.spark.components.skins
com.adobe.guides.spark.components.skins.mx
com.adobe.guides.spark.headers.components
com.adobe.guides.spark.headers.skins
com.adobe.guides.spark.layouts.components
com.adobe.guides.spark.layouts.skins
com.adobe.guides.spark.navigators.components
com.adobe.guides.spark.navigators.renderers
com.adobe.guides.spark.navigators.skins
com.adobe.guides.spark.util
com.adobe.guides.spark.wrappers.components
com.adobe.guides.spark.wrappers.skins
com.adobe.guides.submit
com.adobe.icc.dc.domain
com.adobe.icc.dc.domain.factory
com.adobe.icc.editors.events
com.adobe.icc.editors.handlers
com.adobe.icc.editors.managers
com.adobe.icc.editors.model
com.adobe.icc.editors.model.config
com.adobe.icc.editors.model.el
com.adobe.icc.editors.model.el.operands
com.adobe.icc.editors.model.el.operators
com.adobe.icc.enum
com.adobe.icc.external.dc
com.adobe.icc.obj
com.adobe.icc.services
com.adobe.icc.services.category
com.adobe.icc.services.config
com.adobe.icc.services.download
com.adobe.icc.services.export
com.adobe.icc.services.external
com.adobe.icc.services.formbridge
com.adobe.icc.services.fragmentlayout
com.adobe.icc.services.layout
com.adobe.icc.services.letter
com.adobe.icc.services.locator
com.adobe.icc.services.module
com.adobe.icc.services.render
com.adobe.icc.services.submit
com.adobe.icc.services.user
com.adobe.icc.token
com.adobe.icc.vo
com.adobe.icc.vo.render
com.adobe.icomm.assetplacement.controller
com.adobe.icomm.assetplacement.controller.utils
com.adobe.icomm.assetplacement.data
com.adobe.icomm.assetplacement.model
com.adobe.livecycle.assetmanager.client
com.adobe.livecycle.assetmanager.client.event
com.adobe.livecycle.assetmanager.client.handler
com.adobe.livecycle.assetmanager.client.managers
com.adobe.livecycle.assetmanager.client.model
com.adobe.livecycle.assetmanager.client.model.cms
com.adobe.livecycle.assetmanager.client.service
com.adobe.livecycle.assetmanager.client.service.search
com.adobe.livecycle.assetmanager.client.service.search.cms
com.adobe.livecycle.assetmanager.client.utils
com.adobe.livecycle.content
com.adobe.livecycle.rca.model
com.adobe.livecycle.rca.model.constant
com.adobe.livecycle.rca.model.document
com.adobe.livecycle.rca.model.participant
com.adobe.livecycle.rca.model.reminder
com.adobe.livecycle.rca.model.stage
com.adobe.livecycle.rca.service
com.adobe.livecycle.rca.service.core
com.adobe.livecycle.rca.service.core.delegate
com.adobe.livecycle.rca.service.process
com.adobe.livecycle.rca.service.process.delegate
com.adobe.livecycle.rca.token
com.adobe.livecycle.ria.security.api
com.adobe.livecycle.ria.security.service
com.adobe.mosaic.layouts
com.adobe.mosaic.layouts.dragAndDrop
com.adobe.mosaic.layouts.interfaces
com.adobe.mosaic.mxml
com.adobe.mosaic.om.constants
com.adobe.mosaic.om.events
com.adobe.mosaic.om.impl
com.adobe.mosaic.om.interfaces
com.adobe.mosaic.skinning
com.adobe.mosaic.sparklib.editors
com.adobe.mosaic.sparklib.optionMenu
com.adobe.mosaic.sparklib.scrollableMenu
com.adobe.mosaic.sparklib.scrollableMenu.skins
com.adobe.mosaic.sparklib.tabLayout
com.adobe.mosaic.sparklib.tabLayout.events
com.adobe.mosaic.sparklib.tabLayout.layouts
com.adobe.mosaic.sparklib.tabLayout.skins
com.adobe.mosaic.sparklib.text
com.adobe.mosaic.sparklib.util
com.adobe.solutions.acm.authoring.presentation
com.adobe.solutions.acm.authoring.presentation.actionbar
com.adobe.solutions.acm.authoring.presentation.common
com.adobe.solutions.acm.authoring.presentation.events
com.adobe.solutions.acm.authoring.presentation.fragment
com.adobe.solutions.acm.authoring.presentation.letter
com.adobe.solutions.acm.authoring.presentation.letter.data
com.adobe.solutions.acm.authoring.presentation.preview
com.adobe.solutions.acm.authoring.presentation.rte
com.adobe.solutions.acm.ccr.presentation
com.adobe.solutions.acm.ccr.presentation.contentcapture
com.adobe.solutions.acm.ccr.presentation.contentcapture.events
com.adobe.solutions.acm.ccr.presentation.contentcapture.preview
com.adobe.solutions.acm.ccr.presentation.datacapture
com.adobe.solutions.acm.ccr.presentation.datacapture.renderers
com.adobe.solutions.acm.ccr.presentation.pdf
com.adobe.solutions.exm
com.adobe.solutions.exm.authoring
com.adobe.solutions.exm.authoring.components.controls
com.adobe.solutions.exm.authoring.components.toolbars
com.adobe.solutions.exm.authoring.domain
com.adobe.solutions.exm.authoring.domain.expression
com.adobe.solutions.exm.authoring.domain.impl
com.adobe.solutions.exm.authoring.domain.method
com.adobe.solutions.exm.authoring.domain.variable
com.adobe.solutions.exm.authoring.enum
com.adobe.solutions.exm.authoring.events
com.adobe.solutions.exm.authoring.model
com.adobe.solutions.exm.authoring.renderer
com.adobe.solutions.exm.authoring.view
com.adobe.solutions.exm.expression
com.adobe.solutions.exm.impl
com.adobe.solutions.exm.impl.method
com.adobe.solutions.exm.method
com.adobe.solutions.exm.mock
com.adobe.solutions.exm.mock.method
com.adobe.solutions.exm.runtime
com.adobe.solutions.exm.runtime.impl
com.adobe.solutions.exm.variable
com.adobe.solutions.prm.constant
com.adobe.solutions.prm.domain
com.adobe.solutions.prm.domain.factory
com.adobe.solutions.prm.domain.impl
com.adobe.solutions.prm.domain.manager
com.adobe.solutions.prm.presentation.asset
com.adobe.solutions.prm.presentation.constant
com.adobe.solutions.prm.presentation.document
com.adobe.solutions.prm.presentation.event
com.adobe.solutions.prm.presentation.file
com.adobe.solutions.prm.presentation.project
com.adobe.solutions.prm.presentation.team
com.adobe.solutions.prm.presentation.util
com.adobe.solutions.prm.service
com.adobe.solutions.prm.services.impl
com.adobe.solutions.prm.vo
com.adobe.solutions.rca.constant
com.adobe.solutions.rca.domain
com.adobe.solutions.rca.domain.common
com.adobe.solutions.rca.domain.factory
com.adobe.solutions.rca.domain.impl
com.adobe.solutions.rca.domain.impl.manager
com.adobe.solutions.rca.domain.manager
com.adobe.solutions.rca.presentation
com.adobe.solutions.rca.presentation.comment
com.adobe.solutions.rca.presentation.constant
com.adobe.solutions.rca.presentation.event
com.adobe.solutions.rca.presentation.gantt
com.adobe.solutions.rca.presentation.gantt.ruler
com.adobe.solutions.rca.presentation.template
com.adobe.solutions.rca.presentation.template.audit
com.adobe.solutions.rca.presentation.template.definition
com.adobe.solutions.rca.presentation.template.documents
com.adobe.solutions.rca.presentation.template.stages
com.adobe.solutions.rca.presentation.util
com.adobe.solutions.rca.service
com.adobe.solutions.rca.services.impl
com.adobe.solutions.rca.vo
com.adobe.solutions.rca.vo.um
com.adobe.viewsource
fl.accessibility
fl.containers
fl.controls
fl.controls.dataGridClasses
fl.controls.listClasses
fl.controls.progressBarClasses
fl.core
fl.data
fl.display
fl.events
fl.ik
fl.lang
fl.livepreview
fl.managers
fl.motion
fl.motion.easing
fl.rsl
fl.text
fl.transitions
fl.transitions.easing
fl.video
flash.accessibility
flash.concurrent
flash.crypto
flash.data
flash.desktop
flash.display
flash.display3D
flash.display3D.textures
flash.errors
flash.events
flash.external
flash.filesystem
flash.filters
flash.geom
flash.globalization
flash.html
flash.media
flash.net
flash.net.dns
flash.net.drm
flash.notifications
flash.permissions
flash.printing
flash.profiler
flash.sampler
flash.security
flash.sensors
flash.system
flash.text
flash.text.engine
flash.text.ime
flash.ui
flash.utils
flash.xml
flashx.textLayout
flashx.textLayout.compose
flashx.textLayout.container
flashx.textLayout.conversion
flashx.textLayout.edit
flashx.textLayout.elements
flashx.textLayout.events
flashx.textLayout.factory
flashx.textLayout.formats
flashx.textLayout.operations
flashx.textLayout.utils
flashx.undo
ga.controls
ga.layouts
ga.model
ga.uiComponents
ga.util
ga.views
ga.wrappers
lc.foundation
lc.foundation.domain
lc.foundation.events
lc.foundation.ui
lc.foundation.util
lc.preloader
lc.procmgmt
lc.procmgmt.commands
lc.procmgmt.domain
lc.procmgmt.events
lc.procmgmt.formbridge
lc.procmgmt.impl
lc.procmgmt.ui.attachments
lc.procmgmt.ui.controls
lc.procmgmt.ui.controls.card
lc.procmgmt.ui.controls.renderer
lc.procmgmt.ui.help
lc.procmgmt.ui.layout
lc.procmgmt.ui.presentationmodel
lc.procmgmt.ui.process
lc.procmgmt.ui.search
lc.procmgmt.ui.startpoint
lc.procmgmt.ui.task
lc.procmgmt.ui.task.form
lc.procmgmt.ui.task.form.commands
lc.procmgmt.ui.tracking
mx.accessibility
mx.automation
mx.automation.air
mx.automation.delegates
mx.automation.delegates.advancedDataGrid
mx.automation.delegates.charts
mx.automation.delegates.containers
mx.automation.delegates.controls
mx.automation.delegates.controls.dataGridClasses
mx.automation.delegates.controls.fileSystemClasses
mx.automation.delegates.core
mx.automation.delegates.flashflexkit
mx.automation.events
mx.binding
mx.binding.utils
mx.charts
mx.charts.chartClasses
mx.charts.effects
mx.charts.effects.effectClasses
mx.charts.events
mx.charts.renderers
mx.charts.series
mx.charts.series.items
mx.charts.series.renderData
mx.charts.styles
mx.collections
mx.collections.errors
mx.containers
mx.containers.accordionClasses
mx.containers.dividedBoxClasses
mx.containers.errors
mx.containers.utilityClasses
mx.controls
mx.controls.advancedDataGridClasses
mx.controls.dataGridClasses
mx.controls.listClasses
mx.controls.menuClasses
mx.controls.olapDataGridClasses
mx.controls.scrollClasses
mx.controls.sliderClasses
mx.controls.textClasses
mx.controls.treeClasses
mx.controls.videoClasses
mx.core
mx.core.windowClasses
mx.data
mx.data.crypto
mx.data.errors
mx.data.events
mx.data.messages
mx.data.mxml
mx.data.offline.errors
mx.data.utils
mx.effects
mx.effects.easing
mx.effects.effectClasses
mx.events
mx.filters
mx.flash
mx.formatters
mx.geom
mx.graphics
mx.graphics.codec
mx.graphics.shaderClasses
mx.logging
mx.logging.errors
mx.logging.targets
mx.managers
mx.messaging
mx.messaging.channels
mx.messaging.config
mx.messaging.errors
mx.messaging.events
mx.messaging.management
mx.messaging.messages
mx.modules
mx.netmon
mx.olap
mx.olap.aggregators
mx.preloaders
mx.printing
mx.resources
mx.rpc
mx.rpc.events
mx.rpc.http
mx.rpc.http.mxml
mx.rpc.livecycle
mx.rpc.mxml
mx.rpc.remoting
mx.rpc.remoting.mxml
mx.rpc.soap
mx.rpc.soap.mxml
mx.rpc.wsdl
mx.rpc.xml
mx.skins
mx.skins.halo
mx.skins.spark
mx.skins.wireframe
mx.skins.wireframe.windowChrome
mx.states
mx.styles
mx.utils
mx.validators
org.osmf.containers
org.osmf.display
org.osmf.elements
org.osmf.events
org.osmf.layout
org.osmf.logging
org.osmf.media
org.osmf.metadata
org.osmf.net
org.osmf.net.dvr
org.osmf.net.httpstreaming
org.osmf.net.metrics
org.osmf.net.qos
org.osmf.net.rtmpstreaming
org.osmf.net.rules
org.osmf.traits
org.osmf.utils
spark.accessibility
spark.automation.delegates
spark.automation.delegates.components
spark.automation.delegates.components.gridClasses
spark.automation.delegates.components.mediaClasses
spark.automation.delegates.components.supportClasses
spark.automation.delegates.skins.spark
spark.automation.events
spark.collections
spark.components
spark.components.calendarClasses
spark.components.gridClasses
spark.components.mediaClasses
spark.components.supportClasses
spark.components.windowClasses
spark.core
spark.effects
spark.effects.animation
spark.effects.easing
spark.effects.interpolation
spark.effects.supportClasses
spark.events
spark.filters
spark.formatters
spark.formatters.supportClasses
spark.globalization
spark.globalization.supportClasses
spark.layouts
spark.layouts.supportClasses
spark.managers
spark.modules
spark.preloaders
spark.primitives
spark.primitives.supportClasses
spark.skins
spark.skins.mobile
spark.skins.mobile.supportClasses
spark.skins.spark
spark.skins.spark.mediaClasses.fullScreen
spark.skins.spark.mediaClasses.normal
spark.skins.spark.windowChrome
spark.skins.wireframe
spark.skins.wireframe.mediaClasses
spark.skins.wireframe.mediaClasses.fullScreen
spark.transitions
spark.utils
spark.validators
spark.validators.supportClasses
xd.core.axm.enterprise.view.components
xd.core.axm.enterprise.view.skins
xd.core.axm.view.components
xd.core.axm.view.components.support

Language Elements

Global Constants
Global Functions
Operators
Statements, Keywords & Directives
Special Types

Appendixes

What's New
Compiler Errors
Compiler Warnings
Run-Time Errors
Migrating to ActionScript 3
Supported Character Sets
MXML Only Tags
Motion XML Elements
Timed Text Tags
List of deprecated elements
Accessibility Implementation Constants
How to Use ActionScript Examples
Legal notices
Packageflashx.textLayout.edit
Classpublic class SelectionManager
InheritanceSelectionManager Inheritance Object
Implements ISelectionManager
Subclasses EditManager

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

The SelectionManager class manages text selection in a text flow.

The selection manager keeps track of the selected text range, manages its formatting, and can handle events affecting the selection. To allow a user to make selections in a text flow, assign a SelectionManager object to the interactionManager property of the flow. (To allow editing, assign an instance of the EditManager class, which extends SelectionManager.)

The following table describes how the SelectionManager class handles keyboard shortcuts:

TB,LTRTB,RTLTL,LTRRL,RTL
nonectrlalt|ctrl+altnonectrlalt|ctrl+altnonectrlalt|ctrl+altnonectrlalt|ctrl+alt
leftarrowpreviousCharacterpreviousWordpreviousWordnextCharacternextWordnextWordnextLineendOfDocumentendOfParagraphnextLineendOfDocumentendOfParagraph
uparrowpreviousLinestartOfDocumentstartOfParagraphpreviousLinestartOfDocumentstartOfParagraphpreviousCharacterpreviousWordpreviousWordnextCharacternextWordnextWord
rightarrownextCharacternextWordnextWordpreviousCharacterpreviousWordpreviousWordpreviousLinestartOfDocumentstartOfParagraphpreviousLinestartOfDocumentstartOfParagraph
downarrownextLineendOfDocumentendOfParagraphnextLineendOfDocumentendOfParagraphnextCharacternextWordnextWordpreviousCharacterpreviousWordpreviousWord
homestartOfLinestartOfDocumentstartOfLinestartOfLinestartOfDocumentstartOfLinestartOfLinestartOfDocumentstartOfLinestartOfLinestartOfDocumentstartOfLine
endendOfLineendOfDocumentendOfLineendOfLineendOfDocumentendOfLineendOfLineendOfDocumentendOfLineendOfLineendOfDocumentendOfLine
pagedownnextPagenextPagenextPagenextPagenextPagenextPagenextPagenextPagenextPagenextPagenextPagenextPage
pageuppreviousPagepreviousPagepreviousPagepreviousPagepreviousPagepreviousPagepreviousPagepreviousPagepreviousPagepreviousPagepreviousPagepreviousPage

Key:

  • none = no modifier
  • ctrl, shift, alt = modifiers
  • alt-key and ctrl+alt-key are the same on all platforms (on some platforms alt-key does not get to the Text Layout Framework (TLF)
  • shift key modifes to extend the active end of the selection in the specified manner
  • TB (top-to-bottom),RL (right-to-left) are textFlow level blockProgression settings
  • LTR (left-to-right),RTL (right-to-left) are textFlow level direction settings
  • next and prev in logical order in the textFlow - the effect in RTL text is that the selection moves in the physical direction

View the examples

Related API Elements

EditManager
flashx.elements.TextFlow


Public Properties
 PropertyDefined By
  absoluteEnd : int
[read-only] The text position of the end of the selection, as an offset from the start of the text flow.
SelectionManager
  absoluteStart : int
[read-only] The text position of the start of the selection, as an offset from the start of the text flow.
SelectionManager
  activePosition : int
[read-only] The active point of the selection.
SelectionManager
  anchorPosition : int
[read-only] The anchor point of the selection.
SelectionManager
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  currentSelectionFormat : SelectionFormat
[read-only] The current SelectionFormat object.
SelectionManager
  editingMode : String
[read-only] The editing mode.
SelectionManager
  focused : Boolean
[read-only] Indicates whether a container in the text flow has the focus.
SelectionManager
  focusedSelectionFormat : SelectionFormat
The SelectionFormat object used to draw the selection in a focused container.
SelectionManager
  inactiveSelectionFormat : SelectionFormat
The SelectionFormat object used to draw the selection when it is not in the active window.
SelectionManager
  textFlow : flashx.textLayout.elements:TextFlow
The TextFlow object managed by this selection manager.
SelectionManager
  unfocusedSelectionFormat : SelectionFormat
The SelectionFormat object used to draw the selection when it is not in a focused container, but is in the active window.
SelectionManager
  windowActive : Boolean
[read-only] Indicates whether the window associated with the text flow is active.
SelectionManager
Protected Properties
 PropertyDefined By
  pointFormat : flashx.textLayout.formats:ITextLayoutFormat
[read-only] The format that will be applied to inserted text.
SelectionManager
Public Methods
 MethodDefined By
  
Creates a SelectionManager object.
SelectionManager
  
Processes an activate event.
SelectionManager
  
Processes a deactivate event.
SelectionManager
  
Perform a SelectionManager operation - these may never modify the flow but clients still are able to cancel them.
SelectionManager
  
Processes an edit event.
SelectionManager
  
SelectionManager
  
Processes a focusChange event.
SelectionManager
  
Processes a focusIn event.
SelectionManager
  
Processes a focusOut event.
SelectionManager
  
Gets the character format attributes that are common to all characters in the specified text range or current selection.
SelectionManager
  
Gets the container format attributes that are common to all containers in the specified text range or current selection.
SelectionManager
  
Gets the paragraph format attributes that are common to all paragraphs in the specified text range or current selection.
SelectionManager
  
Gets the SelectionState object of the current selection.
SelectionManager
 Inherited
Indicates whether an object has a specified property defined.
Object
  
Indicates whether there is a selection.
SelectionManager
  
Processes an imeStartComposition event
SelectionManager
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
  
Indicates whether the selection covers a range of text.
SelectionManager
  
Processes a keyDown event.
SelectionManager
  
Processes a keyFocusChange event.
SelectionManager
  
Processes a keyUp event.
SelectionManager
  
Processes a menuSelect event.
SelectionManager
  
Processes a mouseDoubleClick event.
SelectionManager
  
Processes a mouseDown event.
SelectionManager
  
Processes a mouseMove event.
SelectionManager
  
Processes a mouseOut event.
SelectionManager
  
Processes a mouseOver event.
SelectionManager
  
Processes a mouseUp event.
SelectionManager
  
Processes a mouseWheel event.
SelectionManager
  
notifyInsertOrDelete(absolutePosition:int, length:int):void
Updates the selection manager when text is inserted or deleted.
SelectionManager
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
  
Redisplays the selection shapes.
SelectionManager
  
SelectionManager
  
selectRange(anchorPosition:int, activePosition:int):void
SelectionManager
  
Gives the focus to the first container in the selection.
SelectionManager
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
  
Sets the SelectionState object of the current selection.
SelectionManager
  
Processes an softKeyboardActivating event
SelectionManager
  
Processes a TextEvent.
SelectionManager
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Protected Methods
 MethodDefined By
  
Set the Mouse cursor.
SelectionManager
Property Detail

absoluteEnd

property
absoluteEnd:int  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

The text position of the end of the selection, as an offset from the start of the text flow.

The absolute end is the same as either the active or the anchor point of the selection, whichever comes last in the text flow.



Implementation
    public function get absoluteEnd():int

absoluteStart

property 
absoluteStart:int  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

The text position of the start of the selection, as an offset from the start of the text flow.

The absolute start is the same as either the active or the anchor point of the selection, whichever comes first in the text flow.



Implementation
    public function get absoluteStart():int

activePosition

property 
activePosition:int  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

The active point of the selection.

The active point is the volatile end of the selection. The active point is changed when the selection is modified. The active point can be at either the beginning or the end of the selection.



Implementation
    public function get activePosition():int

anchorPosition

property 
anchorPosition:int  [read-only]

The anchor point of the selection.

An anchor point is the stable end of the selection. When the selection is extended, the anchor point does not change. The anchor point can be at either the beginning or the end of the selection.



Implementation
    public function get anchorPosition():int

currentSelectionFormat

property 
currentSelectionFormat:SelectionFormat  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

The current SelectionFormat object.

The current SelectionFormat object is chosen from the SelectionFormat objects assigned to the unfocusedSelectionFormat, inactiveSelectionFormat and focusedSelectionFormat properties based on the current state of the windowActive and focused properties.



Implementation
    public function get currentSelectionFormat():SelectionFormat

Related API Elements

editingMode

property 
editingMode:String  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

The editing mode.

The editing mode indicates whether the text flow supports selection, editing, or only reading. A text flow is made selectable by assigning a selection manager and editable by assigning an edit manager. Constants representing the editing modes are defined in the EditingMode class.



Implementation
    public function get editingMode():String

Related API Elements

focused

property 
focused:Boolean  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Indicates whether a container in the text flow has the focus.

The focused property is true if any of the containers in the text flow has key focus.



Implementation
    public function get focused():Boolean

focusedSelectionFormat

property 
focusedSelectionFormat:SelectionFormat

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

The SelectionFormat object used to draw the selection in a focused container.



Implementation
    public function get focusedSelectionFormat():SelectionFormat
    public function set focusedSelectionFormat(value:SelectionFormat):void

Related API Elements

inactiveSelectionFormat

property 
inactiveSelectionFormat:SelectionFormat

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

The SelectionFormat object used to draw the selection when it is not in the active window.



Implementation
    public function get inactiveSelectionFormat():SelectionFormat
    public function set inactiveSelectionFormat(value:SelectionFormat):void

Related API Elements

pointFormat

property 
pointFormat:flashx.textLayout.formats:ITextLayoutFormat  [read-only]

The format that will be applied to inserted text. TBD: pointFormat needs to be extended to remember user styles and "undefine" of formats from calls to IEditManager.undefineFormat with leafFormat values on a point selection.



Implementation
    protected function get pointFormat():flashx.textLayout.formats:ITextLayoutFormat

textFlow

property 
textFlow:flashx.textLayout.elements:TextFlow

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

The TextFlow object managed by this selection manager.

A selection manager manages a single text flow. A selection manager can also be assigned to a text flow by setting the interactionManager property of the TextFlow object.



Implementation
    public function get textFlow():flashx.textLayout.elements:TextFlow
    public function set textFlow(value:flashx.textLayout.elements:TextFlow):void

Related API Elements

unfocusedSelectionFormat

property 
unfocusedSelectionFormat:SelectionFormat

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

The SelectionFormat object used to draw the selection when it is not in a focused container, but is in the active window.



Implementation
    public function get unfocusedSelectionFormat():SelectionFormat
    public function set unfocusedSelectionFormat(value:SelectionFormat):void

Related API Elements

windowActive

property 
windowActive:Boolean  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Indicates whether the window associated with the text flow is active.

The windowActive property is true if the window displaying with the text flow is the active window.



Implementation
    public function get windowActive():Boolean
Constructor Detail

SelectionManager

()Constructor
public function SelectionManager()

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Creates a SelectionManager object.

Assign a SelectionManager object to the interactionManager property of a text flow to enable text selection.

Method Detail

activateHandler

()method
public function activateHandler(event:Event):void

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Processes an activate event.

Parameters

event:Event

deactivateHandler

()method 
public function deactivateHandler(event:Event):void

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Processes a deactivate event.

Parameters

event:Event

doOperation

()method 
public function doOperation(op:FlowOperation):void

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Perform a SelectionManager operation - these may never modify the flow but clients still are able to cancel them.

Parameters

op:FlowOperation

editHandler

()method 
public function editHandler(event:Event):void

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Processes an edit event.

Edit events are dispatched for cut, copy, paste, and selectAll commands.

Parameters

event:Event

flushPendingOperations

()method 
public function flushPendingOperations():void

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

focusChangeHandler

()method 
public function focusChangeHandler(event:FocusEvent):void

Processes a focusChange event.

Parameters

event:FocusEvent

focusInHandler

()method 
public function focusInHandler(event:FocusEvent):void

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Processes a focusIn event.

Parameters

event:FocusEvent

focusOutHandler

()method 
public function focusOutHandler(event:FocusEvent):void

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Processes a focusOut event.

Parameters

event:FocusEvent

getCommonCharacterFormat

()method 
public function getCommonCharacterFormat(range:flashx.textLayout.elements:TextRange = null):flashx.textLayout.formats:TextLayoutFormat

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Gets the character format attributes that are common to all characters in the specified text range or current selection.

Format attributes that do not have the same value for all characters in the specified element range or selection are set to null in the returned TextLayoutFormat instance.

Parameters

range:flashx.textLayout.elements:TextRange (default = null) — The optional range of text for which common attributes are requested. If null, the current selection is used.

Returns
flashx.textLayout.formats:TextLayoutFormat — The common character style settings

Example  ( How to use this example )

The following example illustrates how to get an ITextLayoutFormat object containing the character style settings common to all elements in the selection. (The textFlow variable in the example is a TextFlow object.)
 var common:ITextLayoutFormat = textFlow.interactionManager.getCommonCharacterFormat();

getCommonContainerFormat

()method 
public function getCommonContainerFormat(range:flashx.textLayout.elements:TextRange = null):flashx.textLayout.formats:TextLayoutFormat

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Gets the container format attributes that are common to all containers in the specified text range or current selection.

Format attributes that do not have the same value for all containers in the specified element range or selection are set to null in the returned TextLayoutFormat instance.

Parameters

range:flashx.textLayout.elements:TextRange (default = null) — The optional range of text for which common attributes are requested. If null, the current selection is used.

Returns
flashx.textLayout.formats:TextLayoutFormat — The common container style settings

Example  ( How to use this example )

The following example illustrates how to get an ITextLayoutFormat object containing the container style settings common to all elements in the selection. (The textFlow variable in the example is a TextFlow object.)
 var common:ITextLayoutFormat = textFlow.interactionManager.getCommonContainerFormat();

getCommonParagraphFormat

()method 
public function getCommonParagraphFormat(range:flashx.textLayout.elements:TextRange = null):flashx.textLayout.formats:TextLayoutFormat

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Gets the paragraph format attributes that are common to all paragraphs in the specified text range or current selection.

Format attributes that do not have the same value for all paragraphs in the specified element range or selection are set to null in the returned TextLayoutFormat instance.

Parameters

range:flashx.textLayout.elements:TextRange (default = null) — The optional range of text for which common attributes are requested. If null, the current selection is used.

Returns
flashx.textLayout.formats:TextLayoutFormat — The common paragraph style settings

Example  ( How to use this example )

The following example illustrates how to get an ITextLayoutFormat object containing the paragraph style settings common to all elements in the selection. (The textFlow variable in the example is a TextFlow object.)
 var common:ITextLayoutFormat = textFlow.interactionManager.getCommonParagraphFormat();

getSelectionState

()method 
public function getSelectionState():SelectionState

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Gets the SelectionState object of the current selection.

Returns
SelectionState

Related API Elements


Example  ( How to use this example )

The following example gets a SelectionState object for the current selection in a text flow. (The textFlow variable in the example is a TextFlow object.)
 var selection:SelectionState = textFlow.interactionManager.getSelectionState();

hasSelection

()method 
public function hasSelection():Boolean

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Indicates whether there is a selection.

Returns true if there is either a range selection or a point selection. By default, when a selection manager is first set up, there is no selection (the start and end are -1).

Returns
Boolean

Example  ( How to use this example )

The following example illustrates how to determine whether there a text flow has a selection. (The textFlow variable in the example is a TextFlow object.)
 var selection:SelectionState = textFlow.interactionManager.hasSelection();

imeStartCompositionHandler

()method 
public function imeStartCompositionHandler(event:IMEEvent):void

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Processes an imeStartComposition event

Parameters

event:IMEEvent

isRangeSelection

()method 
public function isRangeSelection():Boolean

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Indicates whether the selection covers a range of text.

Returns true if there is a selection that extends past a single position.

Returns
Boolean

Example  ( How to use this example )

The following example illustrates how to determine whether the current selection in a text flow extends over a range of text. (The textFlow variable in the example is a TextFlow object.)
 var selection:SelectionState = textFlow.interactionManager.isRangeSelection();

keyDownHandler

()method 
public function keyDownHandler(event:KeyboardEvent):void

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Processes a keyDown event.

Parameters

event:KeyboardEvent

keyFocusChangeHandler

()method 
public function keyFocusChangeHandler(event:FocusEvent):void

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Processes a keyFocusChange event.

Parameters

event:FocusEvent

keyUpHandler

()method 
public function keyUpHandler(event:KeyboardEvent):void

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Processes a keyUp event.

Parameters

event:KeyboardEvent

menuSelectHandler

()method 
public function menuSelectHandler(event:ContextMenuEvent):void

Processes a menuSelect event.

Parameters

event:ContextMenuEvent

mouseDoubleClickHandler

()method 
public function mouseDoubleClickHandler(event:MouseEvent):void

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Processes a mouseDoubleClick event.

Parameters

event:MouseEvent

mouseDownHandler

()method 
public function mouseDownHandler(event:MouseEvent):void

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Processes a mouseDown event.

Parameters

event:MouseEvent

mouseMoveHandler

()method 
public function mouseMoveHandler(event:MouseEvent):void

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Processes a mouseMove event.

Parameters

event:MouseEvent

mouseOutHandler

()method 
public function mouseOutHandler(event:MouseEvent):void

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Processes a mouseOut event.

Parameters

event:MouseEvent

mouseOverHandler

()method 
public function mouseOverHandler(event:MouseEvent):void

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Processes a mouseOver event.

Parameters

event:MouseEvent

mouseUpHandler

()method 
public function mouseUpHandler(event:MouseEvent):void

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Processes a mouseUp event.

Parameters

event:MouseEvent

mouseWheelHandler

()method 
public function mouseWheelHandler(event:MouseEvent):void

Processes a mouseWheel event.

Parameters

event:MouseEvent

notifyInsertOrDelete

()method 
public function notifyInsertOrDelete(absolutePosition:int, length:int):void

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Updates the selection manager when text is inserted or deleted.

Operations must call notifyInsertOrDelete when changing the text in the text flow. The selection manager adjusts index-based position indicators accordingly. If you create a new Operation class that changes text in a text flow directly (not using another operation) your operation must call this function to keep the selection up to date.

Parameters

absolutePosition:int — The point in the text where the change was made.
 
length:int — A positive or negative number indicating how many characters were inserted or deleted.


Example  ( How to use this example )

The following example illustrates how a function in a custom Operation class would call the notifyInsertOrDelete() method.

This function replaces a range of text in a SpanElement as part of some hypothetical operation.

 import flashx.textLayout.elements.SpanElement;
 

function doReplace( span:SpanElement, newText:String, relativeStart:int, relativeEnd:int ):void
{
    span.replaceText(  relativeStart, relativeEnd, newText );
    var parentFlow:TextFlow = span.getTextFlow();
    var lengthDifference:int = newText.length - (relativeEnd - relativeStart);

    parentFlow.interactionManager.notifyInsertOrDelete(    span.getAbsoluteStart() + relativeStart, lengthDifference );
}

refreshSelection

()method 
public function refreshSelection():void

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Redisplays the selection shapes.

Note: You do not need to call this method directly. It is called automatically.

selectAll

()method 
public function selectAll():void

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Related API Elements

selectRange

()method 
public function selectRange(anchorPosition:int, activePosition:int):void

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Parameters

anchorPosition:int
 
activePosition:int

Related API Elements

setFocus

()method 
public function setFocus():void

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Gives the focus to the first container in the selection.


Example  ( How to use this example )

The following example sets the focus to the first container in the current selection of a text flow. (The textFlow variable in the example is a TextFlow object.)
 textFlow.interactionManager.setFocus();

setMouseCursor

()method 
protected function setMouseCursor(cursor:String):void

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10.2, AIR 2.0

Set the Mouse cursor.

Parameters

cursor:String — New cursor value, MouseCursor.AUTO if mouse is going off text, MouseCursor.IBEAM if mouse is going into text

setSelectionState

()method 
public function setSelectionState(sel:SelectionState):void

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Sets the SelectionState object of the current selection.

Parameters

sel:SelectionState

Related API Elements

softKeyboardActivatingHandler

()method 
public function softKeyboardActivatingHandler(event:Event):void

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10.2, AIR 1.5

Processes an softKeyboardActivating event

Parameters

event:Event

textInputHandler

()method 
public function textInputHandler(event:flash.events:TextEvent):void

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Processes a TextEvent.

Parameters

event:flash.events:TextEvent

SelectionManager_example.as

This example shows the use of the SelectionManager class.

It sets up a TextFlow, and a listener for selection changes, then updates based on the selection changes.

package flashx.textLayout.edit.examples {
    import flash.display.Sprite;
    
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.conversion.TextConverter;
    import flashx.textLayout.edit.SelectionManager;
    import flashx.textLayout.elements.TextFlow;
    import flashx.textLayout.formats.ITextLayoutFormat;
    import flashx.textLayout.events.SelectionEvent;

    public class SelectionManager_example extends Sprite
    {
        private var textFlow:TextFlow;
        
        public function SelectionManager_example()
        {
            //define TextFlow, and make it read-select
            textFlow = TextConverter.importToFlow("This is sample text for the SelectionManager example.",
                TextConverter.PLAIN_TEXT_FORMAT);
            textFlow.interactionManager = new SelectionManager();
            
            //compose TextFlow to display
            textFlow.flowComposer.addController(new ContainerController(this,600,600));
            textFlow.flowComposer.updateAllControllers();
            
            //add event handlers to the TextFlow to detect when selection changes
            textFlow.addEventListener(SelectionEvent.SELECTION_CHANGE, selectionChanged);
        }

        private function selectionChanged(selectionEvent:SelectionEvent):void
        {
            var format:ITextLayoutFormat = textFlow.interactionManager.getCommonCharacterFormat();
            // do something here - perhaps update the application's UI based on the formatting
            // attributes applied in the current selected text range
        }
        
    }        
}