Package com.dassault_systemes.catjdialog

   
Class CATButton

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

Framework : CATJDialog

Module : CATJDialog

Class Description

public class CATButton

The button graphical component.

Description:

This is a labeled button.
The application can be notified when the button is pressed.

CATButton Properties:

CATButton Notifications:

CATButton Message Catalog Implicit Mappings:

Field Summary

Constructor Summary
CATButton(CATDialog iDialog, String iName)

Method Summary
CATNotification getButtonActivatedNotification()
boolean getEnable()
void setEnable(boolean iEnable)
String getTitle()
void setTitle(String iTitle)
String getTooltip()
void setTooltip(String iTooltip)


Field Detail

Constructor Detail

CATButton

    CATButton(CATDialog iDialog, String iName)

Creates a button with the specified parent and name.

Parameters:
iParent
The parent component.
iName
This button 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

getButtonActivatedNotification

    CATNotification getButtonActivatedNotification()

Returns the button activation notification.

This notification is sent when the button is pressed.

Returns:
The button activation notification.

getEnable

    boolean getEnable()

Determines whether this button is enabled or not.

Returns:
true if this button is enabled; false otherwise.

setEnable

    void setEnable(boolean iEnable)

Enables or disables this button.

A disabled button doesn't fire its ButtonActivated notification.

Parameters:
iEnable
If true, this button is enabled; otherwise it is disabled.

getTitle

    String getTitle()

Returns the button's title.

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

Returns:
This button's title.

setTitle

    void setTitle(String iTitle)

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

getTooltip

    String getTooltip()

Returns the button's tooltip.

Returns the programmatic value if setTooltip() has been called, or tries to retrieve its value from the associated message catalog file (<button_path>.Tooltip entry).

Returns:
This button tooltip.

setTooltip

    void setTooltip(String iTooltip)

Sets the button's tooltip.

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

Parameters:
iTooltip
The string that is to be this button's tooltip.


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