org.openide.windows
Class IOPosition

java.lang.Object
  org.openide.windows.IOPosition

public abstract class IOPosition
extends Object

Navigation (scrolling) in IO component.

Client usage:

  InputOutput io = ...;
  // store current position of IO
  IOPosition.Position pos = IOPosition.currentPosition(io);
  ...
  // scroll to stored position
  pos.scrollTo();
 

How to support IOPosition in own IOProvider implementation:

• InputOutput provided by IOProvider has to implement Lookup.Provider
• Extend IOPosition and implement its abstract methods
• Place instance of IOPosition to Lookup provided by InputOutput

Since:

1.16

Nested Class Summary

static interface

IOPosition.Position

Constructor Summary

IOPosition()

Method Summary

protected abstract IOPosition.Position	currentPosition() Gets current position in IO
static IOPosition.Position	currentPosition(InputOutput io) Gets current position (in number of chars) in IO
static boolean	isSupported(InputOutput io) Checks whether this feature is supported for provided IO

Methods inherited from class java.lang.Object

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

Constructor Detail

IOPosition

public IOPosition()

Method Detail

currentPosition

public static IOPosition.Position currentPosition(InputOutput io)

Gets current position (in number of chars) in IO

Parameters:

io - IO to operate on

Returns:

current position or null if not supported

isSupported

public static boolean isSupported(InputOutput io)

Checks whether this feature is supported for provided IO

Parameters:

io - IO to check on

Returns:

true if supported

currentPosition

protected abstract IOPosition.Position currentPosition()

Gets current position in IO

Returns:

current position