com.isti.util
Interface ProgramInformationInterface

public interface ProgramInformationInterface

Interface ProgramInformationInterface defines methods for program information.

Field Summary

static java.lang.String

defaultSettingsConfigGroupName The default settings config group name string.

Method Summary

IstiDialogUtil	getIstiDialogUtil() Gets the 'IstiDialogUtil' object.
CfgProperties	getProgramCfgProperties() Get the configuration properties for the program.
javax.swing.JFrame	getProgramFrameObj() Returns the frame object for the program.
LogFile	getProgramLogFileObj() Returns the main log file object for the program.
java.lang.String	getProgramName() Get the name string for the program.
java.lang.String	getProgramRevision() Get the revision string for the program.
java.lang.String	getProgramVersion() Get the version string for program.
java.lang.String	getSettingsConfigGroupName() Gets the settings config group name string.
java.lang.String	getSettingsManualFilename() Gets the settings manual filename.
java.lang.String	getSettingsManualTitleString() Gets the settings manual title string.
ViewHTMLPanelHandler	getViewHTMLPanelHandler() Gets the 'ViewHTMLPanelHandler' object.
boolean	isSaveConfigAllowed() Determinies if saving the configuration file should be allowed.
void	saveConfiguration(boolean forceFlag, boolean popupFlag) Commits various settings to their configuration items and (possibly) saves the configuration to the default configuration filename.

Field Detail

defaultSettingsConfigGroupName

public static final java.lang.String defaultSettingsConfigGroupName

The default settings config group name string.

See Also:

Constant Field Values

Method Detail

getIstiDialogUtil

public IstiDialogUtil getIstiDialogUtil()

Gets the 'IstiDialogUtil' object.

Returns:

the 'IstiDialogUtil' object or null if none.

getProgramCfgProperties

public CfgProperties getProgramCfgProperties()

Get the configuration properties for the program.

Returns:

the configuration properties for the program.

getProgramFrameObj

public javax.swing.JFrame getProgramFrameObj()

Returns the frame object for the program.

Returns:

The frame object for the program.

getProgramLogFileObj

public LogFile getProgramLogFileObj()

Returns the main log file object for the program.

Returns:

The main log file object for the program.

getProgramName

public java.lang.String getProgramName()

Get the name string for the program.

Returns:

the name string for the program.

getProgramRevision

public java.lang.String getProgramRevision()

Get the revision string for the program.

Returns:

the revision string for the program.

getProgramVersion

public java.lang.String getProgramVersion()

Get the version string for program.

Returns:

the version string for program.

getSettingsConfigGroupName

public java.lang.String getSettingsConfigGroupName()

Gets the settings config group name string.

Returns:

the settings config group name string.

See Also:

defaultSettingsConfigGroupName.

getSettingsManualFilename

public java.lang.String getSettingsManualFilename()

Gets the settings manual filename.

Returns:

the settings manual filename or null if none.

getSettingsManualTitleString

public java.lang.String getSettingsManualTitleString()

Gets the settings manual title string.

Returns:

the settings manual title string or null if none.

getViewHTMLPanelHandler

public ViewHTMLPanelHandler getViewHTMLPanelHandler()

Gets the 'ViewHTMLPanelHandler' object.

Returns:

the 'ViewHTMLPanelHandler' object or null if none.

isSaveConfigAllowed

public boolean isSaveConfigAllowed()

Determinies if saving the configuration file should be allowed.

Returns:

true if saving the configuration file should be allowed, false otherwise.

See Also:

saveConfiguration

saveConfiguration

public void saveConfiguration(boolean forceFlag,
                              boolean popupFlag)

Commits various settings to their configuration items and (possibly) saves the configuration to the default configuration filename. A separate thread and a slight delay are used so that multiple near- simultaneous calls result in a single write to the config file.

Parameters:

forceFlag - if true then the the configuration is always saved to file; if false then the configuration is only saved to file if a change in the committed-program settings is detected.

popupFlag - if true and an error occurs while saving then a popup message window is shown to display the error.

See Also:

isSaveConfigAllowed