org.netbeans.api.editor.guards

Interface DocumentGuards

public interface DocumentGuards

Allows to inspect document's inaccessible areas.

Method Summary

Modifier and Type	Method and Description
int	adjustPosition(int position, boolean direction) Adjust a position to point outside the guarded area.
int	findNextBlock(int position, boolean direction) Finds boundary of the nearest guarded block, starting from the position.
boolean	isPositionGuarded(int position, boolean forInsertion) Checks whether the particular position is protected.

Method Detail

isPositionGuarded

boolean isPositionGuarded(int position,
                          boolean forInsertion)

Checks whether the particular position is protected.

Parameters:

forInsertion -

Returns:

adjustPosition

int adjustPosition(int position,
                   boolean direction)

Adjust a position to point outside the guarded area.

Parameters:

position - offset in the document

direction - true for end of the guarded block, false for the beginning

Returns:

findNextBlock

int findNextBlock(int position,
                  boolean direction)

Finds boundary of the nearest guarded block, starting from the position. Returns -1, if there is no guarded block in the specified direction.

Parameters:

position - the position to start at

direction - true forward, false backward

Returns:

boundary offset of the nearest guarded block or -1