Oxygen XML Editor 12.2 Author API

ro.sync.exml.workspace.api.editor.page.text
Interface WSTextEditorPage

All Superinterfaces:
WSEditorPage, WSTextBasedEditorPage

public interface WSTextEditorPage
extends WSTextBasedEditorPage

Text editor page access.

Since:
11.2

Method Summary
 void beginCompoundUndoableEdit()
          Begin a compound undoable edit operation.
 void endCompoundUndoableEdit()
          End a compound undoable edit operation.
 javax.swing.text.Document getDocument()
          Get the edited document.
 java.lang.Object getTextComponent()
          Get the internal text component which is currently used for editing.
 WSTextXMLSchemaManager getXMLSchemaManager()
          Get the schema manager used to ask useful information about allowed elements and the context of the current offset.
 
Methods inherited from interface ro.sync.exml.workspace.api.editor.page.WSTextBasedEditorPage
deleteSelection, getCaretOffset, getLocationOnScreenAsPoint, getSelectedText, getSelectionEnd, getSelectionStart, getWordAtCaret, hasSelection, modelToViewRectangle, select, selectWord, setCaretPosition, setEditable, viewToModelOffset
 

Method Detail

getDocument

javax.swing.text.Document getDocument()
Get the edited document. For eclipse, the returned instance is an javax.swing.text.Document adapter over the Eclipse native document.

Returns:
The edited document.

getTextComponent

java.lang.Object getTextComponent()
Get the internal text component which is currently used for editing.

Returns:
for the stand alone version, a javax.swing.JTextArea and for the eclipse implementation a org.eclipse.swt.custom.StyledText.
Since:
12

getXMLSchemaManager

WSTextXMLSchemaManager getXMLSchemaManager()
Get the schema manager used to ask useful information about allowed elements and the context of the current offset.

Returns:
the XML Schema Manager used to ask useful information about allowed elements and the context of the current offset. Only available for opened XML files.
Since:
12.1

*********************************
EXPERIMENTAL - Subject to change
********************************

Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.


beginCompoundUndoableEdit

void beginCompoundUndoableEdit()
Begin a compound undoable edit operation. This is useful if you make modifications through the API and want Oxygen to undo in a single step. This should be used like:
try{
  beginCompoundUndoableEdit();
  //YOUR CODE HERE
 } finally{
  endCompoundUndoableEdit();
 }
 

Since:
12.2

*********************************
EXPERIMENTAL - Subject to change
********************************

Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.


endCompoundUndoableEdit

void endCompoundUndoableEdit()
End a compound undoable edit operation. This is useful if you make modifications through the API and want Oxygen to undo in a single step. This should be used like:
try{
  beginCompoundUndoableEdit();
  //YOUR CODE HERE
 } finally{
  endCompoundUndoableEdit();
 }
 

Since:
12.2

*********************************
EXPERIMENTAL - Subject to change
********************************

Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.


Oxygen XML Editor 12.2 Author API

© Copyright SyncRO Soft SRL 2002 - 2010.