org.netbeans.spi.editor.bracesmatching

Class BraceContext

java.lang.Object

org.netbeans.spi.editor.bracesmatching.BraceContext

public final class BraceContext
extends Object

Provides context information for a single brace. The brace may be preceded or followed by a semantically connected text, such as `if' statement or `while' statement in a do-while loop in Java. Such text may be displayed as a context for the brace highlight. The marked text should include the brace sign itself.

It may be necessary to provide a completely unrelated context, such is in the example of if-else statement. The 'else' does not provide enough information itself as it is just a negation of earlier condition. Such related piece of text can be reported as 'related' BraceContext instance. Note that related instances may be chained - see the example below.

The infrastructure uses the provided information to present the context to the user. If a 'related' positions are present the infrastructure will attempt to present the source on the 'context' and 'related' positions in the source text order (e.g. displays portion of the document); contents between 'context' and 'related' positions may be suppressed.

An example of context and related areas for Java (PHP) if-elseif-else, with the origin t

  //  vvvvvvvvvvvvvvvvv -- related
      if (condition1) {
  //  vvvvvvvvvvvvvvvvvvvvvvvvvvv -- related
      } else if (elsecondition) {
      ...
      } else {
  //    ^^^^^^ -- context
      ...
      }
 //   ^ -- origin/caret location
 

Method Summary

Modifier and Type	Method and Description
static BraceContext	create(Position start, Position end) Creates a new context area for the brace.
BraceContext	createRelated(Position start, Position end) Creates a new BraceContext related to this one.
Position	getEnd()
BraceContext	getRelated()
Position	getStart()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getStart

public Position getStart()

Returns:

Starting position of the context text content

getEnd

public Position getEnd()

Returns:

Ending position of the context text content

getRelated

public BraceContext getRelated()

Returns:

the related range, or null for none.

createRelated

public BraceContext createRelated(Position start,
                                  Position end)

Creates a new BraceContext related to this one.

Parameters:

start - start of the contextual text

end - end of the text

Returns:

the new instance of BraceContext

create

public static BraceContext create(Position start,
                                  Position end)

Creates a new context area for the brace.

Parameters:

start - start of the text

end - end of the text

Returns:

a new instance of BraceContext