com.yworks.yfiles.graph.styles

Class IconLabelStyleRenderer

java.lang.Object

com.yworks.yfiles.graph.styles.IconLabelStyleRenderer

All Implemented Interfaces:

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

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

An ILabelStyleRenderer that can handle IconLabelStyle instances.

This implementation renders the label's inner style and an icon.

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
IconLabelStyleRenderer() Creates a new instance of this renderer.

Method Summary

Modifier and Type	Method and Description
protected void	configure()
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 Image	getIcon() Retrieves the Icon from the Style.
protected ILabelModelParameter	getIconPlacement() Retrieves the IconPlacement from the Style.
protected SizeD	getIconSize() Gets the size of the icon from the IconSize property.
protected InsetsD	getInnerStyleInsets() Retrieves the WrappedInsets from the Style.
protected ILabel	getLabel() Gets the currently configured label.
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 IconLabelStyle	getStyle() Gets the currently configured style.
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 ILabelStyle	getWrappedStyle() Retrieves the Wrapped from the Style.
protected boolean	isAutoFlippingEnabled() Retrieves the AutoFlippingEnabled property from the Style.
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) Determines whether an element might intersect the visible region for a given context.
<TLookup> TLookup	lookup(Class<TLookup> type) Implements the ILookup interface.
protected void	setLabel(ILabel value) Sets the currently configured label.
protected void	setStyle(IconLabelStyle value) Sets the currently configured style.
protected boolean	shouldHitTestIcon() Returns whether the icon bounds should be considered for hit testing.
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

IconLabelStyleRenderer

public IconLabelStyleRenderer()

Creates a new instance of this renderer.

Method Detail

configure

protected void configure()

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)

getIcon

protected Image getIcon()

Retrieves the Icon from the Style.

Returns:

The icon.

getIconPlacement

protected ILabelModelParameter getIconPlacement()

Retrieves the IconPlacement from the Style.

Returns:

The placement parameter.

getIconSize

protected SizeD getIconSize()

Gets the size of the icon from the IconSize property.

Returns:

The size to use for the icon.

getInnerStyleInsets

protected InsetsD getInnerStyleInsets()

Retrieves the WrappedInsets from the Style.

Returns:

The insets.

getLabel

protected final ILabel getLabel()

Gets the currently configured label.

Returns:

The Label.

See Also:

setLabel(ILabel)

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 IconLabelStyle getStyle()

Gets the currently configured style.

Returns:

The Style.

See Also:

setStyle(IconLabelStyle)

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)

getWrappedStyle

protected ILabelStyle getWrappedStyle()

Retrieves the Wrapped from the Style.

Returns:

The style.

isAutoFlippingEnabled

protected boolean isAutoFlippingEnabled()

Retrieves the AutoFlippingEnabled property from the Style.

Returns:

The autoflip property value.

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)

Description copied from interface: IVisibilityTestable

Determines whether an element might intersect the visible region for a given context.

Conservative implementations can always return true.

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

setStyle

protected final void setStyle(IconLabelStyle value)

Sets the currently configured style.

Parameters:

value - The Style to set.

See Also:

getStyle()

shouldHitTestIcon

protected boolean shouldHitTestIcon()

Returns whether the icon bounds should be considered for hit testing.

Returns:

true

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