3.2.9 - JdlView Options - JdlViewOptions

John W. Campbell

3.2.9.1 Introduction

This class provides an object which may be used to pass non-default options to a JdlView object when it is constructed. Values for items to be overriden are set via the public fields though the first two or three may also be set using the available constructors.

Class, fields and constructors:

Class Details
Accessible Fields
Constructors

3.2.9.2 Class Details

Package:
Jdl.JdlView;
Class name:
JdlViewOptions
Class definition:
public class JdlViewOptions
Extends:
Object
Implements:
none
Actions:
none

3.2.9.3 Accessible Fields

The following accessible fields have been defined:

public boolean act_strip
If the JdlView object is being run under the control of the JdlViewManager object, then output (/do not output) an active strip (if the view object allows for such an option as is normally the case). Ignore if not under the control of the JdlViewManager object.
public int border
Border flag:
= 0, Output the view border if in view context, do not if not under the control of the JdlViewManager object
= 1, Suppress view border regardless of context
= 2, Add view border regardless of context
public boolean cancel_view
If the following flag is set to true, the the object is not to be treated as a managed JdlView object even if a JdlViewManager object has been created.
public int special_mode
Special mode flag The following flag may be set to a non-zero value to indicate that some special option is to be used by the view-object in its current situation. Any such options are view-object specific and their use will be indicated in the description of the JdlViewOptions parameter used in the view-object constructor.
public Font standard_font
Standard font.
public Font standard_bold_font
Standard bold font.
public Font standard_italic_font
Standard italic font.
public Font fixed_font
Fixed width font.
public Font fixed_bold_font
Fixed width bold font.
public Font fixed_italic_font
fFxed width italic font.
public Font fixed_font_small
Small fixed width font.
public Color bg
Background colour.
public Color bg_brighter
Background brighter colour. (If null and bg is explicitly specified then this colour will be calculated using the Color.brighter() method)
public Color bg_darker
Background darker colour. (If null and bg is explicitly specified then this colour will be calculated using the Color.darker() method)
public Color fg
Foreground colour.

3.2.9.4 Constructors

3.2.9.4.1 Introduction

Four constructors are available.

Constructor:

Default constructor
Constructor 2
Constructor 3
Constructor 4

3.2.9.4.2 Default constructor

Constructs a JdlViewOptions object with default fields.

Constructor Definition:
public JdlViewOptions()
Parameters List:
none

3.2.9.4.3 Constructor 2

Constructs a JdlViewOptions object with values set for the active strip and border flags.

Constructor Definition:
public JdlViewOptions(boolean act, int brdr)
Parameters List:
act
Active strip flag (see the public 'act_strip' field).
brdr
Border type flag (see the public 'border' field).

3.2.9.4.4 Constructor 3

Constructs a JdlViewOptions object with values set for the active strip, border and cancel view flags.

Constructor Definition:
public JdlViewOptions(boolean act, int brdr, boolean cancel)
Parameters List:
act
Active strip flag (see the public 'act_strip' field).
brdr
Border type flag (see the public 'border' field).
cancel
If true, cancel treatment as a view-object even if a JdlViewManager object has been created; = false, normal treatment.

3.2.9.4.5 Constructor 4

Constructs a JdlViewOptions object with values set for the active strip, border, cancel view and special mode flags.

Constructor Definition:
public JdlViewOptions(boolean act, int brdr, boolean cancel, int special_mode)
Parameters List:
act
Active strip flag (see the public 'act_strip' field).
brdr
Border type flag (see the public 'border' field).
cancel
If true, cancel treatment as a view-object even if a JdlViewManager object has been created; = false, normal treatment.
special_mode
Special mode flag (see also the public 'special_mode' field).

⇑ Up 3   ⇑ Up 2   ⇑ Up 1   ⇑ Top of this