com.yworks.yfiles.view.input

Class DefaultStripeInputVisualizationHelper

java.lang.Object

com.yworks.yfiles.view.input.DefaultStripeInputVisualizationHelper

All Implemented Interfaces:

IStripeInputVisualizationHelper

public class DefaultStripeInputVisualizationHelper
extends Object
implements IStripeInputVisualizationHelper

Default implementation of IStripeInputVisualizationHelper that uses IVisualTemplates for the actual visualization.

If you want to change the global behavior, you can just provide a different IVisualTemplate for the various predefined template keys in the application resources. If you want to override the visualization for a specific stripe only, assign a different IVisualTemplate to the instance that is already present in the stripe's lookup.

Field Summary

Fields

Modifier and Type	Field and Description
static ResourceKey	DRAG_SOURCE_STRIPE_TEMPLATE_KEY A ResourceKey that can be used to store a IVisualTemplate that can be used to create the visual that will be used to draw the highlight for the current source of a stripe reparent operation.
static ResourceKey	DROP_TARGET_STRIPE_TEMPLATE_KEY A ResourceKey that can be used to store a IVisualTemplate that can be used to create the visual that will be used to draw the highlight for the current target of a stripe reparent operation.
static ResourceKey	RESIZE_STRIPE_TEMPLATE_KEY A ResourceKey that can be used to store a IVisualTemplate that can be used to create the visual that will be used to draw the highlight for the stripe that is resized.
static ResourceKey	SELECTED_STRIPE_TEMPLATE_KEY A ResourceKey that can be used to store a IVisualTemplate that can be used to create the visual that will be used to draw the highlight for the stripe that is selected.

Constructor Summary

Constructors

Constructor and Description
DefaultStripeInputVisualizationHelper(IStripe stripe) Default constructor.

Method Summary

Modifier and Type	Method and Description
protected IVisualTemplate	findTemplate(IInputModeContext context, StripeVisualizationType type) Provide a IVisualTemplate that is used to visualize type.
IVisualTemplate	getDragSourceStripeTemplate() Data template that is used to visualize the current source of a stripe reparent operation.
IVisualTemplate	getDropTargetStripeTemplate() Data template that is used to visualize the current target of a stripe reparent operation.
IVisualTemplate	getResizeStripeTemplate() Data template that is used to visualize the current stripe resize operation.
IVisualTemplate	getSelectedStripeTemplate() Data template that is used to visualize the current stripe resize operation.
IVisualCreator	getVisualCreator(IInputModeContext context, INode tableNode, StripeVisualizationType type) Return an IVisualCreator that is used to visualize the input operation specified by type.
void	setDragSourceStripeTemplate(IVisualTemplate value) Data template that is used to visualize the current source of a stripe reparent operation.
void	setDropTargetStripeTemplate(IVisualTemplate value) Data template that is used to visualize the current target of a stripe reparent operation.
void	setResizeStripeTemplate(IVisualTemplate value) Data template that is used to visualize the current stripe resize operation.
void	setSelectedStripeTemplate(IVisualTemplate value) Data template that is used to visualize the current stripe resize operation.

Methods inherited from class java.lang.Object

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

Field Detail

DRAG_SOURCE_STRIPE_TEMPLATE_KEY

public static final ResourceKey DRAG_SOURCE_STRIPE_TEMPLATE_KEY

A ResourceKey that can be used to store a IVisualTemplate that can be used to create the visual that will be used to draw the highlight for the current source of a stripe reparent operation.

This template is used for StripeVisualizationType.DRAG_SOURCE

See Also:

getVisualCreator(IInputModeContext, INode, StripeVisualizationType)

DROP_TARGET_STRIPE_TEMPLATE_KEY

public static final ResourceKey DROP_TARGET_STRIPE_TEMPLATE_KEY

A ResourceKey that can be used to store a IVisualTemplate that can be used to create the visual that will be used to draw the highlight for the current target of a stripe reparent operation.

This template is used for StripeVisualizationType.DROP_TARGET

See Also:

getVisualCreator(IInputModeContext, INode, StripeVisualizationType)

RESIZE_STRIPE_TEMPLATE_KEY

public static final ResourceKey RESIZE_STRIPE_TEMPLATE_KEY

A ResourceKey that can be used to store a IVisualTemplate that can be used to create the visual that will be used to draw the highlight for the stripe that is resized.

This template is used for StripeVisualizationType.RESIZE

See Also:

getVisualCreator(IInputModeContext, INode, StripeVisualizationType)

SELECTED_STRIPE_TEMPLATE_KEY

public static final ResourceKey SELECTED_STRIPE_TEMPLATE_KEY

A ResourceKey that can be used to store a IVisualTemplate that can be used to create the visual that will be used to draw the highlight for the stripe that is selected.

This template is used for StripeVisualizationType.SELECTION

See Also:

getVisualCreator(IInputModeContext, INode, StripeVisualizationType)

Constructor Detail

DefaultStripeInputVisualizationHelper

public DefaultStripeInputVisualizationHelper(IStripe stripe)

Default constructor.

Parameters:

stripe - The stripe for which the visualizations are intended

Method Detail

findTemplate

protected IVisualTemplate findTemplate(IInputModeContext context,
                                       StripeVisualizationType type)

Provide a IVisualTemplate that is used to visualize type.

Parameters:

context - The input mode context. Allows you to access the CanvasControl to retrieve the resources.

type - The visualization type

Returns:

A IVisualTemplate that is used to visualize type.

getDragSourceStripeTemplate

public final IVisualTemplate getDragSourceStripeTemplate()

Data template that is used to visualize the current source of a stripe reparent operation.

This template is used for StripeVisualizationType.DRAG_SOURCE

Returns:

The template for the stripe resize visualization or null in which case the default template that is stored under DRAG_SOURCE_STRIPE_TEMPLATE_KEY is used.

See Also:

getVisualCreator(IInputModeContext, INode, StripeVisualizationType), setDragSourceStripeTemplate(IVisualTemplate)

getDropTargetStripeTemplate

public final IVisualTemplate getDropTargetStripeTemplate()

Data template that is used to visualize the current target of a stripe reparent operation.

This template is used for StripeVisualizationType.DROP_TARGET

Returns:

The template for the stripe resize visualization or null in which case the default template that is stored under DROP_TARGET_STRIPE_TEMPLATE_KEY is used.

See Also:

getVisualCreator(IInputModeContext, INode, StripeVisualizationType), setDropTargetStripeTemplate(IVisualTemplate)

getResizeStripeTemplate

public final IVisualTemplate getResizeStripeTemplate()

Data template that is used to visualize the current stripe resize operation.

This template is used for StripeVisualizationType.RESIZE

Returns:

The template for the stripe resize visualization or null in which case the default template that is stored under RESIZE_STRIPE_TEMPLATE_KEY is used.

See Also:

getVisualCreator(IInputModeContext, INode, StripeVisualizationType), setResizeStripeTemplate(IVisualTemplate)

getSelectedStripeTemplate

public final IVisualTemplate getSelectedStripeTemplate()

Data template that is used to visualize the current stripe resize operation.

This template is used for StripeVisualizationType.SELECTION

Returns:

The template for the stripe resize visualization or null in which case the default template that is stored under SELECTED_STRIPE_TEMPLATE_KEY is used.

See Also:

getVisualCreator(IInputModeContext, INode, StripeVisualizationType), setSelectedStripeTemplate(IVisualTemplate)

getVisualCreator

public final IVisualCreator getVisualCreator(IInputModeContext context,
                                             INode tableNode,
                                             StripeVisualizationType type)

Return an IVisualCreator that is used to visualize the input operation specified by type.

This implementation uses IVisualTemplates for the actual visualization.

Specified by:

getVisualCreator in interface IStripeInputVisualizationHelper

Parameters:

context - The input mode context which provides further information.

tableNode - The node where the stripe's owner is currently bound to.

type - The actual visualization type

Returns:

A IVisualCreator instance that renders a representation for the current operation.

See Also:

getResizeStripeTemplate()

setDragSourceStripeTemplate

public final void setDragSourceStripeTemplate(IVisualTemplate value)

Data template that is used to visualize the current source of a stripe reparent operation.

This template is used for StripeVisualizationType.DRAG_SOURCE

Parameters:

value - The template for the stripe resize visualization or null in which case the default template that is stored under DRAG_SOURCE_STRIPE_TEMPLATE_KEY is used.

See Also:

getVisualCreator(IInputModeContext, INode, StripeVisualizationType), getDragSourceStripeTemplate()

setDropTargetStripeTemplate

public final void setDropTargetStripeTemplate(IVisualTemplate value)

Data template that is used to visualize the current target of a stripe reparent operation.

This template is used for StripeVisualizationType.DROP_TARGET

Parameters:

value - The template for the stripe resize visualization or null in which case the default template that is stored under DROP_TARGET_STRIPE_TEMPLATE_KEY is used.

See Also:

getVisualCreator(IInputModeContext, INode, StripeVisualizationType), getDropTargetStripeTemplate()

setResizeStripeTemplate

public final void setResizeStripeTemplate(IVisualTemplate value)

Data template that is used to visualize the current stripe resize operation.

This template is used for StripeVisualizationType.RESIZE

Parameters:

value - The template for the stripe resize visualization or null in which case the default template that is stored under RESIZE_STRIPE_TEMPLATE_KEY is used.

See Also:

getVisualCreator(IInputModeContext, INode, StripeVisualizationType), getResizeStripeTemplate()

setSelectedStripeTemplate

public final void setSelectedStripeTemplate(IVisualTemplate value)

Data template that is used to visualize the current stripe resize operation.

This template is used for StripeVisualizationType.SELECTION

Parameters:

value - The template for the stripe resize visualization or null in which case the default template that is stored under SELECTED_STRIPE_TEMPLATE_KEY is used.

See Also:

getVisualCreator(IInputModeContext, INode, StripeVisualizationType), getSelectedStripeTemplate()