webeq3.app
Class SimpleConfigurationInfo

java.lang.Object
  webeq3.app.SimpleConfigurationInfo

public class SimpleConfigurationInfo
extends java.lang.Object

The class holds information about configurable features for SimpleEditorFrame and SimpleEditorDialog.

Constructor Summary

SimpleConfigurationInfo()
Constructs a new SimpleConfigurationInfo object with the default options.

Method Summary

boolean	getMenuBarIncluded() Returns true if there is a menubar in the top window.
boolean	getMenuEntryIncluded(int itemID) Returns true if the specified menu item is included.
void	setHelp(int helpType) Sets the help type for the help system.
void	setHelp(int helpType, java.lang.String helpFile) Sets the help type if you want to provide path to the HTML help page.
void	setMenuBarIncluded(boolean b) Sets whether to add a menubar in the top window.
void	setMenuEntryIncluded(int itemID, boolean b) Sets whether to include the specified menu item.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleConfigurationInfo

public SimpleConfigurationInfo()

Constructs a new SimpleConfigurationInfo object with the default options.

Method Detail

getMenuBarIncluded

public boolean getMenuBarIncluded()

Returns true if there is a menubar in the top window.

Returns:

true if menubar is there in the top window; false otherwise

getMenuEntryIncluded

public boolean getMenuEntryIncluded(int itemID)

Returns true if the specified menu item is included.

Parameters:

itemID - the menu item ID

Returns:

true if the specified menu item in included

setHelp

public void setHelp(int helpType)

Sets the help type for the help system. Using this method doesn't allow you to set a path to your own HTML help file. Instead, it will use the default JavaHelp included with the SDK, or look for HTML in the same directory as the jar file. By default, the application uses JavaHelp.

Parameters:

helpType -

Can be one of three help types:

• HelpInfo.JAVA_HELP - Context sensitive JavaHelp. (Default) If using JavaHelp in applets, you must use setHelp(int, String) to pass in the name of the jar file containing the JavaHelp.
• HelpInfo.HTML_HELP - Context sensitive help using HTML page provided in the SDK. Use the setHelp(int, String) method to set the help type and path the documentation.
• HelpInfo.SINGLE_URL - An HTML page, not context sensitive. Use the setHelp(int, String) method to set the help type and the path to the documentation.

See Also:

setHelp(int, String)

setHelp

public void setHelp(int helpType,
                    java.lang.String helpFile)

Sets the help type if you want to provide path to the HTML help page. For example, if you customize the sample HTML help file provided in the SDK, use this method to provide a path to the location of that file. By default, the application uses JavaHelp.

Parameters:

helpType -

Can be one of three help types:

• HelpInfo.JAVA_HELP - Context sensitive JavaHelp. (Default) If using JavaHelp in applets, you must pass in the name of the jar file containing the JavaHelp as the second parameter.
• HelpInfo.HTML_HELP - Context sensitive help using HTML page provided in the SDK.
• HelpInfo.SINGLE_URL - An HTML page, not context sensitive.

helpFile -

Indicates the location of the HTML file containing the HTML help.

• If the help_type is JAVA_HELP, pass the name of the jar containing the JavaHelp.
• If the help_type is HTML_HELP, set this to the HTML file provided in the SDK.
  Examples:
  • ../../../docs/help/html/style/index.htm
  • C:/mycode/docs/help/html/style/index.htm
  • http://www.mywebpage.com/help/index.htm
  
  
• If the help_type is SINGLE_URL, all entry points into the help from the editor's UI will point to this page with no context sensitive help functionality.

setMenuBarIncluded

public void setMenuBarIncluded(boolean b)

Sets whether to add a menubar in the top window.

Parameters:

b - true if menubar is to be added in the top window

setMenuEntryIncluded

public void setMenuEntryIncluded(int itemID,
                                 boolean b)

Sets whether to include the specified menu item.

Parameters:

itemID - the menu item ID

b - true if the specified menu item is to be included

See Also:

UIConstants