| Package | com.yworks.graph.drawing |
| Class | public class AbstractLabelStyleRenderer |
| Inheritance | AbstractLabelStyleRenderer  AbstractStyleRenderer |
| Implements | ILabelStyleRenderer |
| Subclasses | SimpleLabelStyleRenderer |
ILabelStyleRenderer that
can be used to conveniently create custom label style implementations.
| Property | Defined by | ||
|---|---|---|---|
 | item : IModelItem
Gets the currently configured item.
| AbstractStyleRenderer | |
| layout : IOrientedRectangle
[read-only]
Retrieves the current layout.
| AbstractLabelStyleRenderer | ||
| style : IVisualStyle
Gets the currently configured style.
| AbstractStyleRenderer | |
| styleDescriptor : ICanvasObjectDescriptor
Gets the ICanvasObjectDescriptor to use for new installations.
| AbstractStyleRenderer | |
| Property | Defined by | ||
|---|---|---|---|
| _layout : IOrientedRectangle
Holds the layout of the current label.
| AbstractLabelStyleRenderer | ||
| Method | Defined by | ||
|---|---|---|---|
|
Returns a tight rectangular area where the whole rendering
would fit into.
| AbstractLabelStyleRenderer | ||
|
Configures the
style and item parameters,
calls configure and returns this. | AbstractStyleRenderer | |
|
Configures the
style and item parameters,
does not call configure and returns this. | AbstractStyleRenderer | |
|
Configures the
style and item parameters,
calls configure and returns this. | AbstractStyleRenderer | |
|
Configures the
style and item parameters,
calls configure and returns this. | AbstractStyleRenderer | |
|
Configures the
style and item parameters,
calls configure and returns this. | AbstractStyleRenderer | |
|
Calculates the
ILabel.preferredSize of a given label using the
associated style. | AbstractLabelStyleRenderer | ||
|
Installs the model in the canvas at the given group using the
styleDescriptor. | AbstractStyleRenderer | |
|
isHit(x:Number, y:Number, ctx:ICanvasContext):Boolean
Hit tests the item by trying to apply the flash internal hit testing.
| AbstractLabelStyleRenderer | ||
|
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. | AbstractLabelStyleRenderer | ||
|
Calls
configure and tests the item using the style
for a visible intersection with the clip bounds. | AbstractStyleRenderer | |
|
lookup(type:Class):Object
Implements the
ILookup interface. | AbstractStyleRenderer | |
|
Performs the default painting logic and delegates to
paintContent. | AbstractLabelStyleRenderer | ||
| Method | Defined by | ||
|---|---|---|---|
|
Calculates the preferred size given the current state of the renderer.
| AbstractLabelStyleRenderer | ||
|
configure():void
Updates the
layout usign the item's layout. | AbstractLabelStyleRenderer | ||
|
Factory method for the styleDescriptor property.
| AbstractLabelStyleRenderer | ||
|
isAutoFlip():Boolean
Determines whether the label's style should automatically flip the painting contents if the
layout is upside down. | AbstractLabelStyleRenderer | ||
|
paintContent(g:YGraphics, ctx:IPaintContext, width:Number, height:Number):void
Performs the core painting logic.
| AbstractLabelStyleRenderer | ||
|
setItem(item:IModelItem):void
Called by the various descriptor getters to initialize the item.
| AbstractStyleRenderer | |
|
setStyle(style:IVisualStyle):void
Called by the various descriptor getters to initialize the style.
| AbstractStyleRenderer | |
| _layout | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesprotected var _layout:IOrientedRectangleHolds the layout of the current label.
This value is set during configure to the label's layout
See also
| layout | property |
layout:IOrientedRectangle [read-only]Retrieves the current layout.
Implementation public function get layout():IOrientedRectangle
| _getPreferredSize | () | method |
protected function _getPreferredSize():ISizeCalculates the preferred size given the current state of the renderer.
ReturnsISize —
The size as suggested by this renderer.
|
| calculateBounds | () | method |
public override function calculateBounds(scratch:IMutableRectangle, ctx:ICanvasContext):IRectangleReturns 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.
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)
|
IRectangle —
The bounds or null to indicate an unbound area
|
| configure | () | method |
protected override function configure():void
Updates the layout usign the item's layout.
Subclasses should override this method, call the super implementation and configure their painting entities.
| createStyleDescriptor | () | method |
protected override function createStyleDescriptor():ICanvasObjectDescriptor
Factory method for the styleDescriptor property.
This method will be called upon first access to the
styleDescriptor property.
ICanvasObjectDescriptor —
An instance of LabelStyleDescriptor
|
See also
| getPreferredSize | () | method |
public function getPreferredSize(label:ILabel, style:ILabelStyle):ISize
Calculates the ILabel.preferredSize of a given label using the
associated style.
label:ILabel — The label to determine the preferred size for
|
|
style:ILabelStyle — The style instance that uses this instance as its ILabelStyle.styleRenderer.
|
ISize —
A size that can be used as the ILabel.preferredSize
if this renderer paints the label using the associated style. May return
null if there is no such thing like a preferred size for this
style.
|
| isAutoFlip | () | method |
protected function isAutoFlip():Boolean
Determines whether the label's style should automatically flip the painting contents if the
layout is upside down.
Boolean — true
|
| isHit | () | method |
public override function isHit(x:Number, y:Number, ctx:ICanvasContext):BooleanHit tests the item by trying to apply the flash internal hit testing.
This implementation does not take ICanvasContext.hitTestRadius into account.
Parametersx:Number |
|
y:Number |
|
ctx:ICanvasContext |
Boolean |
| isInBox | () | method |
public override 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.
box:IRectangle — The box describing the marquee's bounds
|
|
ctx:ICanvasContext — The current canvas context
|
Boolean — true if the item is considered to be captured by the marquee
|
| paint | () | method |
public override function paint(g:YGraphics, ctx:IPaintContext):void
Performs the default painting logic and delegates to paintContent.
Simple subclasses should just override paintContent and isAutoFlip
and leave this default implementation of paint.
g:YGraphics — The graphics context to paint to.
|
|
ctx:IPaintContext — The paint context.
|
| paintContent | () | method |
protected function paintContent(g:YGraphics, ctx:IPaintContext, width:Number, height:Number):voidPerforms the core painting logic.
Implementations should paint into the graphics context inside the <0,0> - <width, height> rectangle.
Parametersg:YGraphics — The graphics context to paint to.
|
|
ctx:IPaintContext — The painting context.
|
|
width:Number — The width of the area to paint into.
|
|
height:Number — The height of the area to paint into.
|