|
|
|||||
| Package com.dassault_systemes.catjdialog |
Class CATDialogBox
|
| Class Hierarchy |
java.lang.Object
|
+-com.dassault_systemes.catjdialog.CATCallbackSource
|
+-com.dassault_systemes.catjdialog.CATDialog
|
+-com.dassault_systemes.catjdialog.CATDialogFrame
|
+-com.dassault_systemes.catjdialog.CATDialogBox
| Class Location |
| Class Description |
public class CATDialogBox
The dialog box graphical component.
<dialobbox_path>.Title entry.
You may also set it programmatically using setTitle().
All Implemented Interfaces: CATIDefaultButton CATICmdButtons
| Field Summary |
| public static final int | APPLY_BUTTON
Button: APPLY |
| public static final int | CANCEL_BUTTON
Button: CANCEL |
| public static final int | CLOSE
Style: Close button |
| public static final int | CLOSE_BUTTON
Button: CLOSE |
| public static final int | NONE
Style: No button |
| public static final int | OK_BUTTON
Button: OK |
| public static final int | OKCANCEL
Style: Ok/Cancel buttons |
| public static final int | OKCANCELAPPLY
Style: Ok/Apply/Cancel buttons |
| Constructor Summary |
| CATDialogBox(CATDialog iParent, String iName)
Creates a dialog box with the specified parent and name. |
| Method Summary |
| public boolean | getAPPLYEnable()
Determines whether if the APPLY button is enabled. |
| public CATNotification | getAPPLYNotification()
Notification for the Apply button |
| public String | getAPPLYTitle()
Returns the APPLY button label. |
| public CATDialog | getButtons()
Returns the buttons container component. |
| public boolean | getCANCELEnable()
Determines whether if the CANCEL button is enabled. |
| public CATNotification | getCANCELNotification()
Notification for the Cancel button |
| public String | getCANCELTitle()
Returns the CANCEL button label. |
| public CATNotification | getCLOSENotification()
Notification for the Close button |
| public String | getCLOSETitle()
Returns the CLOSE button label. |
| public CATDialog | getCmdButtons()
Returns the buttons container component. |
| public CATDialog | getContent()
Returns the child component that is the content of the dialog box. |
| public CATButton | getDefaultButton()
Retrieves the default button in the DialogBox (may be null). |
| public boolean | getOKEnable()
Determines whether if the OK button is enabled. |
| public CATNotification | getOKNotification()
Notification for the OK button. |
| public String | getOKTitle()
Returns the OK button label. |
| public boolean | getPacked()
Determines whether this dialog box is packed to its minimum size or not. |
| public int | getStyle()
Returns the dialog box current style. |
| public void | setAPPLYEnable(boolean iEnable)
Enables/disables the APPLY button. |
| public void | setAPPLYTitle(String iTitle)
Sets the APPLY button label. |
| public void | setCANCELEnable(boolean iEnable)
Enables/disables the CANCEL button. |
| public void | setCANCELTitle(String iTitle)
Sets the CANCEL button label. |
| public void | setCLOSETitle(String iTitle)
Sets the CLOSE button label. |
| public void | setDefaultButton(int iButton)
Defines the default button. |
| public void | setOKEnable(boolean iEnable)
Enables/disables the OK button. |
| public void | setOKTitle(String iTitle)
Sets the OK button label. |
| public void | setPacked(boolean iPacked)
Enables/disables packing this dialog box to its minimum size. |
| public void | setStyle(int iStyle)
Sets the dialog box style (that is the buttons to display). |
| Field Detail |
public static final int APPLY_BUTTON
Button: APPLY
public static final int CANCEL_BUTTON
Button: CANCEL
public static final int CLOSE
Style: Close button
public static final int CLOSE_BUTTON
Button: CLOSE
public static final int NONE
Style: No button
public static final int OK_BUTTON
Button: OK
public static final int OKCANCEL
Style: Ok/Cancel buttons
public static final int OKCANCELAPPLY
Style: Ok/Apply/Cancel buttons
| Constructor Detail |
CATDialogBox(CATDialog iParent, String iName)
Creates a dialog box with the specified parent and name.
iParentiName| Method Detail |
public boolean getAPPLYEnable()
Determines whether if the APPLY button is enabled.
true if the button is enabled; false otherwise.
public CATNotification getAPPLYNotification()
Notification for the Apply button
public String getAPPLYTitle()
Returns the APPLY button label.
Returns the overwritting label (set by setAPPLYTitle() method) or the
default label (NLS).
public CATDialog getButtons()
Returns the buttons container component.
public boolean getCANCELEnable()
Determines whether if the CANCEL button is enabled.
true if the button is enabled; false otherwise.
public CATNotification getCANCELNotification()
Notification for the Cancel button
public String getCANCELTitle()
Returns the CANCEL button label.
Returns the overwritting label (set by setCANCELTitle() method) or the
default label (NLS).
public CATNotification getCLOSENotification()
Notification for the Close button
public String getCLOSETitle()
Returns the CLOSE button label.
Returns the overwritting label (set by setCLOSETitle() method) or the
default label (NLS).
public CATDialog getCmdButtons()
Returns the buttons container component.
public CATDialog getContent()
Returns the child component that is the content of the dialog box.
public CATButton getDefaultButton()
Retrieves the default button in the DialogBox (may be null).
public boolean getOKEnable()
Determines whether if the OK button is enabled.
true if the button is enabled; false otherwise.
public CATNotification getOKNotification()
Notification for the OK button.
public String getOKTitle()
Returns the OK button label.
Returns the overwritting label (set by setOKTitle() method) or the
default label (NLS).
public boolean getPacked()
Determines whether this dialog box is packed to its minimum size or not. Default is not packed.
true if this dialog box is packed; false otherwise.
public int getStyle()
Returns the dialog box current style.
public void setAPPLYEnable(boolean iEnable)
Enables/disables the APPLY button.
A disabled button doesn't fire its ButtonActivated notification.
iEnabletrue, the button is enabled; otherwise it is disabled.
public void setAPPLYTitle(String iTitle)
Sets the APPLY button label.
Calling this method overwrites programmatically the default NLS label ("Apply" in English).
iTitle
public void setCANCELEnable(boolean iEnable)
Enables/disables the CANCEL button.
A disabled button doesn't fire its ButtonActivated notification.
iEnabletrue, the button is enabled; otherwise it is disabled.
public void setCANCELTitle(String iTitle)
Sets the CANCEL button label.
Calling this method overwrites programmatically the default NLS label ("Cancel" in English).
iTitle
public void setCLOSETitle(String iTitle)
Sets the CLOSE button label.
Calling this method overwrites programmatically the default NLS label ("Close" in English).
iTitle
public void setDefaultButton(int iButton)
Defines the default button.
That causes the default button to be automatically triggered (as if it was pressed) when the user presses ENTER.
iButton
public void setOKEnable(boolean iEnable)
Enables/disables the OK button.
A disabled button doesn't fire its ButtonActivated notification.
iEnabletrue, the button is enabled; otherwise it is disabled.
public void setOKTitle(String iTitle)
Sets the OK button label.
Calling this method overwrites programmatically the default NLS label ("Ok" in English).
iTitle
public void setPacked(boolean iPacked)
Enables/disables packing this dialog box to its minimum size.
iPackedtrue, this dialog box is packed to its minimum size.
public void setStyle(int iStyle)
Sets the dialog box style (that is the buttons to display).
iStyle