Destroys the all instances this factory has.
this
Returns true if this factory has the specified instance.
the instance to be checked
true if this factory has the specified instance
Creates an instance and returns it. The specified arguments are passed to the instance. See {@link org.wcardinal.controller.AbstractController#getFactoryParameters()} of the javadoc.
factory parameters
the new instance
Destroys the specified instance and returns true if succeeded.
the instance to be destroyed
true if the specified instance is destroyed successfully
Iterates over the instances this factory has invoking the specified function for the each instance. The specified function is invoked with the following:
By explicitly returning false, the specified function exits the iteration immediately.
the function to be invoke for the each instance
the this binding of the specified function
this
Iterates instances of this factory, calling the iteratee for each instance, removing all instances the iteratee does not return true. The iteratee is bound to the thisArg and invoked with three arguments: instance, index and this factory.
the function called per iteration
the this binding of the iteratee
this
Returns the instance at the specified index.
index of the instance
the instance at the specified index
Returns the active page. If the active page does not exist, returns null.
the active page
Returns the component of the specified name. If the component of the specified name does not exist, returns null.
a component name
the component of the specified name
Returns the mapping from the component factory name to the wcardinal.controller.ComponentFactory. The returned mapping is a read-only.
the mapping from the component name to the wcardinal.controller.ComponentFactory
Returns the component factory of the specified name. If the component factory of the specified name does not exist, returns null.
a component factory name
the component factory of the specified name
Returns the mapping from the component name to the wcardinal.controller.Component. The returned mapping is a read-only.
the mapping from the component name to the wcardinal.controller.Component
Returns the name.
the name
Returns the page of the specified name. If the page of the specified name does not exist. returns null.
a page name
the page of the specified name
Returns the mapping from the page factory name to the wcardinal.controller.PageFactory. The returned mapping is a read-only.
the mapping from the page name to the wcardinal.controller.PageFactory
Returns the page factory of the specified name. If the page factory of the specified name does not exist, returns null.
a page factory name
the page factory of the specified name
Returns the mapping from the page name to the wcardinal.controller.Page. The returned mapping is a read-only.
the mapping from the pagen name to the wcardinal.controller.Page.
Returns the parent.
the parent
Returns the popup of the specified name. If the popup of the specified name does not exist, returns null.
a popup name
the popup of the specified name
Returns the mapping from the popup factory name to the wcardinal.controller.PopupFactory. The returned mapping is a read-only.
the mapping from the popup name to the wcardinal.controller.PopupFactory
Returns the popup factory of the specified name. If the popup factory of the specified name does not exist, returns null.
a popup factory name
the popup factory of the specified name
Returns the mapping from the popup name to the wcardinal.controller.Popup. The returned mapping is a read-only.
the mapping from the popup name to the wcardinal.controller.Popup
Makes this controller invisible.
this
Returns the index of the specified instance.
instance to search for
the index of the specified instance or -1 if this factory does not contain the specified instance
Returns true if this factory is empty.
true if this factory is empty
Returns true if this controller is invisible.
true if this controller is invisible
Returns true if this is historical.
true if this is historical
Returns true if this controller is locked.
true if this controller is locked
Returns true if this is non-null.
true if this is non-null
Returns true if this is read-only.
true if this is read-only
Returns true if this controller is visible.
true if this controller is visible
Locks this controller.
this
Unregister the event handlers of the specified events.
off( "success" );
// Unregister all the handlers of the events with the namespace `sample`.
off( ".sample" );
// Unregister all the handlers of the `success` event with the namespace `sample`.
off( "success.sample" );
// Multiple event types
off( "success fail" );space-separated event types
the event handler to be unregistered
this
Unregister the event handlers of the specified events.
off( "success" );
// Unregister all the handlers of the events with the namespace `sample`.
off( ".sample" );
// Unregister all the handlers of the `success` event with the namespace `sample`.
off( "success.sample" );
// Multiple event types
off( "success fail" );event target
space-separated event types
the event handler to be unregistered
this
Unregisters the event handler for the unregistration events of the specified events.
onoff("eventname", handler);space-separated event names
an event handler
this
Unregisters the event handlers for the registration events of the specified events.
offon("eventname", handler);space-separated event types
an event handler
this
Registers the specified event handler for the specified events. When the handler is invoked, the this keyword is a reference to the this class. This method supports space-separated event types and namespces.
on( "success", function(){} );
// `success` event with a namespace `sample`
on( "success.sample", function(){} );
// Multiple namespaces
on( "success.ns1.ns2.ns3", function(){} );
// Multiple event types
on( "success fail", function(){} );
// Event target
on( eventTarget, "success", function(){} );space-separated event types
the event handler to be registered
this
Registers the specified event handler for the specified events. When the handler is invoked, the this keyword is a reference to the this class. This method supports space-separated event types and namespces.
on( "success", function(){} );
// `success` event with a namespace `sample`
on( "success.sample", function(){} );
// Multiple namespaces
on( "success.ns1.ns2.ns3", function(){} );
// Multiple event types
on( "success fail", function(){} );
// Event target
on( eventTarget, "success", function(){} );event target or event types
space-separated event types
the event handler to be registered
this
Registers the specified event handler for the specified events. The specified event handler is invoked at most once. When the handler is invoked, the this keyword is a reference to the this class. This method supports space-separated event types and namespces.
one( "success", function(){} );
// `success` event with a namespace `sample`
one( "success.sample", function(){} );
// Multiple namespaces
one( "success.ns1.ns2.ns3", function(){} );
// Multiple event types
one( "success fail", function(){} );space-separated event types
The event handler to be registered
this
Registers the specified event handler for the specified events. The specified event handler is invoked at most once. When the handler is invoked, the this keyword is a reference to the this class. This method supports space-separated event types and namespces.
one( "success", function(){} );
// `success` event with a namespace `sample`
one( "success.sample", function(){} );
// Multiple namespaces
one( "success.ns1.ns2.ns3", function(){} );
// Multiple event types
one( "success fail", function(){} );event target
space-separated event types
The event handler to be registered
this
Registers the event handler for the unregistration events of the specified events. The handler is invoked with Connection and a boolean when the event handlers of the specified events are unregistered. The latter boolean gets true if this is the last handler of the event identified by Connection.type.
onoff("eventname", function( connection, isLast ){
// DO SOMETHING HERE
});space-separated event names
an event handler
this
Registers the event handler for the registration events of the specified events. The handler is invoked with Connection and a boolean when the event handlers of the specified events are registered. The latter boolean gets true if this is the first handler of the event identified by Connection.type.
onon("eventname", function( connection, isFirst ){
if( some-condition ) {
connection.trigger( this, null, [ first-event-parameter, second-event-parameter, ... ] );
}
});space-separated event types
an event handler
this
Removes the instance at the specified index.
index of the instance
the old instance at the specified index
Invokes all the handlers of the specified event.
retrigger( originalEvent, "success" );
// With two parameters true and 156
retrigger( originalEvent, "success", [true, 156] );
// Namespaced event type
retrigger( originalEvent, "success.sample" );
// Multiple event types
retrigger( originalEvent, "success fail" );the event object
space-separated event types
the returned values of the invoked handlers
Invokes all the handlers of the specified event.
retrigger( originalEvent, "success" );
// With two parameters true and 156
retrigger( originalEvent, "success", [true, 156] );
// Namespaced event type
retrigger( originalEvent, "success.sample" );
// Multiple event types
retrigger( originalEvent, "success fail" );event target
the event object
space-separated event types
event parameters
the returned values of the invoked handlers
Makes this controller visible.
this
Returns the number of instances this factory has.
the number of instances this factory has.
Returns the array of the instances.
the array of the instances
Returns the JSON array representing this factory.
the JSON array representing this factory
Returns the string representing the array of instances.
the string representing the array of instances
Invokes all the handlers of the specified event.
trigger( "success" );
// With two parameters true and 156
trigger( "success", [true, 156] );
// Namespaced event type
trigger( "success.sample" );
// Multiple event types
trigger( "success fail" );space-separated event types
event parameters
the returned values of the invoked handlers
Invokes all the handlers of the specified event.
trigger( "success" );
// With two parameters true and 156
trigger( "success", [true, 156] );
// Namespaced event type
trigger( "success.sample" );
// Multiple event types
trigger( "success fail" );Event target
space-separated event types
event parameters
the returned values of the invoked handlers
Unlock this controller.
this
Extends the specified target with the Connectable methods.
non-null target to be extended
the specified target
Generated using TypeDoc
A component factory that creates/destroys components dynamically.