Field Detail

• GUARDED

  public static final java.lang.Object GUARDED

  Attribute that signals that a given character is guarded (cannot be modified). Implements AttributeSet.CharacterAttribute to signal that this attribute applies to characters, not paragraphs.

• BREAKPOINT_STYLE_NAME

  @Deprecated
  public static final java.lang.String BREAKPOINT_STYLE_NAME

  Deprecated. since 6.29. Use Annotation instead.
  Name of style attached to documents to mark a paragraph (line) as a (debugger) breakpoint.

  See Also:

  Constant Field Values

• ERROR_STYLE_NAME

  @Deprecated
  public static final java.lang.String ERROR_STYLE_NAME

  Deprecated. since 6.29. Use Annotation instead.
  Name of style attached to documents to mark a paragraph (line) as erroneous.

  See Also:

  Constant Field Values

• CURRENT_STYLE_NAME

  @Deprecated
  public static final java.lang.String CURRENT_STYLE_NAME

  Deprecated. since 6.29. Use Annotation instead.
  Name of style attached to documents to mark a paragraph (line) as current (in a debugger).

  See Also:

  Constant Field Values

• NORMAL_STYLE_NAME

  @Deprecated
  public static final java.lang.String NORMAL_STYLE_NAME

  Deprecated. since 6.29. Use Annotation instead.
  Name of style attached to documents to unmark a paragraph (line) as anything special.

  See Also:

  Constant Field Values

Method Detail

• findLineRootElement

  public static javax.swing.text.Element findLineRootElement​(javax.swing.text.StyledDocument doc)

  Find the root element of all lines. All conforming NetBeans documents should return a valid element.

  Parameters:

  doc - styled document (expecting NetBeans document)

  Returns:

  the root element

  Throws:

  java.lang.NullPointerException - If the doc parameter is null.

• findLineNumber

  public static int findLineNumber​(javax.swing.text.StyledDocument doc,
                                   int offset)

  For given document and an offset, find the line number.

  Parameters:

  doc - the document

  offset - offset in the document

  Returns:

  the line number for that offset

  Throws:

  java.lang.NullPointerException - If the doc parameter is null.

• findLineColumn

  public static int findLineColumn​(javax.swing.text.StyledDocument doc,
                                   int offset)

  Finds column number given an offset.

  Parameters:

  doc - the document

  offset - offset in the document

  Returns:

  column within the line of that offset (counting starts from zero)

  Throws:

  java.lang.NullPointerException - If the doc parameter is null.

• findLineOffset

  public static int findLineOffset​(javax.swing.text.StyledDocument doc,
                                   int lineNumber)

  Finds offset of the beginning of a line.

  Parameters:

  doc - the document

  lineNumber - number of the line to find the start of (zero-based)

  Returns:

  offset

  Throws:

  java.lang.NullPointerException - If the doc parameter is null.

  java.lang.IndexOutOfBoundsException - when incorrect lineNumber value is inserted

• createPosition

  public static javax.swing.text.Position createPosition​(javax.swing.text.Document doc,
                                                         int offset,
                                                         javax.swing.text.Position.Bias bias)
                                                  throws javax.swing.text.BadLocationException

  Creates position with a bias. If the bias is Position.Bias.Backward then if an insert occures at the position, the text is inserted after the position. If the bias is Forward, then the text is inserted before the position.

  The method checks if the document implements NbDocument.PositionBiasable, and if so, createPosition is called. Otherwise an attempt is made to provide a Position with the correct behavior.

  Parameters:

  doc - document to create position in

  offset - the current offset for the position

  bias - the bias to use for the position

  Throws:

  java.lang.NullPointerException - If the doc parameter is null.

  javax.swing.text.BadLocationException - if the offset is invalid

• markGuarded

  public static void markGuarded​(javax.swing.text.StyledDocument doc,
                                 int offset,
                                 int len)

  Mark part of a document as guarded (immutable to the user).

  Parameters:

  doc - styled document

  offset - offset to start at

  len - length of text to mark as guarded

  Throws:

  java.lang.NullPointerException - If the doc parameter is null.

• unmarkGuarded

  public static void unmarkGuarded​(javax.swing.text.StyledDocument doc,
                                   int offset,
                                   int len)

  Remove guarded mark on a block of a document.

  Parameters:

  doc - styled document

  offset - offset to start at

  len - length of text to mark as unguarded

  Throws:

  java.lang.NullPointerException - If the doc parameter is null.

• insertGuarded

  public static void insertGuarded​(javax.swing.text.StyledDocument doc,
                                   int offset,
                                   java.lang.String txt)
                            throws javax.swing.text.BadLocationException

  Inserts a text into given offset and marks it guarded.

  Parameters:

  doc - document to insert to

  offset - offset of insertion

  txt - string text to insert

  Throws:

  java.lang.NullPointerException - If the doc parameter is null.

  javax.swing.text.BadLocationException

• markBreakpoint

  @Deprecated
  public static void markBreakpoint​(javax.swing.text.StyledDocument doc,
                                    int offset)

  Deprecated. since 1.20. Use addAnnotation() instead
  Attach a breakpoint to a line in the document. If the document has a defined style named BREAKPOINT_STYLE_NAME, it is used. Otherwise, a new style is defined.

  Parameters:

  doc - the document

  offset - identifies the line to set breakpoint to

  Throws:

  java.lang.NullPointerException - If the doc parameter is null.

• markError

  @Deprecated
  public static void markError​(javax.swing.text.StyledDocument doc,
                               int offset)

  Deprecated. since 1.20. Use addAnnotation() instead
  Mark a line as erroneous (e.g. by the compiler). If the document has a defined style named ERROR_STYLE_NAME, it is used. Otherwise, a new style is defined.

  Parameters:

  doc - the document

  offset - identifies the line to mark

  Throws:

  java.lang.NullPointerException - If the doc parameter is null.

• markCurrent

  @Deprecated
  public static void markCurrent​(javax.swing.text.StyledDocument doc,
                                 int offset)

  Deprecated. since 1.20. Use addAnnotation() instead
  Marks a line as current (e.g. for the debugger). If the document has a defined style named CURRENT_STYLE_NAME, it is used. Otherwise, a new style is defined.

  Parameters:

  doc - the document

  offset - identifies the line to mark

  Throws:

  java.lang.NullPointerException - If the doc parameter is null.

• markNormal

  @Deprecated
  public static void markNormal​(javax.swing.text.StyledDocument doc,
                                int offset)

  Deprecated. since 1.20. Use addAnnotation() instead
  Mark a line as normal (no special attributes). This uses the dummy style named NORMAL_STYLE_NAME. This method should be used to undo the effect of markBreakpoint(javax.swing.text.StyledDocument, int), markError(javax.swing.text.StyledDocument, int) and markCurrent(javax.swing.text.StyledDocument, int).

  Parameters:

  doc - the document

  offset - identified the line to unmark

  Throws:

  java.lang.NullPointerException - If the doc parameter is null.

• findRecentEditorPane

  public static javax.swing.JEditorPane findRecentEditorPane​(EditorCookie ec)

  Gets recently selected editor pane opened by editor cookie Can be called from AWT event thread only.

  Parameters:

  ec - EditorCookie used to find out recently selected editor pane

  Returns:

  pane or null

  Since:

  6.24

• runAtomic

  public static void runAtomic​(javax.swing.text.StyledDocument doc,
                               java.lang.Runnable run)

  Locks the document to have exclusive access to it. Documents implementing Lockable can specify exactly how to do this.

  Parameters:

  doc - document to lock

  run - the action to run

  Throws:

  java.lang.NullPointerException - If the doc parameter is null.

• runAtomicAsUser

  public static void runAtomicAsUser​(javax.swing.text.StyledDocument doc,
                                     java.lang.Runnable run)
                              throws javax.swing.text.BadLocationException

  Executes given runnable in "user mode" does not allowing any modifications to parts of text marked as guarded. The actions should be run as "atomic" so either happen all at once or none at all (if a guarded block should be modified).

  Parameters:

  doc - document to modify

  run - runnable to run in user mode that will have exclusive access to modify the document

  Throws:

  java.lang.NullPointerException - If the doc parameter is null.

  javax.swing.text.BadLocationException - if a modification of guarded text occured and that is why no changes to the document has been done.

• findPageable

  public static java.lang.Object findPageable​(javax.swing.text.StyledDocument doc)

  Find a way to print a given document. If the document implements the correct interface(s) then the document is returned, else a default Printable is used as a wrapper. In this last case it is useful to implement NbDocument.Printable to describe how to print in terms of attributed characters, rather than specifying the complete page layout from scratch.

  Parameters:

  doc - the document to find printing support for

  Returns:

  an object that is instance of eith Printable or Pageable

• addAnnotation

  public static void addAnnotation​(javax.swing.text.StyledDocument doc,
                                   javax.swing.text.Position startPos,
                                   int length,
                                   Annotation annotation)

  Add annotation to the document. For annotation of whole line the length parameter can be ignored (specify value -1).
  Note: since 6.35 the requests (delegated to document) are no longer replanned to EDT.

  Parameters:

  doc - the document which will be annotated

  startPos - position which represent begining of the annotated text

  length - length of the annotated text. If -1 is specified the whole line will be annotated

  annotation - annotation which is attached to this text

  Since:

  1.20

• removeAnnotation

  public static void removeAnnotation​(javax.swing.text.StyledDocument doc,
                                      Annotation annotation)

  Removal of added annotation.
  Note: since 6.35 the requests (delegated to document) are no longer replanned to EDT.

  Parameters:

  doc - the annotated document

  annotation - annotation which is going to be removed

  Since:

  1.20

• getEditToBeUndoneOfType

  public static <T extends javax.swing.undo.UndoableEdit> T getEditToBeUndoneOfType​(EditorCookie ec,
                                                                                    java.lang.Class<T> type)

  Get an edit of given type that would be undone if an undo operation would be invoked at this time for an editor cookie.
  The edit to be undone may be composed from instances of various undoable edit types (see UndoableEditWrapper).

  Type Parameters:

  T - type of undoable edit to be retrieved.

  Parameters:

  ec - editor cookie providing an undo/redo manager.

  type - class of undoable edit to be retrieved.

  Returns:

  undoable edit of given type or null if there is no edit to be undone or an instance of the given type is not contained in the edit to be undone.

  Since:

  6.49

• getEditToBeRedoneOfType

  public static <T extends javax.swing.undo.UndoableEdit> T getEditToBeRedoneOfType​(EditorCookie ec,
                                                                                    java.lang.Class<T> type)

  Get an edit of given type that would be redone if a redo operation would be invoked at this time for an editor cookie.
  The edit to be undone may be composed from instances of various undoable edit types (see UndoableEditWrapper).

  Type Parameters:

  T - type of undoable edit to be retrieved.

  Parameters:

  ec - editor cookie providing an undo/redo manager.

  type - class of undoable edit to be retrieved.

  Returns:

  undoable edit of given type or null if there is no edit to be redone or an instance of the given type is not contained in the edit to be redone.

  Since:

  6.49

• getDocument

  public static javax.swing.text.StyledDocument getDocument​(org.openide.util.Lookup.Provider provider)

  Get the document associated with a file.

  Method will throw UserQuestionException exception if file size is too big. This exception is caught and its method UserQuestionException.confirmed() is used for confirmation.

  Parameters:

  provider - for example a org.openide.loaders.DataObject

  Returns:

  a document or null

  Since:

  org.openide.text 6.46

• openDocument

  public static boolean openDocument​(org.openide.util.Lookup.Provider provider,
                                     int offset,
                                     Line.ShowOpenType openType,
                                     Line.ShowVisibilityType visibilityType)

  Open the document associated with a file in the Editor window in a position specified by the offset while controlling open and visibility behavior. This method can be called from any thread but blocks until the document is opened.

  Parameters:

  provider - for example a org.openide.loaders.DataObject

  offset - the position the document should be opened (starting at 0)

  openType - control open behavior, Line.ShowOpenType.OPEN would typically be used

  visibilityType - control visibility behavior, Line.ShowVisibilityType.FOCUS would typically be used

  Returns:

  true if the Document is opened - false otherwise

  Since:

  org.openide.text 6.46

  See Also:

  UserQuestionException handling

• openDocument

  public static boolean openDocument​(org.openide.util.Lookup.Provider provider,
                                     int line,
                                     int column,
                                     Line.ShowOpenType openType,
                                     Line.ShowVisibilityType visibilityType)

  Open the document associated with a file in the Editor window in a position specified by the line and column while controlling open and visibility behavior. This method can be called from any thread but blocks until the document is opened.

  Parameters:

  provider - for example a org.openide.loaders.DataObject

  line - the line the document should be opened (starting at 0)

  column - the column which should be selected (starting at 0), value -1 does not change previously selected column

  openType - control open behavior, Line.ShowOpenType.OPEN would typically be used

  visibilityType - control visibility behavior, Line.ShowVisibilityType.FOCUS would typically be used

  Returns:

  true if the Document is opened - false otherwise

  Since:

  org.openide.text 6.46

  See Also:

  UserQuestionException handling