Package com.dassault_systemes.catjdialog

   
Class CATWizard

 
Class Hierarchy
java.lang.Object
  |
  +-com.dassault_systemes.catjdialog.CATCallbackSource
        |
        +-com.dassault_systemes.catjdialog.CATDialog
              |
              +-com.dassault_systemes.catjdialog.CATWizard
Class Location

Framework : CATJDialog

Module : CATJDialog

Class Description

public class CATWizard

The wizard graphical component.

Presentation:

This container is aimed at guiding the user through each step of a task.
It has a title, an image (that identifies the wizard), and 3 buttons (previous, next/finish, cancel) that allow navigating in the steps.
Each step page is a child component of the wizard, only one step (child) being displayed at a time.
The application can be notified when the user navigates in the wizard.

CATWizard Properties:

CATWizard Notifications:

CATWizard Message Catalog Implicit Mappings:

Field Summary

Constructor Summary
CATWizard(CATDialog iParent, String iName)

Method Summary
String getTitle()
void setTitle(String iTitle)
String getImage()
void setImage(String iImage)
String getPosition()
void setPosition(String iPosition)
void moveNext()
void movePrevious()
CATNotification getPreviousNotification()
CATNotification getNextNotification()
CATNotification getCancelNotification()


Field Detail

Constructor Detail

CATWizard

    CATWizard(CATDialog iParent, String iName)

Creates a wizard with the specified parent and name.

Parameters:
iParent
The parent component.
iName
This wizard name. Here are some rules for this name:
  • It is set in the constructor, and cannot be changed afterwards.
  • The name must be unique for the parent (2 children with the same name are not allowed).
  • The name may not contain any ot the following characters: '.' (dot), ' ' (blank), '_' (underscore)

Method Detail

getTitle

    String getTitle()

Returns the wizard's title.

Returns the programmatic value if setTitle() has been called, or tries to retrieve its title from the associated message catalog file (<wizard_path>.Title entry).

Returns:
This wizard's title.

setTitle

    void setTitle(String iTitle)

Sets the wizard's title.

Calling this method sets programmatically the title. This should be reserved for cases where the title can only be determined by dynamic means.
The standard way of defining components messages is using CATNls catalog files (supports NLS).

Parameters:
iTitle
The string that is to be this wizard's title.

getImage

    String getImage()

Returns the wizard image URI.

Returns:
The image URI.

setImage

    void setImage(String iImage)

Sets the wizard image URI. There is no default image.

Parameters:
iImage
An image URI. It can be either a relative path from the resources/graphic directory of the runtime view, or a full URL to an image resource. A null value unsets the wizard image.

getPosition

    String getPosition()

Returns the current displayed child name.

Returns:
The current displayed child name.

setPosition

    void setPosition(String iPosition)

Sets the current displayed child from its name.

Parameters:
iPosition
The child name to set as current step.

moveNext

    void moveNext()

Helper to move to next position (that is the next child component).


movePrevious

    void movePrevious()

Helper to move to previous position (that is the previous child component).


getPreviousNotification

    CATNotification getPreviousNotification()

Returns the previous button activated notification.

This notification is sent when the wizard previous button is pressed.

Returns:
The previous button activated notification.

getNextNotification

    CATNotification getNextNotification()

Returns the next button activated notification.

This notification is sent when the wizard next or finish button is pressed.

Returns:
The next button activated notification.

getCancelNotification

    CATNotification getCancelNotification()

Returns the cancel button activated notification.

This notification is sent when the wizard cancel button is pressed.

Returns:
The cancel button activated notification.


Copyright © 2000, Dassault Systèmes. All rights reserved