|
Oxygen XML Editor 15.0 Author API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@API(type=NOT_EXTENDABLE, src=PUBLIC) public interface WSTextEditorPage
Text editor page access.
Method Summary | |
---|---|
void |
addPopUpMenuCustomizer(TextPopupMenuCustomizer popUpCustomizer)
Add the pop-up menu customizer which can be used to customize the pop-up menu (add/remove actions) before showing it in the Text page. |
void |
beginCompoundUndoableEdit()
Begin a compound undoable edit operation. |
void |
endCompoundUndoableEdit()
End a compound undoable edit operation. |
TextActionsProvider |
getActionsProvider()
Provides access to actions already defined in the Text page like: Undo, Redo, etc. |
int |
getColumnOfOffset(int offset)
Converts an offset position (a position between the characters of the text) to the column number in the line that contains the offset. |
javax.swing.text.Document |
getDocument()
Get the edited document. |
int |
getLineOfOffset(int offset)
Converts an offset position (a position between the characters of the text) to the line number that contains the offset. |
int |
getOffsetOfLineEnd(int lineNumber)
Gets the offset of the end of the specified line (return >=0). |
int |
getOffsetOfLineStart(int lineNumber)
Gets the offset of the start of the specified line (return >=0). |
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. |
void |
removePopUpMenuCustomizer(TextPopupMenuCustomizer popUpCustomizer)
Remove the pop-up menu customizer which is used to customize the pop-up menu (add/remove actions) before showing it in the Text page. |
Methods inherited from interface ro.sync.exml.workspace.api.editor.page.WSTextBasedEditorPage |
---|
deleteSelection, getCaretOffset, getLocationOnScreenAsPoint, getLocationRelativeToEditorFromScreen, getSelectedText, getSelectionEnd, getSelectionStart, getStartEndOffsets, getWordAtCaret, hasSelection, isEditable, modelToViewRectangle, select, selectWord, setCaretPosition, setEditable, viewToModelOffset |
Method Detail |
---|
javax.swing.text.Document getDocument()
java.lang.Object getTextComponent()
WSTextXMLSchemaManager getXMLSchemaManager()
void beginCompoundUndoableEdit()
try{ beginCompoundUndoableEdit(); //YOUR CODE HERE } finally{ endCompoundUndoableEdit(); }
void endCompoundUndoableEdit()
try{ beginCompoundUndoableEdit(); //YOUR CODE HERE } finally{ endCompoundUndoableEdit(); }
int getLineOfOffset(int offset) throws javax.swing.text.BadLocationException
offset
- Offset in document.
javax.swing.text.BadLocationException
- When the offset is not valid.int getColumnOfOffset(int offset) throws javax.swing.text.BadLocationException
offset
- The offset that is to be checked.
javax.swing.text.BadLocationException
- Bad Location Exception.int getOffsetOfLineStart(int lineNumber) throws javax.swing.text.BadLocationException
lineNumber
- The number of the line. Indexed in 1.
javax.swing.text.BadLocationException
- When line does not exist.
java.lang.IllegalArgumentException
- If the line number is out of range.int getOffsetOfLineEnd(int lineNumber) throws javax.swing.text.BadLocationException
lineNumber
- The number of the line. Indexed in 1.
javax.swing.text.BadLocationException
- If the line number is out of range.void addPopUpMenuCustomizer(TextPopupMenuCustomizer popUpCustomizer)
popUpCustomizer
- the pop-up menu customizer.void removePopUpMenuCustomizer(TextPopupMenuCustomizer popUpCustomizer)
popUpCustomizer
- the pop-up menu customizer.TextActionsProvider getActionsProvider()
|
Oxygen XML Editor 15.0 Author API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |