se.entra.phantom.common

Interface FieldPaintInterface

All Superinterfaces:

PaintInterface

All Known Implementing Classes:

TerminalFieldPainter

public interface FieldPaintInterface
extends PaintInterface

Author:

Mikael Andersson

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FieldPaintInterface.Field Generic field description.
static class	FieldPaintInterface.Fields

Method Summary

Modifier and Type	Method and Description
FieldPaintInterface.Fields	getFields(boolean inputOnly) Gets all host fields defined in the current screen.
boolean	getFieldsActive() Get the state of host painting flag.
Object	getHostScreen() Get the current hostScreen.
FieldPaintInterface.Field	probe(int position) Check if the position is part of a defined field.
void	repaintWindow() Mark the terminal window to be repainted.
void	selectPopup(int index) Set the pop-up to be shown.
void	setComponent(Component component) Set the component.
void	setDimensions(int cxFont, int cyFont, int xOffset, int yOffset) Set the dimensions of the component.
void	setFieldsActive(boolean active) Set the field painting active (or inactive - depending on parameter).
void	setPopupConstrained(boolean active) Set the handling of popups as constraining (or inactive - depending on parameter).
void	setPopupsActive(boolean active) Set the popup painting active (or inactive - depending on parameter).
void	showPopup(int index) Set the pop-up to be shown.

Methods inherited from interface se.entra.phantom.common.PaintInterface

paint

Method Detail

getFields

FieldPaintInterface.Fields getFields(boolean inputOnly)

Gets all host fields defined in the current screen.

Returns:

Fields - null if not defined.

getHostScreen

Object getHostScreen()

Get the current hostScreen.

Returns:

HostScreen

repaintWindow

void repaintWindow()

Mark the terminal window to be repainted.

showPopup

void showPopup(int index)

Set the pop-up to be shown.

Parameters:

index - The index of the pop-up.

selectPopup

void selectPopup(int index)

Set the pop-up to be shown.

Parameters:

index - The index of the pop-up.

setFieldsActive

void setFieldsActive(boolean active)

Set the field painting active (or inactive - depending on parameter).

Parameters:

active - The active state.

getFieldsActive

boolean getFieldsActive()

Get the state of host painting flag.

Returns:

Checks fields mode is active.

setPopupsActive

void setPopupsActive(boolean active)

Set the popup painting active (or inactive - depending on parameter).

Parameters:

active - The active state.

setPopupConstrained

void setPopupConstrained(boolean active)

Set the handling of popups as constraining (or inactive - depending on parameter).

Parameters:

active - The active state.

setComponent

void setComponent(Component component)

Set the component.

Parameters:

component - The component to use.

setDimensions

void setDimensions(int cxFont,
                   int cyFont,
                   int xOffset,
                   int yOffset)

Set the dimensions of the component.

Parameters:

cxFont - horizontal font size

cyFont - vertical font size

xOffset - horizontal offset

yOffset - vertical offset

probe

FieldPaintInterface.Field probe(int position)

Check if the position is part of a defined field.

Parameters:

position -

Returns:

Field - the generic field description.