Child pages
  • Renderer-bearing Components

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

...

Events for Renderer-bearing Components

prepareModelForRender

{div2:class=} ||Description| This event fires before the generation of protoTree. Whatever adjustment on the model, which is the protoTree is generated based on, is ideal to be performed at this event. | ||Parameters| _{{model}}_\\ The internal [Model Component|http://wiki.fluidproject.org/display/docs/Model+Components] that is used by this renderer component.\\ \\ _{{applier}}_\\ The internal [Change Applier Component|http://wiki.fluidproject.org/display/fluid/ChangeApplier] that is used by this renderer component. \\ \\ _{{that}}_\\ The reference to the current renderer component.| ||Returns| None | ||Note| The first event to be fired before events "onRenderTree" and "afterRender". | ||Availability| Infusion 1.4 and later | {div2}
Wiki Markup
Div
classapi-table

onRenderTree

Wiki Markup
{div2:class=api-table}
||Description| This event fires right before protoTree is rendered. This event is ideal for the final manipulation of the fully expanded protoTree.  |
||Parameters| _{{that}}_\\
The reference to the current renderer component.\\
\\
_{{tree}}_\\
Expanded renderer tree.\\
||Returns| None |
||Note| The event fired after "prepareModelForRender" and before "afterRender". |
||Availability| Infusion 1.4 and later |
{div2}

afterRender

{div2:class=api-table} ||Description| This event fires after protoTree is rendered. | ||Parameters| _{{that}}_\\ The reference to the current renderer component.| ||Returns| None | ||Note| The event fired after "onRenderTree" and "afterRender". | ||Availability| Infusion 1.4 and later | {div2}
Wiki Markup

Description

This event fires before the generation of protoTree. Whatever adjustment on the model, which is the protoTree is generated based on, is ideal to be performed at this event.

Parameters

model
The internal Model Component that is used by this renderer component.

applier
The internal Change Applier Component that is used by this renderer component.

that
The reference to the current renderer component.

Returns

None

Note

The first event to be fired before events "onRenderTree" and "afterRender".

Availability

Infusion 1.4 and later

onRenderTree

Div
classapi-table

Description

This event fires right before protoTree is rendered. This event is ideal for the final manipulation of the fully expanded protoTree.

Parameters

that
The reference to the current renderer component.

tree
Expanded renderer tree.

Returns

None

Note

The event fired after "prepareModelForRender" and before "afterRender".

Availability

Infusion 1.4 and later

afterRender

Div
classapi-table

Description

This event fires after protoTree is rendered.

Parameters

that
The reference to the current renderer component.

Returns

None

Note

The event fired after "onRenderTree" and "afterRender".

Availability

Infusion 1.4 and later

Note: The 3 events are fired in the order of prepareModelForRender, onRenderTree, afterRender. They are only intended for use by experts.

...