com.yworks.yfiles.graph.styles

Class DefaultLabelStyleRenderer

java.lang.Object

com.yworks.yfiles.graph.styles.DefaultLabelStyleRenderer

All Implemented Interfaces:

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

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

A simple ILabelStyleRenderer implementation that can handle DefaultLabelStyle instances.

This implementation will just draw the label's Text using the properties provided by DefaultLabelStyle into the label's layout area.

Field Summary

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

EMPTY, UNBOUNDED

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

ALWAYS, NEVER

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

ALWAYS, NEVER

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

ALWAYS, NEVER

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

EMPTY

Constructor Summary

Constructors

Constructor and Description
DefaultLabelStyleRenderer() Creates a new default instance.

Method Summary

Modifier and Type	Method and Description
protected void	configure() Prepares this instance for subsequent calls after the style and label have been initialized.
Node	createVisual(IRenderContext context) This method is called by the framework to create a Node that will be included into the IRenderContext.
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 parameters, calls configure() and returns this.
ILookup	getContext(ILabel label, ILabelStyle style) Configures the style and label parameters, does not call configure() and returns this.
IHitTestable	getHitTestable(ILabel label, ILabelStyle style) Configures the style and label parameters, calls configure() and returns this.
protected ILabel	getLabel() Gets the currently configured label.
protected IOrientedRectangle	getLayout() Retrieves the current layout.
IMarqueeTestable	getMarqueeTestable(ILabel label, ILabelStyle style) Configures the style and label parameters, calls configure() and returns this.
protected SizeD	getPreferredSize() Calculates the preferred size given the current state of the renderer.
SizeD	getPreferredSize(ILabel label, ILabelStyle style) Calculates the preferred size of a given label using the associated style.
protected DefaultLabelStyle	getStyle() Gets the currently configured style.
protected VPos	getVerticalAlignment() Determines how the text should be aligned vertically within the assigned label bounds.
IVisibilityTestable	getVisibilityTestable(ILabel label, ILabelStyle style) Configures the style and label parameters, does not call configure() and returns this.
IVisualCreator	getVisualCreator(ILabel label, ILabelStyle style) Configures the style and label parameters, calls configure() and returns this.
protected boolean	isAutoFlippingEnabled() Delegates to AutoFlippingEnabled.
protected boolean	isClippingTextEnabled() Determines whether text should be forced to be clipped inside the rectangle.
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.
protected boolean	isTextMirrored(IRenderContext context) Determines whether the text should be horizontally mirrored.
boolean	isVisible(ICanvasContext context, RectD rectangle) Uses the ILabel.getLayout() to determine whether the clip intersects.
<TLookup> TLookup	lookup(Class<TLookup> type) Implements the ILookup interface.
protected void	setLabel(ILabel value) Sets the currently configured label.
protected void	setLayout(IOrientedRectangle value) Retrieves the current layout.
protected void	setStyle(DefaultLabelStyle value) Sets the currently configured style.
Node	updateVisual(IRenderContext context, Node oldVisual) This method updates or replaces a previously created Node for inclusion in the IRenderContext.

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

DefaultLabelStyleRenderer

public DefaultLabelStyleRenderer()

Creates a new default instance.

Method Detail

configure

protected void configure()

Prepares this instance for subsequent calls after the style and label have been initialized.

Upon invocation the Style and Label properties have been populated by the getVisualCreator(ILabel, ILabelStyle), getBoundsProvider(ILabel, ILabelStyle), getHitTestable(ILabel, ILabelStyle), or getMarqueeTestable(ILabel, ILabelStyle) methods.

Stores the layout into Layout. Subclasses which to override this method should call the base implementation.

createVisual

public Node createVisual(IRenderContext context)

Description copied from interface: IVisualCreator

This method is called by the framework to create a Node that will be included into the IRenderContext.

CanvasControl uses this interface through the ICanvasObjectDescriptor to populate the visual canvas object tree.

Specified by:

createVisual in interface IVisualCreator

Parameters:

context - The context that describes where the visual will be used.

Returns:

The visual to include in the canvas object visual tree. This may be null.

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 parameters, 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 parameters, 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 parameters, 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()

Retrieves the current layout.

Returns:

The Layout.

See Also:

setLayout(IOrientedRectangle)

getMarqueeTestable

public IMarqueeTestable getMarqueeTestable(ILabel label,
                                           ILabelStyle style)

Configures the style and label parameters, 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)

getPreferredSize

protected SizeD getPreferredSize()

Calculates the preferred size given the current state of the renderer.

Returns:

The size as suggested by this renderer.

getPreferredSize

public final SizeD getPreferredSize(ILabel label,
                                    ILabelStyle style)

Description copied from interface: ILabelStyleRenderer

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

Specified by:

getPreferredSize in interface ILabelStyleRenderer

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.

getStyle

protected final DefaultLabelStyle getStyle()

Gets the currently configured style.

Returns:

The Style.

See Also:

setStyle(DefaultLabelStyle)

getVerticalAlignment

protected VPos getVerticalAlignment()

Determines how the text should be aligned vertically within the assigned label bounds.

Returns:

This value as obtained from the style.

getVisibilityTestable

public IVisibilityTestable getVisibilityTestable(ILabel label,
                                                 ILabelStyle style)

Configures the style and label parameters, 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 parameters, 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()

Delegates to AutoFlippingEnabled.

Returns:

Whether to flip the drawing if it is upside down.

isClippingTextEnabled

protected boolean isClippingTextEnabled()

Determines whether text should be forced to be clipped inside the rectangle.

Returns:

This value as obtained from the style.

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

isTextMirrored

protected boolean isTextMirrored(IRenderContext context)

Determines whether the text should be horizontally mirrored.

This can be necessary if the CanvasControl's NodeOrientation is set to NodeOrientation.RIGHT_TO_LEFT because this will apply a mirroring transform onto the canvas contents, making text unreadable otherwise. This implementation tests whether the flow direction property on the canvas is set to NodeOrientation.RIGHT_TO_LEFT.

Parameters:

context - The context for which the rendering is performed.

Returns:

Whether to apply a mirroring transformation.

isVisible

public boolean isVisible(ICanvasContext context,
                         RectD rectangle)

Uses the ILabel.getLayout() 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)

Implements the ILookup interface.

This method will be used by default if getContext(ILabel, ILabelStyle) has been queried for a lookup implementation. Note that it cannot be assumed that configure() has already been invoked. However, normally Label and Style will be correctly configured if invoked directly after GetContext. Subclass implementations should make sure to configure this instance before they return this as a result of a successful lookup. This implementation will check if type.IsInstanceOfType(this) and will call configure() on success and return this.

Specified by:

lookup in interface ILookup

Parameters:

type - The type to query for.

Returns:

An implementation or null.

setLabel

protected final void setLabel(ILabel value)

Sets the currently configured label.

Parameters:

value - The Label to set.

See Also:

getLabel()

setLayout

protected final void setLayout(IOrientedRectangle value)

Retrieves the current layout.

Parameters:

value - The Layout to set.

See Also:

getLayout()

setStyle

protected final void setStyle(DefaultLabelStyle value)

Sets the currently configured style.

Parameters:

value - The Style to set.

See Also:

getStyle()

updateVisual

public Node updateVisual(IRenderContext context,
                         Node oldVisual)

Description copied from interface: IVisualCreator

This method updates or replaces a previously created Node for inclusion in the IRenderContext.

The CanvasControl uses this method to give implementations a chance to update an existing Visual that has previously been created by the same instance during a call to IVisualCreator.createVisual(IRenderContext). Implementation may update the oldVisual and return that same reference, or create a new visual and return the new instance or null.

Specified by:

updateVisual in interface IVisualCreator

Parameters:

context - The context that describes where the visual will be used in.

oldVisual - The visual instance that had been returned the last time the IVisualCreator.createVisual(IRenderContext) method was called on this instance.

Returns:

oldVisual, if this instance modified the visual, or a new visual that should replace the existing one in the canvas object visual tree.

See Also:

IVisualCreator.createVisual(IRenderContext), ICanvasObjectDescriptor, CanvasControl