| Package | com.flextoolbox.managers |
| Interface | public interface IWireManager extends flash.events.IEventDispatcher |
| Implementors | WireManager, WireSurface |
| Property | Defined by | ||
|---|---|---|---|
| hasActiveConnectionRequest : Boolean [read-only]
Indicates whether the user is trying to make a wire connection.
| IWireManager | ||
| wireRenderer : IFactory
The class used to render wires.
| IWireManager | ||
| Method | Defined by | ||
|---|---|---|---|
|
beginConnectionRequest(startJack:WireJack):void
Called by a registered WireJack, this begins a connection request.
| IWireManager | ||
|
Connects two jacks.
| IWireManager | ||
|
deleteJack(jack:WireJack):void
Removes a jack's registration with this wire manager.
| IWireManager | ||
|
Disconnects two connected jacks.
| IWireManager | ||
|
endConnectionRequest(startJack:WireJack):void
Called by a registered WireJack, this ends a connection request.
| IWireManager | ||
|
registerJack(jack:WireJack):void
Registers a jack with this wire manager.
| IWireManager | ||
| Event | Summary | Defined by | ||
|---|---|---|---|---|
| Dispatched when a registered WireJack wants to make a connection with another WireJack. | IWireManager | |||
| Dispatched when a connection is made between two WireJack instances. | IWireManager | |||
| Dispatched when a connection is deleted between two WireJack instances. | IWireManager | |||
| Dispatched when a registered WireJack wants to end a connection request. | IWireManager | |||
| hasActiveConnectionRequest | property |
hasActiveConnectionRequest:Boolean [read-only]Indicates whether the user is trying to make a wire connection.
Implementation public function get hasActiveConnectionRequest():Boolean
| wireRenderer | property |
wireRenderer:IFactory [read-write]The class used to render wires. Must implement IWireRenderer.
Implementation public function get wireRenderer():IFactory
public function set wireRenderer(value:IFactory):void
See also
| beginConnectionRequest | () | method |
public function beginConnectionRequest(startJack:WireJack):voidCalled by a registered WireJack, this begins a connection request. Generally, if a jack should be highlighted when the user is dragging a wire, the highlight is turned on during a connection request.
ParametersstartJack:WireJack — The jack that will be connected to another jack.
|
| connect | () | method |
public function connect(startJack:WireJack, endJack:WireJack):BooleanConnects two jacks.
Note: If one or both of the jacks are null, if one or both of the jacks aren't registered, or the jacks are equal, an ArgumentError will be thrown. Returns false only when the connection event is cancelled.
ParametersstartJack:WireJack — The first jack to connect.
|
|
endJack:WireJack — The second jack to connect.
|
Boolean — true if the jacks have been connected, false if not.
|
| deleteJack | () | method |
public function deleteJack(jack:WireJack):voidRemoves a jack's registration with this wire manager.
Parametersjack:WireJack — The jack to remove.
|
| disconnect | () | method |
public function disconnect(startJack:WireJack, endJack:WireJack):voidDisconnects two connected jacks.
Note: If one or both of the jacks are null, if one or both of the jacks aren't registered, or the jacks aren't connected, an ArgumentError will be thrown.
ParametersstartJack:WireJack — The first jack to connect.
|
|
endJack:WireJack — The second jack to connect.
|
| endConnectionRequest | () | method |
public function endConnectionRequest(startJack:WireJack):voidCalled by a registered WireJack, this ends a connection request. Generally, if other jacks are highlighted during a drag-and-drop operation, the highlight is turned off when a connection request ends.
ParametersstartJack:WireJack — The jack that started the connection request.
|
| registerJack | () | method |
public function registerJack(jack:WireJack):voidRegisters a jack with this wire manager.
Parametersjack:WireJack — The jack to register.
|
| beginConnectionRequest | event |
com.flextoolbox.events.WireManagerEvent
Dispatched when a registered WireJack wants to make a connection with another WireJack. Generally, compatible WireJack instances are expected to highlight themselves so that the user knows where a connection can be made.
| createConnection | event |
com.flextoolbox.events.WireManagerEvent
Dispatched when a connection is made between two WireJack instances. May be cancelled.
| deleteConnection | event |
com.flextoolbox.events.WireManagerEvent
Dispatched when a connection is deleted between two WireJack instances.
| endConnectionRequest | event |
com.flextoolbox.events.WireManagerEvent
Dispatched when a registered WireJack wants to end a connection request. Generally, compatible WireJack instances are expected to remove their highlight at this time.