| Package | com.yworks.graph.drawing |
| Class | public class ComponentNodeStyle |
| Inheritance | ComponentNodeStyle Object |
| Implements | INodeStyle |
DisplayObjects to visualize nodes.
The default clone implementation will not copy any state information.
To control how the component is cloned, either override cloneComponent() or
use a component that implements ICloneable.
For proper (de)serialization of the component's state, corresponding
ISerializer and IDeserializer implementations have to be
registered with the GraphMLIOHandler.
| Property | Defined By | ||
|---|---|---|---|
| component : UIComponent
The component that is used as a node visualization. | ComponentNodeStyle | ||
| styleRenderer : IStyleRenderer [read-only]
Gets the renderer implementation that has been supplied to
this instance upon creation. | ComponentNodeStyle | ||
| Method | Defined By | ||
|---|---|---|---|
ComponentNodeStyle(component:UIComponent = null, renderer:ComponentNodeStyleRenderer = null)
Creates a new instance using the given component and renderer. | ComponentNodeStyle | ||
clone():Object
Creates a clone of this instance. | ComponentNodeStyle | ||
Prepares the rendering of an IModelItem in a CanvasComponent by
adding ICanvasObject's to the provided canvas. | ComponentNodeStyle | ||
| Method | Defined By | ||
|---|---|---|---|
cloneComponent():UIComponent
Clone the component that is used as the node visualization. | ComponentNodeStyle | ||
Create a clone of this style instance. | ComponentNodeStyle | ||
| component | property |
component:UIComponentThe component that is used as a node visualization.
Any UIComponent can be used as the component. The component can be implemented using MXML or ActionScript.
public function get component():UIComponent public function set component(value:UIComponent):void| styleRenderer | property |
styleRenderer:IStyleRenderer [read-only] Gets the renderer implementation that has been supplied to this instance upon creation.
public function get styleRenderer():IStyleRenderer| ComponentNodeStyle | () | Constructor |
public function ComponentNodeStyle(component:UIComponent = null, renderer:ComponentNodeStyleRenderer = null)Creates a new instance using the given component and renderer.
Parameterscomponent:UIComponent (default = null) | |
renderer:ComponentNodeStyleRenderer (default = null) |
| clone | () | method |
public function clone():ObjectCreates a clone of this instance.
ReturnsObject — A clone of this instance.
|
See also
| cloneComponent | () | method |
protected function cloneComponent():UIComponentClone the component that is used as the node visualization.
clone() uses this callback to create the cloned
component that is used for the cloned style instance.
UIComponent — a clone of the component.
|
See also
| createClone | () | method |
protected function createClone():ComponentNodeStyleCreate a clone of this style instance.
clone() uses this callback to create the
cloned instance before any state information is transfered.
ComponentNodeStyle — a cloned instance of this style
|
See also
| install | () | method |
public function install(canvas:CanvasComponent, group:ICanvasObjectGroup, modelItem:IModelItem):Array
Prepares the rendering of an IModelItem in a CanvasComponent by
adding ICanvasObject's to the provided canvas.
Implementations may add zero or more ICanvasObject instances to
the given CanvasComponent. The group parameter
can be used as a hint for implementations. They can add their newly created
canvas objects to the given group. However they are not obliged to do that.
Parameters
canvas:CanvasComponent — The canvas to install the canvas objects in.
| |
group:ICanvasObjectGroup — A hint that tells the implementation where to add the canvas objects.
| |
modelItem:IModelItem — The item to install a visual representation for.
|
Array — An array of zero or more canvas objects that have been installed
in the canvas by this method or null if nothing was installed.
|