RegionManager (Terminal Emulator) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.lib.terminalemulator 1.2

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.lib.terminalemulator
Class RegionManager

java.lang.Object
  org.netbeans.lib.terminalemulator.RegionManager

public class RegionManager
extends Object
extends Object

Constructor Summary

RegionManager()


Method Summary

ActiveRegion beginRegion(Coord begin)
          Creates a new active region.

void cancelRegion()
          Eliminate the current region.

void endRegion(Coord end)
          Declare the end of the current active region.

ActiveRegion findRegion(Coord acoord)


void reset()
          Eliminates all regions.

ActiveRegion root()
          Returns the always-present "root" ActiveRegion.

Methods inherited from class java.lang.Object

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

Constructor Summary
`RegionManager()`

Method Summary
`ActiveRegion`	`beginRegion(Coord begin)` Creates a new active region.
`void`	`cancelRegion()` Eliminate the current region.
`void`	`endRegion(Coord end)` Declare the end of the current active region.
`ActiveRegion`	`findRegion(Coord acoord)`
`void`	`reset()` Eliminates all regions.
`ActiveRegion`	`root()` Returns the always-present "root" ActiveRegion.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

RegionManager

public RegionManager()

Method Detail

reset

public void reset()

Eliminates all regions.

root

public ActiveRegion root()

Returns the always-present "root" ActiveRegion.

beginRegion

public ActiveRegion beginRegion(Coord begin)
                         throws RegionException

Creates a new active region.

Any text at and after 'begin' will belong to this region.

Active regions can be nested.

Throws:: RegionException

endRegion

public void endRegion(Coord end)
               throws RegionException

Declare the end of the current active region.

Any text before and at 'end' will belong to this region.

Throws:: RegionException

cancelRegion

public void cancelRegion()
                  throws RegionException

Eliminate the current region.

If cancelRegion is issued between a beginRegion and endRegion the region that was begun is cancelled as if beginregion was never called.

Throws:: RegionException

findRegion

public ActiveRegion findRegion(Coord acoord)