Constructor Detail

• IndentEngine

  public IndentEngine​()

  Deprecated. 

Method Detail

• getHelpCtx

  public org.openide.util.HelpCtx getHelpCtx​()

  Deprecated. 

  Specified by:

  getHelpCtx in class org.openide.ServiceType

• indentLine

  public abstract int indentLine​(javax.swing.text.Document doc,
                                 int offset)

  Deprecated. 
  Indents the current line. Should not effect any other lines.

  Parameters:

  doc - the document to work on

  offset - the offset of a character on the line

  Returns:

  new offset of the original character

• indentNewLine

  public abstract int indentNewLine​(javax.swing.text.Document doc,
                                    int offset)

  Deprecated. 
  Inserts new line at given position and indents the new line with spaces.

  Parameters:

  doc - the document to work on

  offset - the offset of a character on the line

  Returns:

  new offset to place cursor to

• createWriter

  public abstract java.io.Writer createWriter​(javax.swing.text.Document doc,
                                              int offset,
                                              java.io.Writer writer)

  Deprecated. 
  Creates writer that formats text that is inserted into it. The writer should not modify the document but use the provided writer to write to. Usually the underlaying writer will modify the document itself and optionally it can remember the current position in document. That is why the newly created writer should do no buffering.

  The provided document and offset are only informational, should not be modified but only used to find correct indentation strategy.

  Parameters:

  doc - document

  offset - position to begin inserts at

  writer - writer to write to

  Returns:

  new writer that will format written text and pass it into the writer

• acceptMimeType

  protected boolean acceptMimeType​(java.lang.String mime)

  Deprecated. 
  Allow subclasses to decide whether they are suitable for the given mime-type or not.

  Parameters:

  mime - mime-type string

  Returns:

  true if this engine is suitable for the given mime-type.

• register

  @Deprecated
  public static void register​(java.lang.String mime,
                              IndentEngine eng)

  Deprecated. IndentEngine now is a ServiceType

• indentEngines

  public static java.util.Enumeration<? extends IndentEngine> indentEngines​()

  Deprecated. 
  Returns enumeration of all registered indentation engines.

  Returns:

  enumeration of IndentEngine

• find

  public static IndentEngine find​(java.lang.String mime)

  Deprecated. 
  Finds engine associated with given mime type. If no engine is associated returns default one.

• find

  public static IndentEngine find​(javax.swing.text.Document doc)

  Deprecated. 
  Finds engine associated with given document. If no engine is associated returns default one.

• getDefault

  public static IndentEngine getDefault​()

  Deprecated. 
  Returns a simple indentation engine that does no formatting.