3.9.4 - Framed Panel - JdlFramedPanel

John W. Campbell

3.9.4.1 Introduction

Class, fields, constructor and methods:

3.9.4.2 Class Details

Package:

Jdl.JdlView;

Class name:

JdlFramedPanel

Class definition:

public class JdlFramedPanel

Extends:

JPanel

Implements:

none

Actions:

none

3.9.4.3 Accessible Fields

public final static int SOLID_FRAME

Frame type option: solid.

public final static int RAISED_FRAME

Frame type option: raised.

public final static int INSET_FRAME

Frame type option: inset.

public final static int ETCHED_OUT_FRAME

Frame type option: etched out.

public final static int ETCHED_IN_FRAME

Frame type option: etched in.

public final static int PREFERRED

Size Constraint: preferred size.

public final static int FREE

Size/Location Constraint: free.

static final long serialVersionUID

3.9.4.4 Constructors

3.9.4.4.1 Introduction

Constructor:

3.9.4.4.2 Default constructor

Constructor Definition:

public JdlFramedPanel ()

Parameters List:

none

3.9.4.4.3 Constructor 2

Constructor Definition:

public JdlFramedPanel (int w, int h)

Parameters List:

w

The required width in pixels (including frame).

h

The required height in pixels (including frame).

3.9.4.4.4 Constructor 3

Constructor Definition:

public JdlFramedPanel (int w, int h, Color fill, Color brdr, Color brdr_brighter, Color brdr_darker)

Parameters List:

w

The required width in pixels (including frame).

h

The required height in pixels (including frame).

fill

The fill colour for the panel. If null (the default), then the background colour will be used.

brdr

The border colour - sets the colour for a solid border.

brdr_brighter

A brighter colour for a three dimensional button border.

brdr_darker

A darker colour for a three dimensional button border.

3.9.4.5 Set/Get Framed Panel Resources

3.9.4.5.1 Introduction

Methods:

3.9.4.5.2 Set border colour - setBorderColor

Method Definition:

public void setBorderColor (Color colr)

Parameters List:

colr

The border colour - sets this colour for a solid border or lighter and darker shades of if for a three dimensional button border. If null (the default), use the background colour if a three dimensional button or the foreground colour if the button has a solid border.

3.9.4.5.3 Set border colour - setBorderColor

Method Definition:

public void setBorderColor (Color colr, Color brighter, Color darker)

Parameters List:

colr

The border colour - sets the colour for a solid border.

brighter

A brighter colour for a three dimensional button border.

darker

A darker colour for a three dimensional button border.

3.9.4.5.4 Get border colour - getBorderColor

Method Definition:

public Color getBorderColor()

Parameters List:

none

Method Return:

Returns the border colour resource as set.

3.9.4.5.5 Set border thickness - setBorderThickness

Method Definition:

public void setBorderThickness (int border)

Parameters List:

thickness

This is the required border thickness in pixels. (default = 4)

3.9.4.5.6 Get border thickness - getBorderThickness

Method Definition:

public int getBorderThickness()

Parameters List:

none

Method Return:

Returns the border thickness in pixels.

3.9.4.5.7 Set border type - setBorderType

Method Definition:

public void setBorderType (int type)

Parameters List:

type

Border type flag:
= 0, solid
= 1, raised
= 2, inset (the default)
= 3, etched out
= 4, etched in
(May use variables SOLID_FRAME, RAISED_FRAME, INSET_FRAME, ETCHED_OUT_FRAME, ETCHED_IN_FRAME).

3.9.4.5.8 Get border type - getBorderType

Method Definition:

public int getBorderType()

Parameters List:

none

Method Return:

Returns the current border type flag (see setBorderType(..) method for details).

3.9.4.5.9 Set fill colour - setFillColor

Method Definition:

public void setFillColor (Color fill_color)

Parameters List:

colr

The fill colour for the panel. If null (the default), then the background colour will be used.

3.9.4.5.10 Get fill colour - getFillColor

Method Definition:

public Color getFillColor()

Parameters List:

none

Method Return:

Returns the current value of the fill colour resource.

3.9.4.5.11 Set panel height - setPanelHeight

Method Definition:

public void setPanelHeight (int height)

Parameters List:

height

The required panel height in pixels.

3.9.4.5.12 Get panel height - getPanelHeight

Method Definition:

public int getPanelHeight()

Parameters List:

none

Method Return:

Returns the requested panel height in pixels.

3.9.4.5.13 Set panel width - setPanelWidth

Method Definition:

public void setPanelWidth (int width)

Parameters List:

width

The required panel width in pixels.

3.9.4.5.14 Get panel width - getPanelWidth

Method Definition:

public int getPanelWidth()

Parameters List:

none

Method Return:

Returns the requested panel width in pixels.

3.9.4.6 Framed Panel Drawer Methods

3.9.4.6.1 Introduction

Methods:

3.9.4.6.2 Set drawer - setDrawer

Method Definition:

public void setDrawer (JdlFramedPanelDrawer dr, int id)

Parameters List:

dr

A JdlFramedPanelDrawer interfaced object to carry out the drawing on the panel (default = null). Its jdl_framed_panel_drawer method is called from the paint routine after the border has been drawn and after a clip area within the border has been set. Note that the coordinate origin remains as that of the complete panel including the border.

id

Identifier to be passed to the drawing method when called.

3.9.4.6.3 Get drawer - getDrawer

Method Definition:

public JdlFramedPanelDrawer getDrawer()

Parameters List:

none

Method Return:

Returns the currently installed JdlFramedPanelDrawer object or null if none has been set up.

3.9.4.6.4 Get drawer ID - getDrawerId

Method Definition:

public int getDrawerId()

Parameters List:

none

Method Return:

Returns the identifier of the currently installed JdlFramedPanelDrawer object.

3.9.4.7 Standard Positioning and Sizing

3.9.4.7.1 Introduction

Methods:

3.9.4.7.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.9.4.7.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.9.4.8 Overriden Superclass Methods

3.9.4.8.1 Introduction

Methods:

3.9.4.8.2 Set background - setBackground

Method Definition:

public void setBackground (Color c)

Parameters List:

c

The color to become this object's background color.

3.9.4.8.3 Set foreground - setForeground

Method Definition:

public void setForeground (Color c)

Parameters List:

c

The color to become this object's foreground color.

3.9.4.8.4 Get minimum size - getMinimumSize

Method Definition:

public Dimension getMinimumSize()

Parameters List:

none

3.9.4.8.5 Get preferred size - getPreferredSize

Method Definition:

public Dimension getPreferredSize()

Parameters List:

none

3.9.4.8.6 Set size - setSize

Method Definition:

public void setSize(int w, int h)

Parameters List:

w

The required panel width in pixels.

h

The required panel height in pixels.