gui.dialog
Class DialogContentPaneOptions

java.lang.Object
  gui.dialog.DialogContentPaneOptions

public class DialogContentPaneOptions
extends java.lang.Object

Defines the buttons that are available in a dialog.

Field Summary

private JAPHelpContext.IHelpContext	m_helpContext
private int	m_optionType
private DialogContentPane	m_previousContentPane

Constructor Summary

DialogContentPaneOptions(DialogContentPane a_previousContentPane)
Creates new button options.

DialogContentPaneOptions(int a_optionType)
Creates new button options.

DialogContentPaneOptions(int a_optionType, DialogContentPane a_previousContentPane)
Creates new button options.

DialogContentPaneOptions(int a_optionType, JAPHelpContext.IHelpContext a_helpContext)
Creates new button options.

DialogContentPaneOptions(int a_optionType, JAPHelpContext.IHelpContext a_helpContext, DialogContentPane a_previousContentPane)
Creates new button options.

DialogContentPaneOptions(int a_optionType, java.lang.String a_strHelpContext)
Creates new button options.

DialogContentPaneOptions(int a_optionType, java.lang.String a_strHelpContext, DialogContentPane a_previousContentPane)
Creates new button options.

DialogContentPaneOptions(JAPHelpContext.IHelpContext a_helpContext)
Creates new button options.

DialogContentPaneOptions(JAPHelpContext.IHelpContext a_helpContext, DialogContentPane a_previousContentPane)
Creates new button options.

DialogContentPaneOptions(java.lang.String a_strHelpContext)
Creates new button options.

Method Summary

int	countExtraButtons() Overwrite this method to return the number of extra buttons that you would like to introduce.
protected AbstractDialogExtraButton	getExtraButton(int a_buttonNr)
AbstractDialogExtraButton	getExtraButtonInternal(int a_buttonNr) Overwrite this method to return your extra, custom button.
JAPHelpContext.IHelpContext	getHelpContext()
int	getOptionType()
DialogContentPane	getPreviousContentPane()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

m_optionType

private int m_optionType

m_previousContentPane

private DialogContentPane m_previousContentPane

m_helpContext

private JAPHelpContext.IHelpContext m_helpContext

Constructor Detail

DialogContentPaneOptions

public DialogContentPaneOptions(int a_optionType)

Creates new button options.

Parameters:

a_optionType - one of the available option types the define the type and number of buttons

DialogContentPaneOptions

public DialogContentPaneOptions(java.lang.String a_strHelpContext)

Creates new button options. No buttons are shown by default.

Parameters:

a_strHelpContext - a IHelpContext; if it returns an other help context value than null, a help button is shown that opens the context;

DialogContentPaneOptions

public DialogContentPaneOptions(JAPHelpContext.IHelpContext a_helpContext)

Creates new button options. No buttons are shown by default.

Parameters:

a_helpContext - a IHelpContext; if it returns an other help context value than null, a help button is shown that opens the context;

DialogContentPaneOptions

public DialogContentPaneOptions(DialogContentPane a_previousContentPane)

Creates new button options. No buttons are shown by default.

Parameters:

a_previousContentPane - A DialogContentPane that will be linked with this one; it gets this content pane as next content pane. Call moveToNextContentPane() and moveToPreviousContentPane() to move between the panes.

DialogContentPaneOptions

public DialogContentPaneOptions(JAPHelpContext.IHelpContext a_helpContext,
                                DialogContentPane a_previousContentPane)

Creates new button options. No buttons are shown by default.

Parameters:

a_helpContext - a IHelpContext; if it returns an other help context value than null, a help button is shown that opens the context;

a_previousContentPane - A DialogContentPane that will be linked with this one; it gets this content pane as next content pane. Call moveToNextContentPane() and moveToPreviousContentPane() to move between the panes.

DialogContentPaneOptions

public DialogContentPaneOptions(int a_optionType,
                                DialogContentPane a_previousContentPane)

Creates new button options.

Parameters:

a_optionType - one of the available option types the define the type and number of buttons

a_previousContentPane - A DialogContentPane that will be linked with this one; it gets this content pane as next content pane. Call moveToNextContentPane() and moveToPreviousContentPane() to move between the panes.

DialogContentPaneOptions

public DialogContentPaneOptions(int a_optionType,
                                JAPHelpContext.IHelpContext a_helpContext)

Creates new button options.

Parameters:

a_optionType - one of the available option types the define the type and number of buttons

a_helpContext - a IHelpContext; if it returns an other help context value than null, a help button is shown that opens the context;

DialogContentPaneOptions

public DialogContentPaneOptions(int a_optionType,
                                java.lang.String a_strHelpContext)

Creates new button options.

Parameters:

a_optionType - one of the available option types the define the type and number of buttons

a_strHelpContext - a IHelpContext; if it returns an other help context value than null, a help button is shown that opens the context;

DialogContentPaneOptions

public DialogContentPaneOptions(int a_optionType,
                                java.lang.String a_strHelpContext,
                                DialogContentPane a_previousContentPane)

Creates new button options.

Parameters:

a_optionType - one of the available option types the define the type and number of buttons

a_strHelpContext - a IHelpContext; if it returns an other help context value than null, a help button is shown that opens the context;

a_previousContentPane - A DialogContentPane that will be linked with this one; it gets this content pane as next content pane. Call moveToNextContentPane() and moveToPreviousContentPane() to move between the panes.

DialogContentPaneOptions

public DialogContentPaneOptions(int a_optionType,
                                JAPHelpContext.IHelpContext a_helpContext,
                                DialogContentPane a_previousContentPane)

Creates new button options.

Parameters:

a_optionType - one of the available option types the define the type and number of buttons

a_helpContext - a IHelpContext; if it returns an other help context value than null, a help button is shown that opens the context;

a_previousContentPane - A DialogContentPane that will be linked with this one; it gets this content pane as next content pane. Call moveToNextContentPane() and moveToPreviousContentPane() to move between the panes.

Method Detail

getOptionType

public final int getOptionType()

getHelpContext

public final JAPHelpContext.IHelpContext getHelpContext()

getPreviousContentPane

public final DialogContentPane getPreviousContentPane()

countExtraButtons

public int countExtraButtons()

Overwrite this method to return the number of extra buttons that you would like to introduce.

Returns:

the number of extra buttons that you would like to introduce

getExtraButtonInternal

public AbstractDialogExtraButton getExtraButtonInternal(int a_buttonNr)

Overwrite this method to return your extra, custom button. The helper method getExtraButton() will make sure that a_buttonNr ranges from 0 to countExtraButtons() - 1, so you don't have to check for a valid index yourself.

Parameters:

a_buttonNr - from 0 to countExtraButtons() - 1

Returns:

your extra, custom button

getExtraButton

protected final AbstractDialogExtraButton getExtraButton(int a_buttonNr)