Simantics/ActionBrowseContext module documentation

ActionBrowseContext

data ActionBrowseContext

The counterpart of a browse context for the commands offered on a browsed node. It is built from modelled action contributions, each of which names the node type it applies to and the action category it belongs to, and it is asked for the actions of a single node with getActions.

createActionBrowseContext :: [Resource] -> <ReadGraph> ActionBrowseContext

Creates a new ActionBrowseContext for the given Collection of Resources.

getActions :: ActionBrowseContext -> NodeContext -> [NodeContext] -> <ReadGraph> Map.T IActionCategory [Action]

Gets all the actions for the given NodeContext

Undocumented entities

ACTION_COMPARATOR :: Comparator Action

Comparator for comparing Actions together. Handy for sorting

browseAllContext :: BrowseContext -> NodeContext -> <Proc> ()

Test function for browsing whole BrowseContext for all NodeContexts recursively. Also goes through ActionBrowseContexts

getActionId :: Action -> <Proc> String

Returns the identifier of the action. The result is a Java null when the action has no identifier.

getActionText :: Action -> <Proc> String

Returns the label shown for the action.

getIActionCategoryPriority :: IActionCategory -> <Proc> Double

Gives the priority of the current ActionCategory

getIActionCateogryLabel :: IActionCategory -> <Proc> String

Gives the label of the ActionCategory e.g. New or Edit

isIActionCategorySubmenu :: IActionCategory -> <Proc> Boolean

Boolean value indicating if the category has submenu or not

toActionBrowseContextG :: Vector String -> <ReadGraph> ActionBrowseContext

Returns the action browse context formed by the modelled action browse contexts at the given URIs. The contributions of those contexts and of the subcontexts they include are collected into one context. The result is a Java null if none of the URIs names a resource.