Packagecom.yworks.canvas.drawing
Classpublic class SimpleTextPaintable
InheritanceSimpleTextPaintable Inheritance AbstractTextPaintable Inheritance Object

A simple implementation of a display object creator that paints text in the created DisplayObject.



Public Properties
 PropertyDefined By
 Inheritedtext : String
The text to draw.
AbstractTextPaintable
 InheritedtextFormat : UITextFormat
The text format to use for the text.
AbstractTextPaintable
Public Methods
 MethodDefined By
  
SimpleTextPaintable(textFormat:UITextFormat, p:IPoint)
Constructor.
SimpleTextPaintable
  
[override] Returns a tight rectangular area where the whole rendering would fit into.
SimpleTextPaintable
 Inherited
create(text:String, textFormat:UITextFormat, location:IPoint):AbstractTextPaintable
[static] Creates a dynamic display object creator that renders the string in its created DisplayObject using the textFormat at the given location.
AbstractTextPaintable
 Inherited
AbstractTextPaintable
  
[override]
SimpleTextPaintable
 Inherited
updateDisplayObject(oldDisplayObject:DisplayObject, context:IDisplayObjectContext):DisplayObject
AbstractTextPaintable
Constructor Detail
SimpleTextPaintable()Constructor
public function SimpleTextPaintable(textFormat:UITextFormat, p:IPoint)

Constructor.

Parameters
textFormat:UITextFormat — The text format to use for the text
 
p:IPoint — Where to draw the text (top left anchor point).
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
paint()method 
override public function paint(g:YGraphics, ctx:IPaintContext):void

Parameters

g:YGraphics
 
ctx:IPaintContext