com.yworks.yfiles.graph.styles

Class TemplateLabelStyleRenderer

java.lang.Object

com.yworks.yfiles.graph.styles.TemplateLabelStyleRenderer

All Implemented Interfaces:

ILookup, ILabelStyleRenderer, IBoundsProvider, IHitTestable, IMarqueeTestable, IVisibilityTestable, IVisualCreator

public class TemplateLabelStyleRenderer
extends Object
implements ILabelStyleRenderer, IVisualCreator, IBoundsProvider, IHitTestable, IMarqueeTestable, IVisibilityTestable, ILookup

An implementation of the ILabelStyleRenderer interface that can render TemplateLabelStyle instances.

See Also:

TemplateLabelStyle

Field Summary

Fields inherited from interface com.yworks.yfiles.view.IBoundsProvider

EMPTY, UNBOUNDED

Fields inherited from interface com.yworks.yfiles.view.input.IHitTestable

ALWAYS, NEVER

Fields inherited from interface com.yworks.yfiles.view.input.IMarqueeTestable

ALWAYS, NEVER

Fields inherited from interface com.yworks.yfiles.view.IVisibilityTestable

ALWAYS, NEVER

Fields inherited from interface com.yworks.yfiles.graph.ILookup

EMPTY

Constructor Summary

Constructors

Constructor and Description
TemplateLabelStyleRenderer()

Method Summary

Modifier and Type	Method and Description
protected void	arrange(Node visual) Arranges the provided element according to the current Layout, taking into account the value of isAutoFlippingEnabled(TemplateLabelStyle).
protected void	configure() Stores the layout.
Node	createVisual(IRenderContext context) Creates the visual by delegating to TemplateLabelStyle.createControl(IRenderContext, ILabel) and then initializing the control with the context.
RectD	getBounds(ICanvasContext context) Returns a tight rectangular area where the whole rendering would fit into.
IBoundsProvider	getBoundsProvider(ILabel label, ILabelStyle style) Configures the Style and Label properties, calls configure() and returns this.
ILookup	getContext(ILabel label, ILabelStyle style) Configures the Style and Label properties, does not call configure() and returns this.
IHitTestable	getHitTestable(ILabel label, ILabelStyle style) Configures the Style and Label properties, calls configure() and returns this.
protected ILabel	getLabel() Gets the currently configured label.
protected IOrientedRectangle	getLayout() Holds the layout of the current label.
IMarqueeTestable	getMarqueeTestable(ILabel label, ILabelStyle style) Configures the Style and Label properties, calls configure() and returns this.
protected GeneralPath	getNormalizedOutline(TemplateLabelStyle style) Gets the normalized outline by delegating to NormalizedOutline.
SizeD	getPreferredSize(ILabel label, ILabelStyle style) Calculates the preferred size for the given label and style.
protected SizeD	getPreferredSize(IRenderContext context) Gets the size of the preferred for the current configuration using the provided context.
SizeD	getPreferredSize(IRenderContext context, ILabel label, ILabelStyle style) Calculates the preferred size for the given label and style.
protected TemplateLabelStyle	getStyle() Gets the currently configured style.
IVisibilityTestable	getVisibilityTestable(ILabel label, ILabelStyle style) Configures the Style and Label properties, does not call configure() and returns this.
IVisualCreator	getVisualCreator(ILabel label, ILabelStyle style) Configures the Style and Label properties, calls configure() and returns this.
protected boolean	isAutoFlippingEnabled(TemplateLabelStyle style) Delegates to the TemplateLabelStyle's AutoFlippingEnabled property.
boolean	isHit(IInputModeContext context, PointD location) Determines if something has been hit at the given coordinates in the world coordinate system.
boolean	isInBox(IInputModeContext context, RectD rectangle) This callback returns true if the corresponding item is considered to intersect the given rectangular box.
boolean	isVisible(ICanvasContext context, RectD rectangle) Uses the layout to determine whether the clip intersects.
<TLookup> TLookup	lookup(Class<TLookup> type) Delegates to the ContextLookup of the ILabelStyle.
protected Object	lookupContext(TemplateLabelStyle style, ILabel label, Class type) Delegates to the TemplateLabelStyle's ContextLookup.
protected void	setLabel(ILabel value) Sets the currently configured label.
protected void	setStyle(TemplateLabelStyle value) Sets the currently configured style.
Node	updateVisual(IRenderContext context, Node oldVisual) Updates the Node correspondingly.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.yworks.yfiles.view.IBoundsProvider

fromRectangle

Methods inherited from interface com.yworks.yfiles.view.input.IHitTestable

create

Methods inherited from interface com.yworks.yfiles.graph.ILookup

createDictionaryLookup, createDynamic, createSingle, createSingle, createWrapped, lookup, lookup, safeLookup

Constructor Detail

TemplateLabelStyleRenderer

public TemplateLabelStyleRenderer()

Method Detail

arrange

protected void arrange(Node visual)

Arranges the provided element according to the current Layout, taking into account the value of isAutoFlippingEnabled(TemplateLabelStyle).

Parameters:

visual - The element to arrange to fit into the Layout.

configure

protected void configure()

Stores the layout.

Subclasses should override this method, call the super implementation and configure their painting entities.

createVisual

public final Node createVisual(IRenderContext context)

Creates the visual by delegating to TemplateLabelStyle.createControl(IRenderContext, ILabel) and then initializing the control with the context.

Specified by:

createVisual in interface IVisualCreator

Parameters:

context - The context for the creation.

Returns:

The control that is used for rendering the label.

See Also:

IVisualCreator.updateVisual(IRenderContext, Node)

getBounds

public RectD getBounds(ICanvasContext context)

Description copied from interface: IBoundsProvider

Returns a tight rectangular area where the whole rendering would fit into.

If calculating the bounds is too expensive or the rendering is not bound to a certain area, this method may return RectD.INFINITE. If nothing is rendered, this method should return an empty rectangle, where either or both the width and height is non-positive or RectD.EMPTY.

Specified by:

getBounds in interface IBoundsProvider

Parameters:

context - the context to calculate the bounds for

Returns:

the bounds or RectD.EMPTY to indicate an unbound area

getBoundsProvider

public IBoundsProvider getBoundsProvider(ILabel label,
                                         ILabelStyle style)

Configures the Style and Label properties, calls configure() and returns this.

Specified by:

getBoundsProvider in interface ILabelStyleRenderer

Parameters:

label - The label to retrieve the bounds provider for. The value will be stored in the Label property.

style - The style to associate with the label. The value will be stored in the Style property.

Returns:

this

See Also:

getBounds(ICanvasContext)

getContext

public ILookup getContext(ILabel label,
                          ILabelStyle style)

Configures the Style and Label properties, does not call configure() and returns this.

As this method may be called often it will not automatically call configure(), instead subclasses should ensure that in the lookup(Class) method call they should call configure() only if needed, i.e. if they decide to return this or an instance that depends on a correctly configured this.

Specified by:

getContext in interface ILabelStyleRenderer

Parameters:

label - The label to query the context for. The value will be stored in the Label property.

style - The style to associate with the label. The value will be stored in the Style property.

Returns:

this

See Also:

lookup(Class)

getHitTestable

public IHitTestable getHitTestable(ILabel label,
                                   ILabelStyle style)

Configures the Style and Label properties, calls configure() and returns this.

Specified by:

getHitTestable in interface ILabelStyleRenderer

Parameters:

label - The label to query hit test with. The value will be stored in the Label property.

style - The style to associate with the label. The value will be stored in the Style property.

Returns:

this

See Also:

isHit(IInputModeContext, PointD)

getLabel

protected final ILabel getLabel()

Gets the currently configured label.

Returns:

The Label.

See Also:

setLabel(ILabel)

getLayout

protected final IOrientedRectangle getLayout()

Holds the layout of the current label.

This value is set during configure() to the label's layout

Returns:

The Layout.

getMarqueeTestable

public IMarqueeTestable getMarqueeTestable(ILabel label,
                                           ILabelStyle style)

Configures the Style and Label properties, calls configure() and returns this.

Specified by:

getMarqueeTestable in interface ILabelStyleRenderer

Parameters:

label - The label to query marquee intersection tests. The value will be stored in the Label property.

style - The style to associate with the label. The value will be stored in the Style property.

Returns:

this

See Also:

isInBox(IInputModeContext, RectD)

getNormalizedOutline

protected GeneralPath getNormalizedOutline(TemplateLabelStyle style)

Gets the normalized outline by delegating to NormalizedOutline.

getPreferredSize

public SizeD getPreferredSize(ILabel label,
                              ILabelStyle style)

Calculates the preferred size for the given label and style.

Specified by:

getPreferredSize in interface ILabelStyleRenderer

Parameters:

label - The label instance.

style - The style instance to apply.

Returns:

The preferred size for the given label and style.

See Also:

getPreferredSize(IRenderContext)

getPreferredSize

protected SizeD getPreferredSize(IRenderContext context)

Gets the size of the preferred for the current configuration using the provided context.

Parameters:

context - The context.

getPreferredSize

public SizeD getPreferredSize(IRenderContext context,
                              ILabel label,
                              ILabelStyle style)

Calculates the preferred size for the given label and style.

Parameters:

label - The label instance.

style - The style instance to apply.

Returns:

The preferred size for the given label and style.

See Also:

getPreferredSize(IRenderContext)

getStyle

protected final TemplateLabelStyle getStyle()

Gets the currently configured style.

Returns:

The Style.

See Also:

setStyle(TemplateLabelStyle)

getVisibilityTestable

public IVisibilityTestable getVisibilityTestable(ILabel label,
                                                 ILabelStyle style)

Configures the Style and Label properties, does not call configure() and returns this.

Unlike most of the other methods this implementation does not call configure(). If the subclass implementation depends on this instance to be configured, it needs to call Configure in isVisible(ICanvasContext, RectD).

Specified by:

getVisibilityTestable in interface ILabelStyleRenderer

Parameters:

label - The label to query visibility tests. The value will be stored in the Label property.

style - The style to associate with the label. The value will be stored in the Style property.

Returns:

this

See Also:

isVisible(ICanvasContext, RectD)

getVisualCreator

public IVisualCreator getVisualCreator(ILabel label,
                                       ILabelStyle style)

Configures the Style and Label properties, calls configure() and returns this.

Specified by:

getVisualCreator in interface ILabelStyleRenderer

Parameters:

label - The label to retrieve the IVisualCreator for. The value will be stored in the Label property.

style - The style to associate with the label. The value will be stored in the Style property.

Returns:

this

See Also:

createVisual(IRenderContext), updateVisual(IRenderContext, Node)

isAutoFlippingEnabled

protected boolean isAutoFlippingEnabled(TemplateLabelStyle style)

Delegates to the TemplateLabelStyle's AutoFlippingEnabled property.

isHit

public boolean isHit(IInputModeContext context,
                     PointD location)

Description copied from interface: IHitTestable

Determines if something has been hit at the given coordinates in the world coordinate system.

Implementations should inspect the HitTestRadius and take the value into account when performing hit tests. This allows the user to hit elements even if the zoom level is very small and allows for accurate hit tests at greater zoom levels.

Specified by:

isHit in interface IHitTestable

Parameters:

context - the context the hit test is performed in

location - the coordinates in world coordinate system

Returns:

whether something has been hit

isInBox

public boolean isInBox(IInputModeContext context,
                       RectD rectangle)

Description copied from interface: IMarqueeTestable

This callback 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.

Implementations should respect the HitTestRadius if marquee selections should behave differently on different zoom levels.

Specified by:

isInBox in interface IMarqueeTestable

Parameters:

context - the current input mode context

rectangle - the box describing the marquee's bounds

Returns:

true if the item is considered to be captured by the marquee

isVisible

public boolean isVisible(ICanvasContext context,
                         RectD rectangle)

Uses the layout to determine whether the clip intersects.

Specified by:

isVisible in interface IVisibilityTestable

Parameters:

context - The context to determine the visibility for.

rectangle - The visible region clip.

Returns:

false if and only if it is safe not to paint the element because it would not affect the given clipping region.

lookup

public <TLookup> TLookup lookup(Class<TLookup> type)

Delegates to the ContextLookup of the ILabelStyle.

Specified by:

lookup in interface ILookup

Parameters:

type - The type to query an instance for.

Returns:

The implementation or null.

lookupContext

protected Object lookupContext(TemplateLabelStyle style,
                               ILabel label,
                               Class type)

Delegates to the TemplateLabelStyle's ContextLookup.

Parameters:

style - The style to look up the context for.

label - The current label.

type - The type to look up.

Returns:

The result from the context or null.

setLabel

protected final void setLabel(ILabel value)

Sets the currently configured label.

Parameters:

value - The Label to set.

See Also:

getLabel()

setStyle

protected final void setStyle(TemplateLabelStyle value)

Sets the currently configured style.

Parameters:

value - The Style to set.

See Also:

getStyle()

updateVisual

public final Node updateVisual(IRenderContext context,
                               Node oldVisual)

Updates the Node correspondingly.

Specified by:

updateVisual in interface IVisualCreator

Parameters:

context - The context for the creation.

oldVisual - The currently rendered visual.

Returns:

The control that is used for rendering the label.

See Also:

IVisualCreator.createVisual(IRenderContext), ICanvasObjectDescriptor, CanvasControl