Returns the component with that the adapter is registered in JCSS.

Sets a custom callback for the registered event.

The callback is triggered right after the component has been registered in JCSS. The goal of the callback is to enable initial setting for components that are registered with their type. In the case of instance registration, we usually have the full control over the time, the component gets registered, so we could here place the related code right before or after the JCSS::registerComponent() command.

A custom registered handler may be set if the implementation of an adapter can not or should not be changed. Using a custom callback makes the same adapter implementation reusable for different component types.

If not set, onComponentRegistered() is called by default.

A custom registered handler has the following signature. Note, that the current adapter is also passed to the method, which might be confusing. However, this enables to reuse the same handler with different adapters.

   theAdapter.componentRegisteredHandler = function(adapter : JCSS_Adapter) : void {
    trace ("registered", Box(adapter.component));
   };
   

Sets and returns the component css class.

Can be set initially or at runtime.

Sets and returns the component selector ID.

Can be set only initially (before the initialized event). Otherwise throws an error.

Sets and returns the component selector name.

Can be set only initially (before the initialized event). Otherwise throws an error.

Returns true if styles already have been initialized.

Sets a custom callback for the styles changed event.

The callback is triggered always a component style has been changed.

A custom changed handler may be set if the implementation of an adapter can not or should not be changed. Using a custom callback makes the same adapter implementation reusable for different component types.

A custom styles changed handler has the following signature. Note, that the current adapter is also passed to the method, which might be confusing. However, this enables to reuse the same handler with different adapters.

   theAdapter.stylesChangedHandler = function(changedStyles : JCSS_ChangedStyles, adapter : JCSS_Adapter) : void {
    if (changedStyles.valueHasChanged("backgroundColor")) {
     Box(adapter.component).updateBackground();
    }
   };
   

If not set, onStylesChanged() is called by default.

Sets a custom callback for the initialized event.

The callback is triggered once for a component and after the styles of a component have been calculated the first time. Starting from here, all further changes in JCSS will update the component (incrementally) using notifying the component by the styles changed callback.

A custom initialized handler may be set if the implementation of an adapter can not or should not be changed. Using a custom callback makes the same adapter implementation reusable for different component types.

If not set, onStylesInitialized() is called by default.

A custom initialized handler has the following signature. Note, that the current adapter is also passed to the method, which might be confusing. However, this enables to reuse the same handler with different adapters.

   theAdapter.stylesInitializedHandler = function(allInitialStyles : Object, adapter : JCSS_Adapter) : void {
    Box(adapter.component).draw();
   };
   

Sets and gets the virtual parent of a component.

If a virtual parent is set, the component styles are calculated using the virtual parent's display list instead of the physical parent's display list. A virtual parent is a great possibility to connect components that do not have a physical parent-child relation such as tooltips or popups, which usually live in a separated container.

   CSS
   -----------------------------------------------
   Button.red ToolTip {
    color: red;
   }

   Button.blue ToolTip {
    color: blue;
   }

   Pseudo code
   -----------------------------------------------
   redButton.onMouseOver = {
    tooltip.virtualParent = redButton;
    tooltip.show(redButton.position.toGlobal());
   }

   blueButton.onMouseOver = {
    tooltip.virtualParent = blueButton;
    tooltip.show(blueButton.position.toGlobal());
   }
   

Can be set initially or at runtime.

JCSS_Adapter

Returns true, if encloseChildren() is set, else false.

Removes a style that has formerly been set.

If styleName is specified, the style is removed from the style rule specified with the given selector.

The method does nothing if a style rule with the given selector has not been set beforehand or a style with the given styleName has not been declared within the style rule described by the given selector.

Using this method to clear styles set to the component directly (by passing the selector "This" or "") will reset the style to its default value specified by the component.

Executes a bulk update that was started via startBulkUpdate().

Affected components are notified only once regardless of the specific changes between startBulkUpdate() and this command.

Ancestor components are always notified before their children. A further order is not specified. It can be possible that children of different branches are notified alternating, e.g. C-1, C-2, C-2.1, C-2.2, C-1.3, C-2.4, C-1.1

Returns the full selector of a component.

E.g. Box#mini.highlight

Defines a style prior to be used with JCSS.

Styles need to be defined initially. Not initially defined styles are ignored and never affect the particular component.

Styles can only be defined initially (before the initialized event). Otherwise an error is thrown.

Declares all child component to be selectable only via this component selector.

Enclosing children is useful when setting up stateful default styles that should not be overriden by accident. In example, we create a Button with several states and default styles that affect the contained label color. Setting now a global label color would override the Button declarations and make the label state insensitive. Invoking encloseChildren() lets match only styles rules that include this component in the selector chain.:

   Without encloseChildren();
   -----------------------------------------------
   myButton.setStyle(":over Label", "color", "red", "default"); // Button Label is red on mouse over by default.
   JCSS.getInstance().setStyle("Label", "color", "blue"); // Button Label is now blue even on mouse over.
   
   With encloseChildren();
   -----------------------------------------------
   myButton.setStyle(":over Label", "color", "red", "default"); // Button Label is red on mouse over by default.
   myButton.encloseChildren();
   JCSS.getInstance().setStyle("Label", "color", "blue"); // Does not affect the Button Label.
   JCSS.getInstance().setStyle("Button Label", "color", "blue"); // Button Label is now blue, since the selector includes Button.