Package com.inductiveautomation.ignition.designer.tags.tree.selection

Class TagReferenceAction

java.lang.Object

javax.swing.AbstractAction

com.inductiveautomation.ignition.client.util.action.BaseAction

com.inductiveautomation.ignition.designer.tags.tree.selection.TagReferenceAction

All Implemented Interfaces:

ActionListener, Serializable, Cloneable, EventListener, Action

Direct Known Subclasses:

InsertTagAction

public class TagReferenceAction
extends BaseAction

This action, which needs to be initalized with a text component, will show a dialog box prompting the user to find a tag. When they choose one, the tag's path will be inserted into the text component. Optionally, a RelativePathProvider can be provided in order to generate relative paths instead of absolute paths.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TagReferenceAction.ReferenceStyle

Field Summary

Fields

Modifier and Type	Field	Description
protected TextlikeComponent	comp
protected TagSelectionComponent	component
static final String	SELECTION_PROP

Fields inherited from class javax.swing.AbstractAction

changeSupport, enabled

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

Constructors

Constructor	Description
TagReferenceAction(TextlikeComponent comp)
TagReferenceAction(TextlikeComponent comp, RelativePathProvider relProvider)
TagReferenceAction(TextlikeComponent comp, RelativePathProvider relProvider, TagSelectionComponent selector)
TagReferenceAction(TextlikeComponent comp, RelativePathProvider relProvider, Supplier<TagSelectionComponent> componentGenerator)

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(ActionEvent evt)
JButton	createButton()
protected Component	getParentComponent()
final TagSelectionComponent	getSelectionComponent()	Gets the selection component, lazily if necessary.
protected void	init()
void	reset(TextlikeComponent area)
void	setSelectionComponent(TagSelectionComponent component)
TagReferenceAction	setStyle(TagReferenceAction.ReferenceStyle style)
protected void	setText(String s)
void	setToStringFull(boolean toStringFull)
void	show()

Methods inherited from class com.inductiveautomation.ignition.client.util.action.BaseAction

create, createButton, createButton, evaluateEnabled, listenTo, listenTo, setBundleKey, setIcon, updateEnabled

Methods inherited from class javax.swing.AbstractAction

addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.swing.Action

accept

Field Details

component

protected TagSelectionComponent component

comp

protected TextlikeComponent comp

SELECTION_PROP

public static final String SELECTION_PROP

See Also:

• Constant Field Values

Constructor Details

TagReferenceAction

public TagReferenceAction(TextlikeComponent comp)

TagReferenceAction

public TagReferenceAction(TextlikeComponent comp,
 RelativePathProvider relProvider)

TagReferenceAction

public TagReferenceAction(TextlikeComponent comp,
 RelativePathProvider relProvider,
 Supplier<TagSelectionComponent> componentGenerator)

TagReferenceAction

public TagReferenceAction(TextlikeComponent comp,
 RelativePathProvider relProvider,
 TagSelectionComponent selector)

Method Details

createButton

public JButton createButton()

init

protected void init()

getSelectionComponent

public final TagSelectionComponent getSelectionComponent()

Gets the selection component, lazily if necessary.

setSelectionComponent

public void setSelectionComponent(TagSelectionComponent component)

setText

protected void setText(String s)

reset

public void reset(TextlikeComponent area)

actionPerformed

public void actionPerformed(ActionEvent evt)

show

public void show()

getParentComponent

protected Component getParentComponent()

setToStringFull

public void setToStringFull(boolean toStringFull)

setStyle

public TagReferenceAction setStyle(TagReferenceAction.ReferenceStyle style)