Package com.dassault_systemes.catjdialog

   
Class CATDialogFrame

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

Framework : CATJDialog

Module : CATJDialog

Class Description

public class CATDialogFrame

The dialog frame graphical component.

Description:

This is a top-level container that: The application can be notified when any of the toolbar buttons is pressed.
This container supports only one child component, that is the content it will display.

CATDialogFrame Properties:

CATDialogFrame Notifications:

CATDialogFrame Message Catalog Implicit Mappings:

   All Implemented Interfaces:
CATIContainerDialog
CATIToolbarHolder
CATIFocalContentHolder
Field Summary

Constructor Summary
CATDialogFrame(CATDialog iParent, String iName)

Method Summary
String getTitle()
void setTitle(String iTitle)
CATDialog getContent()
CATFrame getFocalArea()
void setToolbarModelURL(String iModelURL)
String getToolbarModelURL()
void setToolbar(CATMenuModel iModel)
CATMenuModel getToolbar()
CATToolbarCommandNotification getToolbarNotification()


Field Detail

Constructor Detail

CATDialogFrame

    CATDialogFrame(CATDialog iParent, String iName)

Creates a dialog frame with the specified parent and name.

Parameters:
iParent
The parent component.
iName
This dialog frame 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 dialog frame's title.

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

Returns:
This dialog frame's title.

setTitle

    void setTitle(String iTitle)

Sets the dialog frame'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 dialog frame's title.

getContent

    CATDialog getContent()

Returns the child component that is the content of the dialog box.

Returns:
The top content component.
See Also:
CATIContainerDialog#getContent()

getFocalArea

    CATFrame getFocalArea()


setToolbarModelURL

    void setToolbarModelURL(String iModelURL)

Sets the toolbar model URL.

The expected format is: <model classname>@<arg1>,<arg2>,...
<model classname> must have a constructor with the following signature:
    void <Constructor>(CATDialog iDialog, String[] iArgs)

Note: This method allows to set the toolbar model inline in the XMLDlg file.
Example: <DialogFrame Name="Top" ToolbarModelURL="com.mypackage.MyToolbarModel@myarg"...

Parameters:
iModelURL
A toolbar model URL. A null value unsets the toolbar.

getToolbarModelURL

    String getToolbarModelURL()

Returns the toolbar model URL (if any).

Returns:
The current toolbar model URL. null if no toolbar URL.

setToolbar

    void setToolbar(CATMenuModel iModel)

Sets the toolbar model object.

Parameters:
iModel
A toolbar model object (null value unsets the toolbar).

getToolbar

    CATMenuModel getToolbar()

Returns the toolbar model (if any).

Returns:
The current toolbar model object. null if not toolbar.
See Also:
com.dassault_systemes.catjdialog.CATIToolbarHolder#getToolbar()

getToolbarNotification

    CATToolbarCommandNotification getToolbarNotification()

Returns the toolbar activation notification.

This notification is sent when an enabled toolbar button is pressed.

Returns:
The toolbar activation notification.
See Also:
com.dassault_systemes.catjdialog.CATIToolbarHolder#getToolbarNotification()


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