Skip to content

CodeCoupler Environment of a Component

Over the property this.env the component get access to its environment. The properties of this object are:

element [ HTMLElement ]

The main element of the component. Depending on the component, this is to be interpreted as follows:

  • System: The element in which the system initilized. Changes to the content of the element should only be made with great care. A system is normally filled via stages and applications.
  • Stage and Widget: This is the element in which content can manipulated by your component however needed.
  • Application: Will be null while the init method is running and will point to the panel of the application if the start method is running. Should not modified anyway. An application consists of several elements which can be accessed over this.panel (main panel element), this.panel.header, this.panel.footer, this.panel.content etc.
$element [ jQuery Object ]

The main element of the component as jQuery object.

container [ HTMLElement ]

The container of the main element. Depending on the component, this is to be interpreted as follows:

  • System: The same as "element".
  • Stage: The previous stage in which the new stage will be constructed. This is not the same as element. Inside of this container will be added an element in which the component can build the new stage structure.
  • Widget: The container in which the new stage will be constructed. This is not the same as element. Inside of this container will be added a structure and an element in which the component can build the widget interface.
  • Application: This is the container in which the application was started. Depending on the component which started the application it can be

    • The current stage, in case an application started this application.
    • The root system stage, in case an application started this application as system wide application.
    • Any previous pages, in case an stage started this application.
    • The container of the widget, in case an widget started this application.
$container [ jQuery Object ]

The container of the main element as jQuery object.

system [ CodeCoupler System Instance ]

The base system instance for this component.

parent [ CodeCoupler System Instance ]

The parent component instance that created this component. In case of the system instance this is null.

app [ Object ]

1
2
3
4
5
6
7
**`parent`** [ CodeCoupler Application Instance ]

: The parent application instance in which this component was created.

**`root`** [ CodeCoupler Application Instance ]

: The topmost application instance in which this component was created.
start [ Object ]

Points to the origin start definition object of the component.

init [ Object ]

This is used internally and point to an processed start definition object.

feature [ Object ]

Parameter for constructing the component. This is used and set for now only by the widget component.

Back to top