3.10.4 - Button - JdlButton

John W. Campbell

3.10.4.1 Introduction

Class, fields, constructor and methods:

3.10.4.2 Class Details

Package:

Jdl.JdlView;

Class name:

JdlButton

Class definition:

public class JdlButton

Extends:

JPanel

Implements:

MouseListener
FocusListener
KeyListener

Actions:

An action event will be generated when the button is pressed. The associated action command string is "button pressed".

3.10.4.3 Accessible Fields

public final static int SOLID

Border type option: Solid.

public final static int INOUT

Border type option: Three dimensional (raised/inset).

public final static int CENTER

Label alignment: centred.

public final static int LEFT

Label alignment: left justified.

public final static int RIGHT

Label alignment: right justified.

public final static int STRING_SIZE

Size Constraint: string size (preferred size), (width or height) (Note same as the standard PREFERRED flag).

public final static int DEFAULT_BUTTON_BORDER

Default button border.

public final static int DEFAULT_BUTTON_SURROUND_HEIGHT

Default button surround height.

public final static int DEFAULT_BUTTON_SURROUND_WIDTH

Default button surround width.

static final long serialVersionUID

public final static int PREFERRED

Size Constraint: preferred size.

public final static int FREE

Size/Location Constraint: free.

3.10.4.4 Constructors

3.10.4.4.1 Introduction

Constructors:

3.10.4.4.2 Default constructor

Constructor Definition:

public JdlButton()

Parameters List:

none

3.10.4.4.3 Constructor 2

Constructor Definition:

public JdlButton(String str)

Parameters List:

string

The label string.

3.10.4.5 Class Methods

3.10.4.5.1 Introduction

Methods:

3.10.4.5.2 Find start size - findStartSize

Method Definition:

public static Dimension findStartSize (String str, Font font, Font fonth)

Parameters List:

str

Button string.

font

Button font.

fonth

Button highlight font (if null then Button font will be used).

Method Return:

The calculated size (width, height)

3.10.4.5.3 Find start size - findStartSize

Method Definition:

public static Dimension findStartSize (int w, int h)

Parameters List:

w

Pre-calculated string width.

h

Pre-calculated string height.

Method Return:

The calculated size (width, height).

3.10.4.5.4 Find start size - findStartSize

Method Definition:

public static Dimension findStartSize (int w, int h, int brdr, int surround_w, int surround_h)

Parameters List:

w

Pre-calculated string width.

h

Pre-calculated string height.

brdr

Border width.

surround_w

The surround width (must be at least 1).

surround_h

The surround height (must be at least 1).

Method Return:

The calculated size (width, height)

3.10.4.6 Resource Methods

3.10.4.6.1 Introduction

Methods:

3.10.4.6.2 Set button border - setButtonBorder

Method Definition:

public void setButtonBorder(int thickness)

Parameters List:

thickness

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

3.10.4.6.3 Get button border - getButtonBorder

Method Definition:

public int getButtonBorder()

Parameters List:

none

Method Return:

Returns the arrow border thickness in pixels.

3.10.4.6.4 Set border type - setBorderType

Method Definition:

public void setBorderType (int type)

Parameters List:

type

Border type flag:
= 0, solid
= 1, in/out (3-dimensional) (the default)
(May use variables SOLID, INOUT)

3.10.4.6.5 This method returns the border type resource. - getBorderType

Method Definition:

public int getBorderType()

Parameters List:

none

Method Return:

Returns the current border type flag:
= 0, solid
= 1, in/out (3-dimensional)

3.10.4.6.6 Set button drawer - setDrawer

Method Definition:

public void setDrawer (JdlButtonDrawer dr, int id)

Parameters List:

dr

A JdlButtonDrawer interfaced object to carry out the drawing on the button (default = null). Its jdl_button_drawer method is called from the paint routine after the border has been drawn. The parameters include details of the button size and state. Unless suppressed the label string (if defined) will be drawn on the button after the drawing routine has been invoked,

id

Identifier to be passed to the drawing method when called.

3.10.4.6.7 Get button drawer - getDrawer

Method Definition:

public JdlButtonDrawer getDrawer()

Parameters List:

none

Method Return:

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

3.10.4.6.8 Get drawer identifier - getDrawerId

Method Definition:

public int getDrawerId()

Parameters List:

none

Method Return:

Returns the identifier of the currently installed JdlButtonDrawer object.

3.10.4.6.9 Set button disable - setDisable

Method Definition:

public void setDisable(boolean flag)

Parameters List:

flag

Set the flag to true to disable the button or false (the default) for normal button operation.

3.10.4.6.10 Get button disable - getDisable

Method Definition:

public boolean getDisable()

Parameters List:

none

Method Return:

Returns a flag =true if the button is disabled or false if the button is in its normal mode of operation.

3.10.4.6.11 Set 'in' fill colour - setFillColorIn

Method Definition:

public void setFillColorIn (Color colr)

Parameters List:

colr

The fill colour when the button is in the inset (pressed) state. If null (the default), then the 'button out' fill colour will be used.

3.10.4.6.12 Get 'in' fill colour - getFillColorIn

Method Definition:

public Color getFillColorIn()

Parameters List:

none

Method Return:

Returns the current value of the 'button in' fill colour resource.

3.10.4.6.13 Set 'out' fill colour - setFillColorOut

Method Definition:

public void setFillColorOut (Color colr)

Parameters List:

colr

The fill colour when the button is in the raise (unpressed) state. If null (the default), then the background colour will be used.

3.10.4.6.14 Get 'out' fill colour - getFillColorOut

Method Definition:

public Color getFillColorOut()

Parameters List:

none

Method Return:

Returns the current value of the 'button out' fill colour resource.

3.10.4.6.15 Set string width - setInputStringWidth

Method Definition:

public void setInputStringWidth (int width)

Parameters List:

string_width

The pre-calculated string width (default =0, ignore).

3.10.4.6.16 Set label alignment - setLabelAlignment

Method Definition:

public void setLabelAlignment (int align)

Parameters List:

align

A flag indicating the required label alignment:
= 0, to centre
= 1, for left justification
= 2, for right justification
(May use the variables CENTER, LEFT, RIGHT)

3.10.4.6.17 This method returns the label alignment resource. - getLabelAlignment

Method Definition:

public int getLabelAlignment()

Parameters List:

none

Method Return:

Returns the label alignment flag:
= 0, centre
= 1, left justification
= 2, right justification

3.10.4.6.18 Set label font - setLabelFont

Method Definition:

public void setLabelFont (Font font)

Parameters List:

font

The font for a button label.

3.10.4.6.19 Get label font - getLabelFont

Method Definition:

public Font getLabelFont()

Parameters List:

none

Method Return:

Returns the label font.

3.10.4.6.20 Set highlight font - setLabelHighlightFont

Method Definition:

public void setLabelHighlightFont (Font font)

Parameters List:

font

The font for a button label (default of null = do not change font when pointer is in button window).

3.10.4.6.21 Get highlight font - getLabelHighlightFont

Method Definition:

public Font getLabelHighlightFont()

Parameters List:

none

Method Return:

Returns the label highlight font.

3.10.4.6.22 Set label string - setLabelString

Method Definition:

public void setLabelString(String str)

Parameters List:

str

The label string (default = null).

3.10.4.6.23 Get label string - getLabelString

Method Definition:

public String getLabelString()

Parameters List:

none

Method Return:

Returns the label string.

3.10.4.6.24 Set suppress label - setSuppressLabel

Method Definition:

public void setSuppressLabel (boolean flag)

Parameters List:

flag

Set this flag to true if the label output is to be suppressed or false if it is to be shown (the default). Note that the label is drawn after any drawer routine has been invoked unless suppressed by this flag.

3.10.4.6.25 Get suppress label - getSuppressLabel

Method Definition:

public boolean getSuppressLabel()

Parameters List:

none

Method Return:

Returns the value of the suppress label resource.

3.10.4.6.26 Set surround height - setSurroundHeight

Method Definition:

public void setSurroundHeight(int minh)

Parameters List:

minh

The minimum height required between the button border and the top and bottom of the label text (default = 2) - must be at least 1 to allow for focus indication.

3.10.4.6.27 Get surround height - getSurroundHeight

Method Definition:

public int getSurroundHeight()

Parameters List:

none

Method Return:

Returns the surround height.

3.10.4.6.28 Set surround width - setSurroundWidth

Method Definition:

public void setSurroundWidth(int minw)

Parameters List:

minw

The minimum width required between the button border and the left and right of the label text (default = 4) - must be at least 1 to allow for focus indication.

3.10.4.6.29 Get surround width - getSurroundWidth

Method Definition:

public int getSurroundWidth()

Parameters List:

none

Method Return:

Returns the surround height.

3.10.4.6.30 Set focus option - setUseFocus

Method Definition:

public void setUseFocus(boolean on)

Parameters List:

on

If on is true, display a dotted border around the button text area when the button has the keyboard focus and respond to a Carriage Return or Enter key press as for a button press (default). If false, do not indicate focus or respond to a Carriage Return or Enter key press.

3.10.4.7 Standard Positioning and Sizing

3.10.4.7.1 Introduction

Methods:

3.10.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.10.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.10.4.7.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.4.7.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.4.8 Add/Remove Action Listener

3.10.4.8.1 Introduction

Methods:

3.10.4.8.2 Add action listener - addActionListener

Method Definition:

public void addActionListener(ActionListener listener)

Parameters List:

listener

The action listener to be added.

3.10.4.8.3 Remove action listener - removeActionListener

Method Definition:

public void removeActionListener(ActionListener listener)

Parameters List:

listener

The action listener to be removed.

3.10.4.9 Overriden Superclass Methods

3.10.4.9.1 Introduction

Methods:

3.10.4.9.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.4.9.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.4.9.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.4.9.5 Get minimum size - getMinimumSize

Method Definition:

public Dimension getMinimumSize()

Parameters List:

none

3.10.4.9.6 Get preferred size - getPreferredSize

Method Definition:

public Dimension getPreferredSize()

Parameters List:

none