Packagecom.yworks.graph.drawing
Classpublic class SimpleLabelStyle
ImplementsISimpleLabelStyle

The default mutable implementation of the ISimpleLabelStyle interface.



Public Properties
 PropertyDefined by
  backgroundFill : IFill
Gets or sets the stroke to use for the background box of the label or null
SimpleLabelStyle
  backgroundStroke : IStroke
Gets or sets the pen to use for the background box of the label or null
SimpleLabelStyle
  clipText : Boolean
Gets a value that determines whether text should be clipped.
SimpleLabelStyle
  styleRenderer : IStyleRenderer
[read-only] Gets the renderer implementation that has been supplied to this instance upon creation.
SimpleLabelStyle
  textFormat : UITextFormat
SimpleLabelStyle
Public Methods
 MethodDefined by
  
SimpleLabelStyle(renderer:ILabelStyleRenderer = null, textFormat:UITextFormat = null)
SimpleLabelStyle
  
clone():Object
Creates a clone of this instance.
SimpleLabelStyle
  
install(canvas:CanvasComponent, group:ICanvasObjectGroup, modelItem:IModelItem):Array
Prepares the rendering of an IModelItem in a CanvasComponent by adding ICanvasObject's to the provided canvas.
SimpleLabelStyle
Protected Methods
 MethodDefined by
  
Creates a new instance of SimpleLabelStyle
SimpleLabelStyle
Property detail
backgroundFillproperty
backgroundFill:IFill  [read-write]

Gets or sets the stroke to use for the background box of the label or null

Implementation
    public function get backgroundFill():IFill
    public function set backgroundFill(value:IFill):void
backgroundStrokeproperty 
backgroundStroke:IStroke  [read-write]

Gets or sets the pen to use for the background box of the label or null

Implementation
    public function get backgroundStroke():IStroke
    public function set backgroundStroke(value:IStroke):void
clipTextproperty 
clipText:Boolean  [read-write]

Gets a value that determines whether text should be clipped.

Implementation
    public function get clipText():Boolean
    public function set clipText(value:Boolean):void
styleRendererproperty 
styleRenderer:IStyleRenderer  [read-only]

Gets the renderer implementation that has been supplied to this instance upon creation.

Implementation
    public function get styleRenderer():IStyleRenderer
textFormatproperty 
textFormat:UITextFormat  [read-write]Implementation
    public function get textFormat():UITextFormat
    public function set textFormat(value:UITextFormat):void
Constructor detail
SimpleLabelStyle()constructor
public function SimpleLabelStyle(renderer:ILabelStyleRenderer = null, textFormat:UITextFormat = null)Parameters
renderer:ILabelStyleRenderer (default = null)
 
textFormat:UITextFormat (default = null)
Method detail
clone()method
public function clone():Object

Creates a clone of this instance.

Returns
Object — A clone of this instance.
createClone()method 
protected function createClone():SimpleLabelStyle

Creates a new instance of SimpleLabelStyle

Returns
SimpleLabelStyle — A new instance of SimpleLabelStyle
install()method 
public function install(canvas:CanvasComponent, group:ICanvasObjectGroup, modelItem:IModelItem):Array

Prepares the rendering of an IModelItem in a CanvasComponent by adding ICanvasObject's to the provided canvas.

Implementations may add zero or more ICanvasObject instances to the given CanvasComponent. The group parameter can be used as a hint for implementations. They can add their newly created canvas objects to the given group. However they are not obliged to do that.

Parameters
canvas:CanvasComponent — The canvas to install the canvas objects in.
 
group:ICanvasObjectGroup — A hint that tells the implementation where to add the canvas objects.
 
modelItem:IModelItem — The item to install a visual representation for.

Returns
Array — An array of zero or more canvas objects that have been installed in the canvas by this method or null if nothing was installed.