Packagecom.yworks.graph.drawing
Classpublic class SimplePortStyleRenderer
InheritanceSimplePortStyleRenderer Inheritance AbstractStyleRenderer Inheritance Object
Implements IPortStyleRenderer, IDisplayObjectCreator

Simple port style renderer that draws ports as circles with a stroke and radius obtained from a SimplePortStyle.



Public Properties
 PropertyDefined By
 Inheriteditem : IModelItem
[read-only] Gets the currently configured item.
AbstractStyleRenderer
 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
  
[override] Returns a tight rectangular area where the whole rendering would fit into.
SimplePortStyleRenderer
  
[override]
SimplePortStyleRenderer
 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
 Inherited
Configures the style and item parameters, calls configure and returns this.
AbstractStyleRenderer
 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]
SimplePortStyleRenderer
 Inherited
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.
AbstractStyleRenderer
 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.
SimplePortStyleRenderer
  
updateDisplayObject(oldDisplayObject:DisplayObject, context:IDisplayObjectContext):DisplayObject
[override]
SimplePortStyleRenderer
Protected Methods
 MethodDefined By
  
configure():void
[override] Prepares this instance for subsequent calls after the style and item have been initialized.
SimplePortStyleRenderer
  
Creates an Object which reflects the current state of the style and the model item.
SimplePortStyleRenderer
  
[override] Factory method for the StyleDescriptor property.
SimplePortStyleRenderer
  
SimplePortStyleRenderer
 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
  
shouldRepaint(oldCache:Object):Boolean
Whether the current display object should be repainted.
SimplePortStyleRenderer
  
updateLayout(obj:DisplayObject, context:IDisplayObjectContext):void
SimplePortStyleRenderer
  
updateRenderDataCache(renderDataCache:Object):Object
Updates the given object with the current state of the style and the node.
SimplePortStyleRenderer
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
configure()method 
override protected function configure():void

Prepares this instance for subsequent calls after the style and item have been initialized.

Upon invocation the style and item fields have been populated by the getDisplayObjectCreator or getBoundsProvider methods.

createDisplayObject()method 
override public function createDisplayObject(context:IDisplayObjectContext):DisplayObject

Parameters

context:IDisplayObjectContext

Returns
DisplayObject
createRenderDataCache()method 
protected function createRenderDataCache():Object

Creates an Object which reflects the current state of the style and the model item.

Returns
Object — An Object which reflects the current state of the style and the model item.
createStyleDescriptor()method 
override protected function createStyleDescriptor():ICanvasObjectDescriptor

Factory method for the StyleDescriptor property. This method will be called upon first access to the styleDescriptor property.

Returns
ICanvasObjectDescriptor — An ICanvasObjectDescriptor instance that will delegate to this instance's methods
isHit()method 
override public function isHit(x:Number, y:Number, ctx:ICanvasContext):Boolean

Parameters

x:Number
 
y:Number
 
ctx:ICanvasContext

Returns
Boolean
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
paint()method 
protected function paint(g:YGraphics, ctx:IDisplayObjectContext):void

Parameters

g:YGraphics
 
ctx:IDisplayObjectContext

shouldRepaint()method 
protected function shouldRepaint(oldCache:Object):Boolean

Whether the current display object should be repainted.

Parameters

oldCache:Object — An object which reflects the state of the style and node when the object was repainted the last time.

Returns
Booleantrue if a repaint is necessary.
updateDisplayObject()method 
override public function updateDisplayObject(oldDisplayObject:DisplayObject, context:IDisplayObjectContext):DisplayObject

Parameters

oldDisplayObject:DisplayObject
 
context:IDisplayObjectContext

Returns
DisplayObject
updateLayout()method 
protected function updateLayout(obj:DisplayObject, context:IDisplayObjectContext):void

Parameters

obj:DisplayObject
 
context:IDisplayObjectContext

updateRenderDataCache()method 
protected function updateRenderDataCache(renderDataCache:Object):Object

Updates the given object with the current state of the style and the node.

Parameters

renderDataCache:Object — The object to update.

Returns
Object — An object with the current state of the style and the node.