DesignForm Class

DesignForm Class

This Package | All Packages 

Form
  |
  +--DesignForm
public class DesignForm
extends Form

Implements a DesignForm object. A DesignForm extends wfc.ui.Form and shows a tabbed view of available design pages. Design pages are objects that implement IDesignPage. DesignPage is a stock implementation of a design page.

Constructors
Name Description
DesignForm(Object [] ObjectList) Creates a new DesignForm object.

Methods
Name Description
getPage(int index) Returns the requested design page.
getPageCount() Returns the number of design pages on this form.
preProcessMessage(MSG msg) This method is called by the application's message loop to preprocess input messages before they are dispatched.
showForm() Displays the design form.
showForm(int page) Displays the design form.
showForm(Form owner) Displays the design form.
showForm(Form owner, int page) Displays the design form.

Constructors

DesignForm.DesignForm

Syntax
public DesignForm( Object [] ObjectList );
Parameters
ObjectList
A list of objects for which the design form should show properties. The design form finds the common DesignPages for all the objects.
Description

Creates a new DesignForm object.

Methods

DesignForm.getPage

Syntax
public IDesignPage getPage( int index );
Parameters
Index
The index of the page to return.
Return Value

Returns an IDesignPage interface for the page.

Description

Returns the requested design page.

DesignForm.getPageCount

Syntax
public int getPageCount();
Return Value

Returns the number of design pages.

Description

Returns the number of design pages on this form.

DesignForm.preProcessMessage

Syntax
public boolean preProcessMessage( MSG msg );
Description

This method is called by the application's message loop to preprocess input messages before they are dispatched. This method forwards IDesignPage messages as necessary.

DesignForm.showForm

Syntax 1
public int showForm();
Return Value

Returns the dialog return code.

Description

Displays the design form. The form has no owner window.



Syntax 2
public int showForm( int page );
Parameters
Page
The index of the page to display.
Return Value

Returns the dialog return code.

Description

Displays the design form. The form has no owner window.



Syntax 3
public int showForm( Form owner );
Parameters
Owner
The form that owns the form to be displayed.
Return Value

Returns the dialog return code.

Description

Displays the design form.



Syntax 4
public int showForm( Form owner, int page );
Parameters
Owner
The form that owns the form to be displayed.
Page
Index of the page to display.
Return Value

Returns the dialog return code.

Description

Displays the design form.