3.2.4 - JdlView Object Interface - JdlViewObject

John W. Campbell

3.2.4.1 Introduction

An interface for objects which can be used as JdlView objects with the JdlViewManager.

Interface and methods:

Class Details
Accessible Fields
The Interface Methods

3.2.4.2 Class Details

Package:
Jdl.JdlView;
Class name:
JdlViewObject
Class definition:
public interface JdlViewObject
Extends:
Object
Implements:
none
Actions:
none

3.2.4.3 Accessible Fields

No fields with public, package or protected access defined.

3.2.4.4 The Interface Methods

3.2.4.4.1 Introduction

This section details the methods which need to be implemented for a JdlViewObject implementing object.

Methods:

Set active state - setViewActive
Set keyboard focus - setViewFocus
Set active strop message - setViewActiveMessage
Get required sizes - getViewSizes
Get base frame title - getBaseFrameTitle
Set horizontal justification - setViewHjust
Get horizontal justification - getViewHjust
Set vertical justification - setViewVjust
Get vertical justification - getViewVjust
Set position and size - setViewObjectLayout
Tidy up - tidyUp

3.2.4.4.2 Set active state - setViewActive

A method to set the active/inactive state.

Method Definition:
public void setViewActive (boolean act, ActionListener actlis)
Parameters List:
act
Set to true or false if object is to receive input.
actlis
The action listener to receive the action commands.

3.2.4.4.3 Set keyboard focus - setViewFocus

A method to request the keyboard focus for the object.

Method Definition:
public void setViewFocus()
Parameters List:
none

3.2.4.4.4 Set active strop message - setViewActiveMessage

A method to set the active strip message.

Method Definition:
public void setViewActiveMessage(String msg)
Parameters List:
msg
The message to be set.

3.2.4.4.5 Get required sizes - getViewSizes

A method to return the required sizes for the JdlView object.

Method Definition:
public JdlRequiredSizes getViewSizes()
Parameters List:
none

3.2.4.4.6 Get base frame title - getBaseFrameTitle

A method to return a title for an internally generated base frame used by the JdlViewManager object

Method Definition:
public String getBaseFrameTitle()
Parameters List:
none

3.2.4.4.7 Set horizontal justification - setViewHjust

This method sets the requested horizontal justification for the object from the JdlViewManager layout methods.

Method Definition:
public void setViewHjust (int i)
Parameters List:
i
Horizontal justification requested:
= 0, expand
= 1, left justify
= 2, right justify
= 3, centre

3.2.4.4.8 Get horizontal justification - getViewHjust

This method gets the horizontal justification for the object. Normally the value returned will be that requested via the setViewHjust(..) method. If expand was requested but is not supported by the JdlView object then an alternative justification (normally 'centre') will be returned.

Method Definition:
public int getViewHjust()
Parameters List:
none
Method Return:
The horizontal justification type to use in the layout (values as for the setViewHjust(..) method parameter 'i'.

3.2.4.4.9 Set vertical justification - setViewVjust

This method sets the requested vertical justification for the object from the JdlViewManager layout methods.

Method Definition:
public void setViewVjust (int i)
Parameters List:
i
Vertical justification requested:
= 0, expand
= 1, top justify
= 2, bottom justify
= 3, centre

3.2.4.4.10 Get vertical justification - getViewVjust

This method gets the vertical justification for the object. Normally the value returned will be that requested via the setViewVjust(..) method. If expand was requested but is not supported by the JdlView object then an alternative justification (normally 'centre') will be returned.

Method Definition:
public int getViewVjust()
Parameters List:
none
Method Return:
The Vertical justification type to use in the layout (values as for the setViewHjust(..) method parameter 'i'.

3.2.4.4.11 Set position and size - setViewObjectLayout

This method passes the position and size parameters as determined by the JdlViewManager layout methods to the JdlView object. Normally the method will set the location constraints and minimum width and height parameters for the object.

Method Definition:
public void setViewObjectLayout (int x, int y, int w, int h)
Parameters List:
none

3.2.4.4.12 Tidy up - tidyUp

This method is called prior to removing/deleting a view-object to enable any tidying up to be done (e.g. stopping threads).

Method Definition:
public void tidyUp()
Parameters List:
none

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