com.yworks.yfiles.graph.styles

Interface ILabelStyleRenderer

All Known Implementing Classes:

DefaultLabelStyleRenderer, IconLabelStyleRenderer, TemplateLabelStyleRenderer, VoidLabelStyleRenderer

public interface ILabelStyleRenderer

Interface used by ILabelStyle implementations to query the actual IVisualCreator, IVisibilityTestable, IBoundsProvider, IHitTestable, and IMarqueeTestable implementations for a label and an associated style.

Implementations of this interface should be designed to be sharable between multiple style instances and should therefore not contain style specific state.

See Also:

ILabelStyle, ILabel, INodeStyleRenderer, IEdgeStyleRenderer, IPortStyleRenderer

Method Summary

Modifier and Type	Method and Description
IBoundsProvider	getBoundsProvider(ILabel label, ILabelStyle style) Gets an implementation of the IBoundsProvider interface that can handle the provided label and its associated style.
ILookup	getContext(ILabel label, ILabelStyle style) Gets a temporary context instance that can be used to query additional information for the label's style.
IHitTestable	getHitTestable(ILabel label, ILabelStyle style) Gets an implementation of the IHitTestable interface that can handle the provided label and its associated style.
IMarqueeTestable	getMarqueeTestable(ILabel label, ILabelStyle style) Gets an implementation of the IMarqueeTestable interface that can handle the provided label and its associated style.
SizeD	getPreferredSize(ILabel label, ILabelStyle style) Calculates the preferred size of a given label using the associated style.
IVisibilityTestable	getVisibilityTestable(ILabel label, ILabelStyle style) Gets an implementation of the IVisibilityTestable interface that can handle the provided label and its associated style.
IVisualCreator	getVisualCreator(ILabel label, ILabelStyle style) Gets an implementation of the IVisualCreator interface that can handle the provided label and its associated style.

Method Detail

getBoundsProvider

IBoundsProvider getBoundsProvider(ILabel label,
                                  ILabelStyle style)

Gets an implementation of the IBoundsProvider interface that can handle the provided label and its associated style.

This method may return a flyweight implementation.

Parameters:

label - The label to provide an instance for

style - The style to use for the calculating the painting bounds

Returns:

An implementation that may be used to subsequently query the label's painting bounds. Clients should not cache this instance and must always call this method immediately before using the value returned. This enables the use of the flyweight design pattern for implementations

getContext

ILookup getContext(ILabel label,
                   ILabelStyle style)

Gets a temporary context instance that can be used to query additional information for the label's style.

Implementations may return ILookup.EMPTY if they don't support this, but may not return null.

Parameters:

label - The label to provide a context instance for.

style - The style to use for the context.

Returns:

An non-null lookup implementation.

See Also:

ILookup.EMPTY, ILookup

getHitTestable

IHitTestable getHitTestable(ILabel label,
                            ILabelStyle style)

Gets an implementation of the IHitTestable interface that can handle the provided label and its associated style.

This method may return a flyweight implementation.

Parameters:

label - The label to provide an instance for

style - The style to use for the querying hit tests

Returns:

An implementation that may be used to subsequently perform hit tests. Clients should not cache this instance and must always call this method immediately before using the value returned. This enables the use of the flyweight design pattern for implementations. This method may return null to indicate that the label cannot be hit tested.

getMarqueeTestable

IMarqueeTestable getMarqueeTestable(ILabel label,
                                    ILabelStyle style)

Gets an implementation of the IMarqueeTestable interface that can handle the provided label and its associated style.

This method may return a flyweight implementation.

Parameters:

label - The label to provide an instance for

style - The style to use for the querying marquee intersection test.

Returns:

An implementation that may be used to subsequently query the marquee intersections. Clients should not cache this instance and must always call this method immediately before using the value returned. This enables the use of the flyweight design pattern for implementations

getPreferredSize

SizeD getPreferredSize(ILabel label,
                       ILabelStyle style)

Calculates the preferred size of a given label using the associated style.

Parameters:

label - The label to determine the preferred size for

style - The style instance that uses this instance as its Renderer

Returns:

A size that can be used as the PreferredSize if this renderer renders the label using the associated style.

getVisibilityTestable

IVisibilityTestable getVisibilityTestable(ILabel label,
                                          ILabelStyle style)

Gets an implementation of the IVisibilityTestable interface that can handle the provided label and its associated style.

This method may return a flyweight implementation.

Parameters:

label - The label to provide an instance for

style - The style to use for the testing the visibility

Returns:

An implementation that may be used to subsequently query the label's visibility. Clients should not cache this instance and must always call this method immediately before using the value returned. This enables the use of the flyweight design pattern for implementations

getVisualCreator

IVisualCreator getVisualCreator(ILabel label,
                                ILabelStyle style)

Gets an implementation of the IVisualCreator interface that can handle the provided label and its associated style.

This method may return a flyweight implementation, but never null.

Parameters:

label - The label to provide an instance for

style - The style to use for the creation of the visual

Returns:

An implementation that may be used to subsequently create or update the visual for the label. Clients should not cache this instance and must always call this method immediately before using the value returned. This enables the use of the flyweight design pattern for implementations. This method may not return null but should yield a void implementation instead.

See Also:

VoidVisualCreator.INSTANCE