Oxygen XML Web Author

Class: OpenAction

sync.actions. OpenAction

new OpenAction(urlChooser)

Open action.
Parameters:
Name Type Description
urlChooser sync.api.UrlChooser the urlChooser the open action will use.
Deprecated:

Extends

Methods

actionPerformed()

The actual action execution.
Overrides:

dispose()

Should dispose all the resources required by the action.
Inherited From:

getActionId()

Get the action id.
Returns:
the action id or null if none was provided.
Type
string

getDescription()

Returns the description for the action - usually displayed on a tooltip.
Inherited From:
Overrides:
Returns:
The description.
Type
string

getDisplayName()

Returns the display name for the action.
Inherited From:
Overrides:
Returns:
The display name.
Type
string

<protected> getLargeIcon( [devicePixelRation])

One should override this method to provide the absolute URL of the action's large icon.

If you want to distribute the icon in a framework, you need to place it in the "web/" sub-folder of the framework. In this case the absolute URL of the icon can be obtain by concatenating sync.ext.Registry.extensionURL with the relative path of the icon to the "web/" sub-folder.

If you want to distribute the icon in a plugin, you can place it in a directory with static resources using a WebappStaticResourcesFolder extension.

The large icon should have a minimum size of 24 by 24 px for non-hidpi displays and can vary depending on the device pixel ration, the icon being used as the background of a 24 by 24 px DIV.

Parameters:
Name Type Argument Description
devicePixelRation number <optional>
 the device pixel ratio.
Inherited From:
Overrides:
Returns:
The icon URL.
Type
string

getShortcut()

Returns the shortcut, represented as a string. E.g. - "Ctrl B" - "Alt Shift T" - "Ctrl Alt equals" - "Ctrl period" - "Ctrl comma" - "Ctrl back_quote" - "Ctrl open_bracket" - "Ctrl back_slash" - "Ctrl num_lock" - "Ctrl divide" The shortcut may use platform-independent modifiers M1 to M4.
Inherited From:
Returns:
the string representation of the shortcut. If there is no shortcut, returns an empty string.
Type
string

<protected> getSmallIcon( [devicePixelRation])

One should override this method to provide the absolute URL of the action's small icon.

If you want to distribute the icon in a framework, you need to place it in the "web/" sub-folder of the framework. In this case the absolute URL of the icon can be obtain by concatenating sync.ext.Registry.extensionURL with the relative path of the icon to the "web/" sub-folder.

If you want to distribute the icon in a plugin, you can place it in a directory with static resources using a WebappStaticResourcesFolder extension.

The small icon should have a minimum size of 16 by 16 px for non-hidpi displays and can vary depending on the device pixel ration, the small icon being used as the background of a 16px by 16px div.

Parameters:
Name Type Argument Description
devicePixelRation number <optional>
 the device pixel ratio.
Inherited From:
Overrides:
Returns:
The icon URL.
Type
string

isEnabled()

Tells whether the action is enabled. Note: The action is not permanently polled for its "enabled-ness". If you want the GUI to reflect the current status you will have to call sync.api.ActionsManager#refreshActionsStatus.
Inherited From:
Overrides:
Returns:
Whether the action is enabled.
Type
boolean

openFile(fileUrl)

Opens a new file. (Replaces the old url param if there is one)
Parameters:
Name Type Description
fileUrl the file url to open.

renderLargeIcon()

Handles the rendering of the action's large icon.
Overrides:
Returns:
the rendered large icon.
Type
HTMLElement

renderSmallIcon()

This method renders the small icon of the action in a 16px by 16px DIV with the action's small icon as its background. This allows the getSmallIcon() method to return different sized icons depending on the device pixel ration, the size constraints being imposed by the enclosing DIV. It should be overridden only for custom rendering strategies, otherwise consider using the getSmallIcon method.
Inherited From:
Returns:
the rendering of the small icon image.
Type
HTMLElement

setActionId(newActionId)

Set the action id.
Parameters:
Name Type Description
newActionId the new action id.

setActionName(newName)

Sets the action name. The action name is displayed under the action large icon.
Parameters:
Name Type Description
newName the new name.

setDescription(newDescription)

Sets the action's description.
Parameters:
Name Type Description
newDescription the new action description.

setLargeIcon(newLargeIcon)

Setter for the action's large icon.
Parameters:
Name Type Description
newLargeIcon the new icon source.