gzz.view
Interface ViewContext

All Known Implementing Classes:

AbstractViewContext, Fallback.Win, ZZViewContext

public interface ViewContext

An object providing context information to a view, e.g. the current cursor position. This interface is an abstraction over the normal and Fallback clients, allowing context information to be read from the ZZ structure (normal client) or from some Java object (fallback).

There is one method for getting the window's maincell, which is not available in the Fallback client (because fallback windows are not in the structure). This method is allowed to throw UnsupportedOperationException if there is no such cell.

See Also:

Fallback

Field Summary

static java.lang.String

rcsid

Method Summary

Cell	getAccursed() Get the accursed cell.
CellView	getCellView()
java.util.List	getCursorColors(Cell c) Get the colors of all colored cursors on a cell.
int	getCursorOffset(Cell c) Get the offset of the line cursor on a given cell, if any.
Dim[]	getDims() Get the dimension list.
View	getView()
Cell	getWindow() Get the maincell of the window, if available.
boolean	isMarked(Cell c) Whether a given cell is marked by the current mark set.

Field Detail

rcsid

public static final java.lang.String rcsid

See Also:

Constant Field Values

Method Detail

getAccursed

public Cell getAccursed()

Get the accursed cell.

getCursorColors

public java.util.List getCursorColors(Cell c)

Get the colors of all colored cursors on a cell. Return null if there are no colored cursors on this cell.

getDims

public Dim[] getDims()

Get the dimension list.

getCursorOffset

public int getCursorOffset(Cell c)

Get the offset of the line cursor on a given cell, if any. If no line cursor should be rendered on the given cell, return -1.

isMarked

public boolean isMarked(Cell c)

Whether a given cell is marked by the current mark set.

getView

public View getView()

getCellView

public CellView getCellView()

getWindow

public Cell getWindow()
               throws java.lang.UnsupportedOperationException

Get the maincell of the window, if available. This cell can be used to acquire more metadata about how to render the view. If there is no maincell for the window (because we're running in fallback mode), an UnsupportedOperationException is thrown.

java.lang.UnsupportedOperationException