Specializes Composer

keyComposer = KeyComposer.createKey(textComponent, "command+z", "undo");
keyComposer.addEventListener("keyPress", undoManager);
// when command+z is pressed inside textComponent,
//undoManager.handleUndoKeyPress() will be called.

Properties

acceptsActiveTarget :boolean source

Whether or not this target can accept user focus and become the activeTarget This matches up with the document.activeElement property purpose-wise; Events from components that should be dispatched as logically occurring at the point of user focus should be dispatched at the activeTarget

By default a target does not accept this responsibility.

Inherited From:	Composer#acceptsActiveTarget
Default Value:	false

component :Component source

The Montage Component this Composer is attached to. Each composer is attached to a single component. By default, most composer will listen to DOM events on this component's element. This is also the component whose draw cycle is affected by needsFrame and frame.

Inherited From:	Composer#component
Default Value:	null

element :Element source

The DOM element where the composer will listen for events. If no element is specified then the composer will use the element associated with its component property.

Subclasses may want to set their element to something other than the component's element during load for certain event patterns. One common pattern is to set element to window to listen for events anywhere on the page.

Inherited From:	Composer#element
Default Value:	null

isActiveTarget :boolean source

Whether or not this is the activeTarget

This is a getter and is not bindable. Bind to defaultEventManager.activeTarget == this.

Inherited From:	Composer#isActiveTarget

keys :string source

The keyboard shortcut to listen to. One alphanumeric character or named non-alphanumeric key, possibly with modifiers connected by '+'. The full list of normalized keys and modifiers is in KeyManager. @example "j", "shift+j", "command+shift+j", "backspace", "win+pipe"

Default Value:	null

lazyLoad source

This property controls when the component will call this composer's load method, which is where the composer adds its event listeners:

• If false, the component will call load during the next draw cycle after the composer is added to it.
• If true, the component will call load after its prepareForActivationEvents.

Delaying the creation of event listeners can improve performance.

Inherited From:	Composer#lazyLoad
Default Value:	false

needsFrame :boolean source

This property should be set to 'true' when the composer wants to have its frame() method executed during the next draw cycle. Setting this property to 'true' will cause Montage to schedule a new draw cycle if one has not already been scheduled.

Inherited From:	Composer#needsFrame
Default Value:	false

nextTarget :Component source

Which target to distribute an event after this when distributing events throughout a graph of targets.

Inherited From:	Composer#nextTarget

Methods

addEventListener(type, listener, useCapture) source

Listen to find out when this KeyComposer detects a matching key press.

Parameters:

Name	Type	Description
type	string	Any of the following types: keyPress, longKeyPress and keyRelease.
listener	Object | function	The listener object or function to call when dispatching the event.
useCapture	boolean	Specify if the listener want to be called during the capture phase of the event.

didBecomeActiveTarget() source

Called after to this target became the activeTarget

Inherited From:	Composer#didBecomeActiveTarget

dispatchEvent(event) source

Dispatches the specified event with this target as the event's proximal target

Parameters:

Name	Type	Description
event	Event	The event object to dispatch

Inherited From:	Composer#dispatchEvent

dispatchEventNamed(type, canBubble, cancelable, detail) source

Creates and dispatches an event with the specified properties with this target as the event's proximal target

Parameters:

Name	Type	Description
type	string	The type of the event to dispatch
canBubble	boolean	Whether or not the event can bubble
cancelable	boolean	Whether or not the event can be cancelled
detail	Object	The optional detail object of the event

Inherited From:	Composer#dispatchEventNamed

frame(timestamp) source

This method will be invoked by the framework at the beginning of a draw cycle. This is where a composer may implement its update logic if it needs to respond to draws by its component.

Parameters:

Name	Type	Description
timestamp	Date	The time that the draw cycle started

Inherited From:	Composer#frame

removeEventListener(type, listener, useCapture) source

Removes an event listener from the object.

Parameters:

Name	Type	Description
type	string	The event type.
listener	object | function	The listener object or function.
useCapture	boolean	The phase of the event listener.

Inherited From:	Composer#removeEventListener

surrendersActiveTarget(newTarget) → {boolean} source

Ask this target to surrender its activeTarget status.

Parameters:

Name	Type	Description
newTarget	Target	the Target that is about to become the activeTarget

Inherited From:	Composer#surrendersActiveTarget

Returns: boolean

Whether or not to surrender activeTarget status

willBecomeActiveTarget(oldTarget) source

Called prior to this target becoming the activeTarget

Parameters:

Name	Type	Description
oldTarget	Target	the current activeTarget

Inherited From:	Composer#willBecomeActiveTarget

Generated from a4679af