Package org.kie.workbench.common.stunner.core.client.canvas.controls.actions

Class DefaultTextPropertyProviderImpl

java.lang.Object

org.kie.workbench.common.stunner.core.client.canvas.controls.actions.DefaultTextPropertyProviderImpl

All Implemented Interfaces:

TextPropertyProvider

@ApplicationScoped
public class DefaultTextPropertyProviderImpl
extends Object
implements TextPropertyProvider

Constructor Summary

Constructors

Constructor	Description
DefaultTextPropertyProviderImpl()
DefaultTextPropertyProviderImpl(org.kie.workbench.common.stunner.core.util.DefinitionUtils definitionUtils, org.kie.workbench.common.stunner.core.client.command.CanvasCommandFactory<AbstractCanvasHandler> canvasCommandFactory)

Method Summary

Modifier and Type	Method	Description
int	getPriority()	Returns the priority of the TextPropertyProvider.
String	getText(org.kie.workbench.common.stunner.core.graph.Element<? extends org.kie.workbench.common.stunner.core.graph.content.definition.Definition> element)	Gets the text on the initialised Element.
void	setText(AbstractCanvasHandler canvasHandler, org.kie.workbench.common.stunner.core.client.command.CanvasCommandManager<AbstractCanvasHandler> commandManager, org.kie.workbench.common.stunner.core.graph.Element<? extends org.kie.workbench.common.stunner.core.graph.content.definition.Definition> element, String text)	Sets the text on the initialised Element.
boolean	supports(org.kie.workbench.common.stunner.core.graph.Element<? extends org.kie.workbench.common.stunner.core.graph.content.definition.Definition> element)	Returns whether the TextPropertyProvider supports a given Element.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultTextPropertyProviderImpl

public DefaultTextPropertyProviderImpl()

DefaultTextPropertyProviderImpl

@Inject
public DefaultTextPropertyProviderImpl(org.kie.workbench.common.stunner.core.util.DefinitionUtils definitionUtils,
                                       org.kie.workbench.common.stunner.core.client.command.CanvasCommandFactory<AbstractCanvasHandler> canvasCommandFactory)

Method Detail

getPriority

public int getPriority()

Description copied from interface: TextPropertyProvider

Returns the priority of the TextPropertyProvider. Integer.MIN_VALUE is considered the highest priority, whereas Integer.MAX_VALUE is considered the lowest priority and is used by the default implementation as a "catch all".

Specified by:

getPriority in interface TextPropertyProvider

Returns:

supports

public boolean supports(org.kie.workbench.common.stunner.core.graph.Element<? extends org.kie.workbench.common.stunner.core.graph.content.definition.Definition> element)

Description copied from interface: TextPropertyProvider

Returns whether the TextPropertyProvider supports a given Element.

Specified by:

supports in interface TextPropertyProvider

Parameters:

element - The element to check.

Returns:

true if supported otherwise false.

getText

public String getText(org.kie.workbench.common.stunner.core.graph.Element<? extends org.kie.workbench.common.stunner.core.graph.content.definition.Definition> element)

Description copied from interface: TextPropertyProvider

Gets the text on the initialised Element. {@see TextPropertyProvider.initialiseForReading} which should be called first.

Specified by:

getText in interface TextPropertyProvider

Parameters:

element - The element for which to get the caption.

Returns:

The text to be shown as the caption.

setText

public void setText(AbstractCanvasHandler canvasHandler,
                    org.kie.workbench.common.stunner.core.client.command.CanvasCommandManager<AbstractCanvasHandler> commandManager,
                    org.kie.workbench.common.stunner.core.graph.Element<? extends org.kie.workbench.common.stunner.core.graph.content.definition.Definition> element,
                    String text)

Description copied from interface: TextPropertyProvider

Sets the text on the initialised Element. {@see TextPropertyProvider.initialiseForWriting} which should be called first.

Specified by:

setText in interface TextPropertyProvider

Parameters:

canvasHandler - Required by CommandManager when executing Command's to update the Element's property.

commandManager - A CommandManager with which to execute update commands.

element - The element for which to update the property represented by the caption.

text - The text shown as the caption.