ro.sync.exml.plugin.document

Interface DocumentPluginContext

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public interface DocumentPluginContext

Plugin context interface. Provides information for the plugin about the context it was invoked in.

Method Summary

Modifier and Type	Method and Description
javax.swing.text.Document	getDocument() Get the current document.
java.awt.Frame	getFrame() Get the editing frame.
StandalonePluginWorkspace	getPluginWorkspace() Get access to the entire workspace of Oxygen.
WSTextEditorPage	getTextPage() Get access to the current text page on which this action will be invoked as a contextual menu action.

Method Detail

getDocument

javax.swing.text.Document getDocument()

Get the current document.

Returns:

the current document.

getFrame

java.awt.Frame getFrame()

Get the editing frame.

Returns:

the frame in which is done the editing.

getPluginWorkspace

StandalonePluginWorkspace getPluginWorkspace()

Get access to the entire workspace of Oxygen.

Returns:

The access to the entire workspace of Oxygen

Since:

12.1

getTextPage

WSTextEditorPage getTextPage()

Get access to the current text page on which this action will be invoked as a contextual menu action.

Returns:

Access to the text page API.

Since:

15.1