com.yworks.yfiles.graph.styles

Interface IPortStyleRenderer

All Known Implementing Classes:

TemplatePortStyleRenderer, VoidPortStyleRenderer

public interface IPortStyleRenderer

Interface used by IPortStyle implementations that can be used to query the actual IVisualCreator, IBoundsProvider, IHitTestable, IVisibilityTestable, and IMarqueeTestable implementations for a port 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:

IPortStyle, IPort, INodeStyleRenderer, IEdgeStyleRenderer, ILabelStyleRenderer

Method Summary

Modifier and Type	Method and Description
IBoundsProvider	getBoundsProvider(IPort port, IPortStyle style) Gets an implementation of the IBoundsProvider interface that can handle the provided port and its associated style.
ILookup	getContext(IPort port, IPortStyle style) Gets a temporary context instance that can be used to query additional information for the port's style.
IHitTestable	getHitTestable(IPort port, IPortStyle style) Gets an implementation of the IHitTestable interface that can handle the provided port and its associated style.
IMarqueeTestable	getMarqueeTestable(IPort port, IPortStyle style) Gets an implementation of the IMarqueeTestable interface that can handle the provided port and its associated style.
IVisibilityTestable	getVisibilityTestable(IPort port, IPortStyle style) Gets an implementation of the IVisibilityTestable interface that can handle the provided port and its associated style.
IVisualCreator	getVisualCreator(IPort port, IPortStyle style) Gets an implementation of the IVisualCreator interface that can handle the provided port and its associated style.

Method Detail

getBoundsProvider

IBoundsProvider getBoundsProvider(IPort port,
                                  IPortStyle style)

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

This method may return a flyweight implementation.

Parameters:

port - The port 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 port'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(IPort port,
                   IPortStyle style)

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

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

Parameters:

port - The port 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(IPort port,
                            IPortStyle style)

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

This method may return a flyweight implementation.

Parameters:

port - The port 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 port cannot be hit tested.

getMarqueeTestable

IMarqueeTestable getMarqueeTestable(IPort port,
                                    IPortStyle style)

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

This method may return a flyweight implementation.

Parameters:

port - The port 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

getVisibilityTestable

IVisibilityTestable getVisibilityTestable(IPort port,
                                          IPortStyle style)

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

This method may return a flyweight implementation.

Parameters:

port - The port 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 port'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(IPort port,
                                IPortStyle style)

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

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

Parameters:

port - The port 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 port. 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