Package com.nomagic.magicdraw.ui.browser.actions

Class DefaultBrowserAction

java.lang.Object

javax.swing.AbstractAction

com.nomagic.actions.NMAction

com.nomagic.magicdraw.actions.MDAction

com.nomagic.magicdraw.ui.browser.actions.DefaultBrowserAction

All Implemented Interfaces:

BrowserAction, com.nomagic.magicdraw.actions.ShortcutSchemaAction, ActionListener, Serializable, Cloneable, Comparable, EventListener, Action

@OpenApiAll
public class DefaultBrowserAction
extends MDAction
implements BrowserAction

The default implementation of BrowserAction and simple MDAction

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.nomagic.actions.NMAction

ACTION_SHORTCUTS, BELONGS_TO_SEPARATE_GROUP_IN_UI, DO_NO_SHOW_ACTION_NAME_IN_UI, DO_NOT_REGISTER_ACTION_TO_COMPONENTS, GENERATED_ID_PREFIX, GROUP, ID, LARGE_ICON, MENU_SHORTCUT_MASK, TINY_ICON

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
DefaultBrowserAction(String actionID, String actionName, KeyStroke stroke, String group)	Constructs new action.
DefaultBrowserAction(String actionID, String actionName, KeyStroke stroke, String group, boolean useShortcutSchema)	Constructs new action.

Method Summary

Modifier and Type	Method	Description
static Tree	getActiveTree()
BaseElement	getFirstElement()	Returns first selected element.
BaseElement	getFirstElement(Tree tree)	Returns first selected element in a given tree.
Collection<? extends BaseElement>	getSelectedBaseElements()	Collects selected base elements in tree
protected Object	getSelectedObject()
static Object	getSelectedObject(Tree tree)	Returns first selected object in a given tree.
Collection<?>	getSelectedObjects()	Collect selected user objects in tree
static Stream<Object>	getSelectedObjectsStream(Tree tree)
Tree	getTree()	Return tree of this action.
protected Tree	getTreeOrActiveTree()
void	setTree(Tree tree)	Set tree for this action.

Methods inherited from class com.nomagic.magicdraw.actions.MDAction

actionPerformed, isUseShortcutSchema, updateState

Methods inherited from class com.nomagic.actions.NMAction

accept, addAction, addPropertyChangeListener, addShortcut, addShotcut, addWeakPropertyChangeListener, clone, compareTo, createMenuItem, equals, firePropertyChange, forEach, forEachIncludingSelf, getActions, getCommandKey, getDescription, getGroup, getIcon, getID, getLargeIcon, getLargeOrSmallIcon, getMenuShortcutMaskAsString, getMnemonicKey, getName, getPropertyChangeListeners, getShortcuts, getSmallIcon, getSmallOrLargeIcon, getTinyIcon, hashCode, hasMenuShortcutMask, isIDGenerated, removeAction, removeIf, removePropertyChangeListener, removeShortcut, removeWeakPropertyChangeListener, setActions, setDescription, setGroup, setIcon, setLargeIcon, setMnemonicKey, setName, setShortcuts, setSmallIcon, setTinyIcon, shallowClone, toString

Methods inherited from class javax.swing.AbstractAction

getKeys, getValue, isEnabled, putValue, setEnabled

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.swing.Action

accept

Constructor Details

DefaultBrowserAction

@OpenApi
public DefaultBrowserAction(@CheckForNull
 String actionID,
 String actionName,
 @CheckForNull
 KeyStroke stroke,
 @CheckForNull
 String group)

Constructs new action.

Parameters:

actionID - the action ID

actionName - the action name

stroke - the action stroke

group - the action group

DefaultBrowserAction

@OpenApi
public DefaultBrowserAction(@CheckForNull
 String actionID,
 @CheckForNull
 String actionName,
 @CheckForNull
 KeyStroke stroke,
 @CheckForNull
 String group,
 boolean useShortcutSchema)

Constructs new action.

Parameters:

actionID - the action ID

actionName - the action name

stroke - the action stroke

group - the action group

useShortcutSchema - use shortcut schema

Method Details

setTree

public void setTree(@CheckForNull
 Tree tree)

Set tree for this action.

Specified by:

setTree in interface BrowserAction

Parameters:

tree - the browser for this action

getTree

@CheckForNull
public Tree getTree()

Return tree of this action. MagicDraw framework guarantee that tree will set if this method is called from updateState() or actionPerformed(ActionEvent) methods.

Returns:

browser of this action

getTreeOrActiveTree

@CheckForNull
protected Tree getTreeOrActiveTree()

Returns:

action's tree or active tree in browser of action's tree is null

getActiveTree

@CheckForNull
public static Tree getActiveTree()

getSelectedObject

@CheckForNull
public static Object getSelectedObject(@CheckForNull
 Tree tree)

Returns first selected object in a given tree.

Parameters:

tree - given tree

Returns:

first selected object

getFirstElement

@CheckForNull
public BaseElement getFirstElement(@CheckForNull
 Tree tree)

Returns first selected element in a given tree.

Parameters:

tree - given tree

Returns:

first selected element

getFirstElement

@CheckForNull
public BaseElement getFirstElement()

Returns first selected element.

Returns:

first selected element

getSelectedObject

@CheckForNull
protected Object getSelectedObject()

Returns:

selected object in tree

getSelectedObjects

public Collection<?> getSelectedObjects()

Collect selected user objects in tree

Returns:

collection of selected objects. Empty collection is nothing is selected

getSelectedBaseElements

public Collection<? extends BaseElement> getSelectedBaseElements()

Collects selected base elements in tree

Returns:

collection of selected base elements. Empty collection is nothing is selected

getSelectedObjectsStream

public static Stream<Object> getSelectedObjectsStream(@CheckForNull
 Tree tree)