3.10.10 - Separator - JdlSeparator

John W. Campbell

3.10.10.1 Introduction

Class, fields, constructor and methods:

3.10.10.2 Class Details

Package:

Jdl.JdlView;

Class name:

JdlSeparator

Class definition:

public class JdlSeparator

Extends:

JPanel

Implements:

none

Actions:

none

3.10.10.3 Accessible Fields

public final static int SOLID_LINE

Separator type option: solid.

public final static int ETCHED_OUT

Separator type option: etched out.

public final static int ETCHED_IN

Separator type option: etched_in.

public final static int HORIZONTAL

Separator direction: horizontal.

public final static int VERTICAL

Separator direction: vertical.

static final long serialVersionUID

public final static int PREFERRED

Size Constraint: preferred size.

public final static int FREE

Size/Location Constraint: free.

3.10.10.4 Constructor

3.10.10.4.1 Introduction

Constructor:

3.10.10.4.2 Default constructor

Constructor Definition:

public JdlSeparator ()

Parameters List:

none

3.10.10.5 Resource Methods

3.10.10.5.1 Introduction

Methods:

3.10.10.5.2 Set length type - setFixedLength

Method Definition:

public void setFixedLength (boolean fixed)

Parameters List:

fixed

For fixed length set to true, for variable length set to false (the default).

3.10.10.5.3 Get length type - getFixedLength

Method Definition:

public boolean getFixedLength()

Parameters List:

none

Method Return:

Returns true for fixed length, false for varaible length separator.

3.10.10.5.4 Set orientation - setOrientation

Method Definition:

public void setOrientation (int orient)

Parameters List:

orient

Orientation flag:
= 0, horizontal (the default)
= 1, vertical
(May use the variables HORIZONTAL, VERTICAL)

3.10.10.5.5 Get orientation - getOrientation

Method Definition:

public int getOrientation()

Parameters List:

none

Method Return:

Returns the orientation flag:
= 0, horizontal
= 1, vertical

3.10.10.5.6 Set length - setSeparatorLength

Method Definition:

public void setSeparatorLength (int length)

Parameters List:

length

The required length of the separator (default = 20). If the length is variable, then this will be used as a minimum length.

3.10.10.5.7 Get length - getSeparatorLength

Method Definition:

public int getSeparatorLength()

Parameters List:

none

Method Return:

Returns the requested length of the separator.

3.10.10.5.8 Set thickness - setSeparatorThickness

Method Definition:

public void setSeparatorThickness (int separator)

Parameters List:

thickness

This is the required separator thickness in pixels. For three dimensional separators, an odd number will be rounded up to the next even number when used. (default = 4)

3.10.10.5.9 Get thickness - getSeparatorThickness

Method Definition:

public int getSeparatorThickness()

Parameters List:

none

Method Return:

Returns the separator thickness in pixels.

3.10.10.5.10 Set style - setSeparatorType

Method Definition:

public void setSeparatorType (int type)

Parameters List:

type

Separator type flag:
= 0, solid line
= 1, etched out
= 2, etched in (the default)
(May use the variables SOLID_LINE, ETCHED_OUT, ETCHED_IN)

3.10.10.5.11 Get style - getSeparatorType

Method Definition:

public int getSeparatorType()

Parameters List:

none

Method Return:

Returns the current separator type flag:
= 0, solid line
= 1, etched out
= 2, etched in

3.10.10.6 Standard Positioning and Sizing

3.10.10.6.1 Introduction

Methods:

3.10.10.6.2 Set position constraints - setLocationConstraints

Method Definition:

public void setLocationConstraints (int constraint_x, int constraint_y)

Parameters List:

constraint_x

Constrain the Jdl Object 'x' position = the required Jdl Object 'x' position (overrides setLocation method) or FREE if the 'x' position may be set by the setLocation method and hence possibly by the layout manager.

constraint_y

Constrain the Jdl Object 'y' position = the required the Jdl Object 'y'position (overrides setLocation method) or FREE if the 'y' position may be set by the setLocation method and hence possibly by the layout manager.

3.10.10.6.3 Set size constraints - setSizeConstraints

Method Definition:

public void setSizeConstraints (int constraint_w, int constraint_h)

Parameters List:

constraint_w

Constrain the Jdl Object width = the required Jdl Object width, or PREFERRED (default) if the width is to be calculated from the current resources, or FREE if the width may be resized to anything greater than the minimum width required.

constraint_h

Constrain the Jdl Object height = the required Jdl Object height, or PREFERRED (default) if the height is to be calculated from the current resources, or FREE if the height may be resized to anything greater than the minimum height required.

3.10.10.6.4 Set minimum height - setMinimumHeight

Method Definition:

public void setMinimumHeight(int minh)

Parameters List:

minh

The minimum height required for the object (ignored if less than that required by the minimum layout) (default = 0).

3.10.10.6.5 Set minimum width - setMinimumWidth

Method Definition:

public void setMinimumWidth(int minw)

Parameters List:

minh

The minimum width required for the object (ignored if less than that required by the minimum layout) (default = 0).

3.10.10.7 Overriden Superclass Methods

3.10.10.7.1 Introduction

Methods:

3.10.10.7.2 Set background - setBackground

Method Definition:

public void setBackground (Color c)

Parameters List:

c

The color to become this object's background color.

3.10.10.7.3 Set background colours - setBackground

Method Definition:

public void setBackground (Color c, Color brighter, Color darker)

Parameters List:

c

The background colour.

brighter

A brighter shade of the background colour.

darker

A darker shade of the background colour.

3.10.10.7.4 Set foreground - setForeground

Method Definition:

public void setForeground (Color c)

Parameters List:

c

The color to become this object's foreground color.

3.10.10.7.5 Get minimum size - getMinimumSize

Method Definition:

public Dimension getMinimumSize()

Parameters List:

none

3.10.10.7.6 Get preferred size - getPreferredSize

Method Definition:

public Dimension getPreferredSize()

Parameters List:

none