Class Index
static org.cote.js.xhtml.XHTMLComponent
version 1.9.18
Static initializer for new Config objects.
This class participates in the engine library.
Index
Method Index
- public newInstance: Creates and returns a new XHTMLComponentInstance instance.
Methods
newInstance
Creates and returns a new XHTMLComponentInstance instance.
Syntax
c = newInstance(
hp, xp, cid, rid, cc, cn, cp, cf
)
Parameters
- hp as object : HTML Node in which the XHTML Component will be created.
- xp as object : XHTML Node for which the XHTML Component will be created.
- cid as String (optional): String representing the id to give to the component.
- rid as String (optional): String representing the reference id of an Engine object.
- cc as object (optional): Object representing a component collection, such as XHTMLFormComponent.
- cn as String (optional): String representing a component name. The component name refers to an ApplicationComponent.
- cp as String (optional): String representing the path to an ApplicationComponent file.
- cf as String (optional): String representing the name of the calling configuration. This is used when making self configuration declarations with an EngineService.
Returns
c as XHTMLComponentInstance: Returns a new XHTMLComponentInstance.
org.cote.js.xhtml.XHTMLComponentInstance
version 1.9.18
Service for sending messages, and sending and receiving publication broadcasts.
This class participates in the engine library.
Index
Property Index
- public object_config (internal): Object API structure for storing sub structures: object_config.pointers and object_config.status.
- public object_id (internal): Unique instance identifier.
- public object_type (internal): The type of this object.
- public object_version (internal): Version of the object class.
- public ready_state (internal): Object load and execution state. Follows: 0 unitialized, 1 through 3 variant, 4 ready, 5 destroyed.
Method Index
- public destroy: Clears internal pointers and data, preparing the object for destruction.
- public getApplicationComponent: Returns any underlying ApplicationComponent object. For example, if a component name, component path, and component config name were specified when the instance was created, then the corresponding ApplicationComponent would be returned.
- public getComponentId: Returns the component id.
- public getComponentId: Returns the reference id. For example, the reference id could be an Engine object for which the XHTMLComponent was created.
- public getContainer: Returns the component container object. For example, if a component was created from an XHTML import <div /> then the HTML version of that node is the container.
- public getObjectId: Returns the unique id of the object.
- public getObjectType: Returns the type of the object.
- public getObjectVersion: Returns the version of the object.
- public getPointers: Returns the object_config.pointers sub structure.
- public getReadyState: Returns the state of the object.
- public getStatus: Returns the object_config.status sub structure.
- public init_component (internal): Initializes the instance of this object.
- public post_init (internal): Post initializes the object to add it to a component collection. This is invoked internally when using the EngineService for a specific Engine object.
- public sigterm: Sends a termination signal to this object, causing it to be destroyed.
Properties
object_config
Object API structure for storing sub structures: object_config.pointers and object_config.status.
Syntax
object = object.object_config
object_id
Unique instance identifier.
Syntax
String = object.object_id
object_type
The type of this object.
Syntax
String = object.object_type
object_version
Version of the object class.
Syntax
String = object.object_version
ready_state
Object load and execution state. Follows: 0 unitialized, 1 through 3 variant, 4 ready, 5 destroyed.
Syntax
int = object.ready_state
Methods
destroy
Clears internal pointers and data, preparing the object for destruction.
Syntax
void destroy(
)
getApplicationComponent
Returns any underlying ApplicationComponent object. For example, if a component name, component path, and component config name were specified when the instance was created, then the corresponding ApplicationComponent would be returned.
Syntax
i = getApplicationComponent(
)
Returns
i as ApplicationComponent: Returns any underlying ApplicationComponent object.
getComponentId
Returns the component id.
Syntax
i = getComponentId(
)
Returns
i as String: Returns the component id which was specified when the XHTMLComponent was created.
getComponentId
Returns the reference id. For example, the reference id could be an Engine object for which the XHTMLComponent was created.
Syntax
i = getComponentId(
)
Returns
i as String: Returns the reference id which was specified when the XHTMLComponent was created.
getContainer
Returns the component container object. For example, if a component was created from an XHTML import <div /> then the HTML version of that node is the container.
Syntax
o = getContainer(
)
Returns
o as object: The XHTML/HTML object created based on the specified values when the instance was created.
getObjectId
Returns the unique id of the object.
Syntax
i = getObjectId(
)
Returns
i as String: The unique object instance id.
getObjectType
Returns the type of the object.
Syntax
t = getObjectType(
)
Returns
t as String: The type of the object instance.
getObjectVersion
Returns the version of the object.
Syntax
v = getObjectVersion(
)
Returns
v as String: The version of the object instance.
getPointers
Returns the object_config.pointers sub structure.
Syntax
o = getPointers(
)
Returns
o as object: The object_config.pointers substructure.
getReadyState
Returns the state of the object.
Syntax
s = getReadyState(
)
Returns
s as int: The object ready state.
getStatus
Returns the object_config.status sub structure.
Syntax
o = getStatus(
)
Returns
o as object: The object_config.status substructure.
init_component
Initializes the instance of this object.
Syntax
void init_component(
)
post_init
Post initializes the object to add it to a component collection. This is invoked internally when using the EngineService for a specific Engine object.
Syntax
void post_init(
)
sigterm
Sends a termination signal to this object, causing it to be destroyed.
Syntax
void sigterm(
)