Provides
IPaintable implementations for drawing text.
This is an abstract class that provides factory methods that each return
a concrete subclass of this.
text:String [read-write]
The text to draw.
Implementation
public function get text():String
public function set text(value:String):void
textFormat:UITextFormat [read-write]
The text format to use for the text.
Implementation
public function get textFormat():UITextFormat
public function set textFormat(value:UITextFormat):void
public function AbstractTextPaintable(textFormat:UITextFormat)
Constructor. Should only be called from child classes.
Parameters
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
|
public static function create(text:String, textFormat:UITextFormat, location:IPoint):AbstractTextPaintable
Creates a dynamic paintable that renders the string using the textFormat
at the given location.
Parameters
| text:String — The string to draw.
|
| |
| textFormat:UITextFormat — The text format to use.
|
| |
| location:IPoint — Where to draw the text (top left anchor).
|
Returns
public function paint(g:YGraphics, ctx:IPaintContext):void
Performs the actual painting into the given graphics context.
Parameters
| g:YGraphics — The graphics context to paint into
|
| |
| ctx:IPaintContext — Currently not used
|
