cli

Class OutputDevice.ScreenInfo

java.lang.Object

cli.NativeObject

cli.OutputDevice.ScreenInfo

Enclosing class:

OutputDevice

public static final class OutputDevice.ScreenInfo
extends NativeObject

Screen information.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_HEIGHT Default height constant.
static int	DEFAULT_WIDTH Default width constant.
static int	UNKNOWN Unknown value constant for either width or height.

Constructor Summary

Constructors

Modifier	Constructor and Description
	ScreenInfo(int I_Width, int I_Height, boolean B_TrueCls, boolean B_WrapLines) Constructor.
protected	ScreenInfo(long I64_NativeScreenInfoRef) Constructor for createFromNative().

Method Summary

Modifier and Type	Method and Description
void	copy(OutputDevice.ScreenInfo CLI_ScreenInfo) Assignment method.
protected static void	createFromNative(long I64_NativeScreenInfoRef) Creation from native code.
boolean	getbTrueCls() True cleanScreen() characteristic accessor.
boolean	getbWrapLines() Lines wrapping characteristic accessor.
int	getHeight() Screen height accessor.
int	getSafeHeight() Safe screen height accessor.
int	getSafeWidth() Safe screen width accessor.
int	getWidth() Screen width accessor.

Methods inherited from class cli.NativeObject

createdFromNative, dontFinalize, finalize, forget, getbDoFinalize, getNativeRef, getObject, remember

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN

public static final int UNKNOWN

Unknown value constant for either width or height.

See Also:

Constant Field Values

DEFAULT_WIDTH

public static final int DEFAULT_WIDTH

Default width constant.

See Also:

Constant Field Values

DEFAULT_HEIGHT

public static final int DEFAULT_HEIGHT

Default height constant.

See Also:

Constant Field Values

Constructor Detail

ScreenInfo

public ScreenInfo(int I_Width,
                  int I_Height,
                  boolean B_TrueCls,
                  boolean B_WrapLines)

Constructor.

Parameters:

I_Width - Width of screen. Can be UNKNOWN.

I_Height - Height of screen. Can be UNKNOWN.

B_TrueCls - True when an efficient CleanScreen() operation is implemented.

B_WrapLines - True when the line automatically goes down when the cursor reached the right end of the screen.

ScreenInfo

protected ScreenInfo(long I64_NativeScreenInfoRef)

Constructor for createFromNative().

Parameters:

I64_NativeScreenInfoRef - Native instance reference.

Method Detail

createFromNative

protected static void createFromNative(long I64_NativeScreenInfoRef)

Creation from native code. Useful for help members of other classes.

Parameters:

I64_NativeScreenInfoRef - Native instance reference.

copy

public void copy(OutputDevice.ScreenInfo CLI_ScreenInfo)

Assignment method.

Parameters:

CLI_ScreenInfo - Screen info object to copy.

getWidth

public int getWidth()

Screen width accessor.

Returns:

Screen width if known, UNKNOWN otherwise.

getSafeWidth

public int getSafeWidth()

Safe screen width accessor.

Returns:

Screen width if known, default value otherwise.

getHeight

public int getHeight()

Screen height accessor.

Returns:

Screen height if known, UNKNOWN otherwise.

getSafeHeight

public int getSafeHeight()

Safe screen height accessor.

Returns:

Screen height if known, default value otherwise.

getbTrueCls

public boolean getbTrueCls()

True cleanScreen() characteristic accessor.

Returns:

True cleanScreen() characteristic.

getbWrapLines

public boolean getbWrapLines()

Lines wrapping characteristic accessor.

Returns:

True when the line automatically goes down when the cursor reached the right end of the screen.