Packagecom.yworks.graph.drawing
Classpublic class CollapsibleNodeStyleDecoratorRenderer
InheritanceCollapsibleNodeStyleDecoratorRenderer Inheritance AbstractNodeStyleRenderer Inheritance AbstractStyleRenderer Inheritance Object

Style renderer implementation for the CollapsibleNodeStyleDecorator.



Public Properties
 PropertyDefined By
 Inheriteditem : IModelItem
[read-only] Gets the currently configured item.
AbstractStyleRenderer
 Inheritedlayout : IRectangle
[read-only] Returns the INode.layout of the node this renderer is currently configured for.
AbstractNodeStyleRenderer
 Inheritedstyle : IVisualStyle
[read-only] Gets the currently configured style.
AbstractStyleRenderer
 InheritedstyleDescriptor : ICanvasObjectDescriptor
[read-only] Gets the ICanvasObjectDescriptor to use for new installations.
AbstractStyleRenderer
Public Methods
 MethodDefined By
  
Creates a new instance.
CollapsibleNodeStyleDecoratorRenderer
  
[override] Returns a tight rectangular area where the whole rendering would fit into.
CollapsibleNodeStyleDecoratorRenderer
  
[override] Creates a new DisplayObject from scratch.
CollapsibleNodeStyleDecoratorRenderer
 Inherited
Configures the style and item parameters, calls configure and returns this.
AbstractStyleRenderer
 Inherited
Configures the style and item parameters, does not call configure and returns this.
AbstractStyleRenderer
 Inherited
Configures the style and item parameters, calls configure and returns this.
AbstractStyleRenderer
 Inherited
Configures the style and item parameters, calls configure and returns this.
AbstractStyleRenderer
  
getIntersection(innerX:Number, innerY:Number, outerX:Number, outerY:Number, intersectionPoint:IPointSetter):Boolean
[override] Finds an intersection for the current item using the style.
CollapsibleNodeStyleDecoratorRenderer
 Inherited
Configures the style and item parameters, calls configure and returns this.
AbstractStyleRenderer
  
[override] Returns the outline of the shape using the node's layout.
CollapsibleNodeStyleDecoratorRenderer
 Inherited
Configures the style and item parameters, calls configure and returns this.
AbstractNodeStyleRenderer
 Inherited
install(canvas:CanvasComponent, group:ICanvasObjectGroup, modelItem:IModelItem):Array
Installs the model in the canvas at the given group using the styleDescriptor.
AbstractStyleRenderer
  
isHit(x:Number, y:Number, ctx:ICanvasContext):Boolean
[override] Determines if something has been hit at the given coordinates in the world coordinate system.
CollapsibleNodeStyleDecoratorRenderer
  
[override] Returns true if the corresponding item is considered to intersect the given rectangular box. This method may return false if the item cannot be selected using a selection marquee or optionally if the item is only partially contained within the box.
CollapsibleNodeStyleDecoratorRenderer
  
isInside(x:Number, y:Number):Boolean
[override] Checks whether the given coordinate lies within the shape's geometric bounds.
CollapsibleNodeStyleDecoratorRenderer
 Inherited
Calls configure and tests the item using the style for a visible intersection with the clip bounds.
AbstractStyleRenderer
  
lookup(type:Class):Object
[override] Implements the ILookup interface.
CollapsibleNodeStyleDecoratorRenderer
  
updateDisplayObject(oldDisplayObject:DisplayObject, context:IDisplayObjectContext):DisplayObject
[override] Updates the given DisplayObject or creates a new one.
CollapsibleNodeStyleDecoratorRenderer
Protected Methods
 MethodDefined By
 Inherited
configure():void
[override] This is an empty implementation of the AbstractStyleRenderer.configure method.
AbstractNodeStyleRenderer
 Inherited
[override] Factory method for the StyleDescriptor property.
AbstractNodeStyleRenderer
  
Yields the ICollapsibleNodeStyleDecorator#buttonLocationParameter for the current style
CollapsibleNodeStyleDecoratorRenderer
  
getIcon(ctx:Object):IIcon
Callback method that yields the IIcon to use.
CollapsibleNodeStyleDecoratorRenderer
  
Yields the ICollapsibleNodeStyleDecorator#wrapped property for the current style
CollapsibleNodeStyleDecoratorRenderer
 Inherited
setItem(item:IModelItem):void
Called by the various descriptor getters to initialize the item.
AbstractStyleRenderer
 Inherited
Called by the various descriptor getters to initialize the style.
AbstractStyleRenderer
Constructor Detail
CollapsibleNodeStyleDecoratorRenderer()Constructor
public function CollapsibleNodeStyleDecoratorRenderer()

Creates a new instance.

Method Detail
calculateBounds()method
override public function calculateBounds(scratch:IMutableRectangle, ctx:ICanvasContext):IRectangle

Returns a tight rectangular area where the whole rendering would fit into.

Implementations can use the scratch rectangle to put their results in and return it as the result of the operation. Client has to always provide a non-null instance as a parameter. They may however decide to return an internally cached or dynamically created IRectangle implementation and disregard the scratch parameter. If calculating the bounds is too expensive or the painting is not bound to a certain area, this method may return null. If nothing is painted, this method should return an empty rectangle, where either or both the width and height is non-positive or ImmutableRectangle.Empty.

Parameters

scratch:IMutableRectangle — An instance that can optionally be used to fill with the corresponding values and be returned
 
ctx:ICanvasContext — The context to calculate the bounds for (currently not used)

Returns
IRectangle — The bounds or null to indicate an unbound area
createDisplayObject()method 
override public function createDisplayObject(context:IDisplayObjectContext):DisplayObject

Creates a new DisplayObject from scratch.

Parameters

context:IDisplayObjectContext — The context for which the display object is created.

Returns
DisplayObject — A DisplayObject.
getButtonLocationParameter()method 
protected function getButtonLocationParameter():ILabelModelParameter

Yields the ICollapsibleNodeStyleDecorator#buttonLocationParameter for the current style

Returns
ILabelModelParameter

See also

getIcon()method 
protected function getIcon(ctx:Object):IIcon

Callback method that yields the IIcon to use.

Parameters

ctx:Object — The context.

Returns
IIcon — The icon to use.
getIntersection()method 
override public function getIntersection(innerX:Number, innerY:Number, outerX:Number, outerY:Number, intersectionPoint:IPointSetter):Boolean

Finds an intersection for the current item using the style.

This implementation returns the intersection for the layout.

Parameters

innerX:Number — The x coordinate of the point inside the node.
 
innerY:Number — The y coordinate of the point inside the node.
 
outerX:Number — The x coordinate of the point outside the node.
 
outerY:Number — The y coordinate of the point outside the node.
 
intersectionPoint:IPointSetter — The point to store the coordinates of the intersection in.

Returns
Booleantrue if an intersection was actually found
getOutline()method 
override public function getOutline():GeneralPath

Returns the outline of the shape using the node's layout.

Returns
GeneralPath — The outline of the bounds of the node.
getWrappedStyle()method 
protected function getWrappedStyle():INodeStyle

Yields the ICollapsibleNodeStyleDecorator#wrapped property for the current style

Returns
INodeStyle

See also

isHit()method 
override public function isHit(x:Number, y:Number, ctx:ICanvasContext):Boolean

Determines if something has been hit at the given coordinates in the world coordinate system.

Parameters

x:Number — the x-coordinate in world coordinate system
 
y:Number — the y-coordinate in world coordinate system
 
ctx:ICanvasContext — the context the hit test is performed in

Returns
Boolean — whether something has been hit
isInBox()method 
override public function isInBox(box:IRectangle, ctx:ICanvasContext):Boolean

Returns true if the corresponding item is considered to intersect the given rectangular box. This method may return false if the item cannot be selected using a selection marquee or optionally if the item is only partially contained within the box.

Parameters

box:IRectangle — The box describing the marquee's bounds
 
ctx:ICanvasContext — The current canvas context

Returns
Booleantrue if the item is considered to be captured by the marquee
isInside()method 
override public function isInside(x:Number, y:Number):Boolean

Checks whether the given coordinate lies within the shape's geometric bounds.

This implementation checks for containment in the layout.

Parameters

x:Number — The x coordinate of the point to test.
 
y:Number — The y coordinate of the point to test.

Returns
Boolean — True if the point lies within the geometry of the rendering.
lookup()method 
override public function lookup(type:Class):Object

Implements the ILookup interface.

This method will be used by default if getContext has been queried for a lookup implementation. Note that it cannot be assumed that configure has already been invoked. However, normally item and style will be correctly configured if invoked directly after getContext. Subclass implementations should make sure to configure this instance before they return this as a result of a successful lookup.

Parameters

type:Class — The type to query for

Returns
Object — An implementation of the given type or null
updateDisplayObject()method 
override public function updateDisplayObject(oldDisplayObject:DisplayObject, context:IDisplayObjectContext):DisplayObject

Updates the given DisplayObject or creates a new one.

Implementors can decide whether they update the given display object or create a new one. Updating can mean re-rendering or updating size and/or coordinates.

Parameters

oldDisplayObject:DisplayObject — The display object to update.
 
context:IDisplayObjectContext — The context for which the display object should be updated.

Returns
DisplayObject — The updated display object or a completely new display object.