C

GroupNodeLabelModel

Show Usages
A label model for group node labels that are placed inside the tab or tab background area of a GroupNodeStyle instance.
ImplementsInheritance Hierarchy

Members

No filters for this type

Constructors

GroupNodeLabelModel

()
Initializes a new instance of this class.

Parameters

Properties

considerTabPadding

: boolean
Gets or sets a value that determines if the label geometry calculated by this model takes the tabPadding into account.

If true, the label geometry will fill the area between group or folder icon and the outer border of the tab (background) area only up to a distance of tabPadding to the icon and border. If false, the label geometry will fill the aforementioned area completely.

The default value is true.

final

Methods

createTabBackgroundParameter

(): GroupNodeLabelModelParameter
Creates a parameter that places labels inside the tab background area of a GroupNodeStyle.
final

Return Value

GroupNodeLabelModelParameter
A parameter that places labels inside the tab background area of a GroupNodeStyle.

See Also

Developer's Guide

createTabParameter

(): GroupNodeLabelModelParameter
Creates a parameter that places labels inside the tab area of a GroupNodeStyle instance.
final

Return Value

GroupNodeLabelModelParameter
A parameter that places labels inside the tab area of a GroupNodeStyle instance.

See Also

Developer's Guide

getContext

(label: ILabel): ILookup
Provides a lookup context for the given label.
final

Parameters

label: ILabel
The label to use in the context.

Return Value

ILookup
An implementation of the ILookup interface that can be used to query additional aspects of the label.

getGeometry

(label: ILabel, layoutParameter: ILabelModelParameter): IOrientedRectangle
Calculates the geometry of the given label using the given model parameter.
final

Parameters

label: ILabel
The label to calculate the geometry for.
layoutParameter: ILabelModelParameter
A parameter that is compatible with this model. Typically, this is a parameter that has been created by this model, and its property model returns this instance.

Return Value

IOrientedRectangle
An IOrientedRectangle that describes the geometry of the label. This is typically designed as a flyweight, therefore clients should not cache the instance but store the values if they need a snapshot for later use.