webeq3.app
Class StyleConfigurationInfo

java.lang.Object
  webeq3.app.StyleConfigurationInfo

Direct Known Subclasses:

StructureConfigurationInfo

public class StyleConfigurationInfo
extends java.lang.Object

The class holds information about configurable features for StyleEditorFrame and StyleEditorDialog.

Constructor Summary

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

Method Summary

java.lang.String	getDefaultStyle() Returns which style will be used by default when creating a new (blank) equation.
boolean	getMenuEntryIncluded(int itemID) Returns true if the specified menu item is included.
boolean	includeAutoItalicOption() Returns true if the single character auto italic checkbox is included in the General Preferences dialog.
boolean	includeButtons() Returns true if the "OK" and "Cancel" buttons are included.
boolean	includeCommonFunctionsOption() Returns true if the recognize common functions checkbox is included in the General Preferences dialog.
boolean	includeFontFamilyOption() Returns true if the font family option is included in the Font Properties dialog.
boolean	includeGreekUppercaseOption() Returns true if the uppercase Greek normal checkbox is included in the General Preferences dialog.
boolean	includeParenthesesStretchyOption() Returns true if the parentheses auto stretchy checkbox is included in the General Preferences dialog.
boolean	includeRenderDDDoublestruckOption() Returns true if the differential d in double struck checkbox is included in the General Preferences dialog.
boolean	includeSpacebarOption() Returns true if the spacebar behavior option is included in the General Preferences dialog.
boolean	includeStylesToolbar() Returns true if the styles toolbar is included.
boolean	includeToolbarOption() Returns true if the toolbar configuration option is included in the General Preferences dialog.
void	setDefaultStyle(java.lang.String style) Sets which style will be used by default when creating a new (blank) equation.
void	setFontFamilyOption(boolean b) Sets whether to include the font family option in the Font Properties dialog.
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	setIncludeAutoItalicOption(boolean b) Sets whether to include the single character auto italic checkbox in the General Preferences dialog.
void	setIncludeButtons(boolean b) Sets whether to include the "OK" and "Cancel" buttons.
void	setIncludeCommonFunctionsOption(boolean b) Sets whether to include the recognize common functions checkbox in the General Preferences dialog.
void	setIncludeGreekUppercaseOption(boolean b) Sets whether to include the uppercase Greek normal checkbox in the General Preferences dialog.
void	setIncludeParenthesesStretchyOption(boolean b) Sets whether to include the parentheses auto stretchy checkbox in the General Preferences dialog.
void	setIncludeRenderDDDoublestruckOption(boolean b) Sets whether to include the differential d in double struck checkbox in the General Preferences dialog.
void	setIncludeSpacebarOption(boolean b) Sets whether to include the spacebar behavior option in the General Preferences dialog.
void	setIncludeStylesToolbar(boolean b) Sets whether to include the styles toolbar.
void	setIncludeToolbarOption(boolean b) Sets whether to include the toolbar configuration option in the General Preferences dialog.
void	setMenuEntryIncluded(int itemID, boolean b) Sets whether to include the specified menu item.
void	setTreatWindowClosingAsOK(boolean b) Sets whether to treat closing the editor window by clicking "X" the same as clicking the "OK" button.
boolean	treatWindowClosingAsOK() Returns true if closing the editor window by clicking "X" is treated the same as clicking the "OK" button.

Methods inherited from class java.lang.Object

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

Constructor Detail

StyleConfigurationInfo

public StyleConfigurationInfo()

Constructs a new StyleConfigurationInfo object with the default options.

Method Detail

getDefaultStyle

public java.lang.String getDefaultStyle()

Returns which style will be used by default when creating a new (blank) equation.

Returns:

the style to be used by default when creating a new (blank) equation

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

includeAutoItalicOption

public boolean includeAutoItalicOption()

Returns true if the single character auto italic checkbox is included in the General Preferences dialog.

Returns:

true if the single character auto italic checkbox is included; false otherwise

includeButtons

public boolean includeButtons()

Returns true if the "OK" and "Cancel" buttons are included.

Returns:

true if the "OK" and "Cancel" buttons are included; false otherwise

includeCommonFunctionsOption

public boolean includeCommonFunctionsOption()

Returns true if the recognize common functions checkbox is included in the General Preferences dialog.

Returns:

true if the recognize common functions checkbox is included; false otherwise

includeFontFamilyOption

public boolean includeFontFamilyOption()

Returns true if the font family option is included in the Font Properties dialog.

Returns:

true if the font family option is included; false otherwise

includeGreekUppercaseOption

public boolean includeGreekUppercaseOption()

Returns true if the uppercase Greek normal checkbox is included in the General Preferences dialog.

Returns:

true if the uppercase Greek normal checkbox is included; false otherwise

includeParenthesesStretchyOption

public boolean includeParenthesesStretchyOption()

Returns true if the parentheses auto stretchy checkbox is included in the General Preferences dialog.

Returns:

true if the parentheses auto stretchy checkbox is included; false otherwise

includeRenderDDDoublestruckOption

public boolean includeRenderDDDoublestruckOption()

Returns true if the differential d in double struck checkbox is included in the General Preferences dialog.

Returns:

true if the differential d in double struck checkbox is included; false otherwise

includeSpacebarOption

public boolean includeSpacebarOption()

Returns true if the spacebar behavior option is included in the General Preferences dialog.

Returns:

true if the spacebar behavior option is included; false otherwise

includeStylesToolbar

public boolean includeStylesToolbar()

Returns true if the styles toolbar is included.

Returns:

true if the styles toolbar is included; false otherwise

includeToolbarOption

public boolean includeToolbarOption()

Returns true if the toolbar configuration option is included in the General Preferences dialog.

Returns:

true if the toolbar configuration option is included; false otherwise

setDefaultStyle

public void setDefaultStyle(java.lang.String style)

Sets which style will be used by default when creating a new (blank) equation.

Parameters:

style - the style to be used by default when creating a new (blank) equation

setFontFamilyOption

public void setFontFamilyOption(boolean b)

Sets whether to include the font family option in the Font Properties dialog.

Parameters:

b - true if the font family option is to be 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.

setIncludeAutoItalicOption

public void setIncludeAutoItalicOption(boolean b)

Sets whether to include the single character auto italic checkbox in the General Preferences dialog.

Parameters:

b - true if the single character auto italic checkbox is to be included

setIncludeButtons

public void setIncludeButtons(boolean b)

Sets whether to include the "OK" and "Cancel" buttons.

Parameters:

b - true if the "OK" and "Cancel" buttons are to be included

setIncludeCommonFunctionsOption

public void setIncludeCommonFunctionsOption(boolean b)

Sets whether to include the recognize common functions checkbox in the General Preferences dialog.

Parameters:

b - true if the recognize common functions checkbox is to be included

setIncludeGreekUppercaseOption

public void setIncludeGreekUppercaseOption(boolean b)

Sets whether to include the uppercase Greek normal checkbox in the General Preferences dialog.

Parameters:

b - true if the uppercase Greek normal checkbox is to be included

setIncludeParenthesesStretchyOption

public void setIncludeParenthesesStretchyOption(boolean b)

Sets whether to include the parentheses auto stretchy checkbox in the General Preferences dialog.

Parameters:

b - true if the parentheses auto stretchy checkbox is to be included

setIncludeRenderDDDoublestruckOption

public void setIncludeRenderDDDoublestruckOption(boolean b)

Sets whether to include the differential d in double struck checkbox in the General Preferences dialog.

Parameters:

b - true if the differential d in double struck checkbox is to be included

setIncludeSpacebarOption

public void setIncludeSpacebarOption(boolean b)

Sets whether to include the spacebar behavior option in the General Preferences dialog.

Parameters:

b - true if the spacebar behavior option is to be included

setIncludeStylesToolbar

public void setIncludeStylesToolbar(boolean b)

Sets whether to include the styles toolbar.

Parameters:

b - true if the styles toolbar is to be included

setIncludeToolbarOption

public void setIncludeToolbarOption(boolean b)

Sets whether to include the toolbar configuration option in the General Preferences dialog.

Parameters:

b - true if the toolbar configuration option is to be included

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

setTreatWindowClosingAsOK

public void setTreatWindowClosingAsOK(boolean b)

Sets whether to treat closing the editor window by clicking "X" the same as clicking the "OK" button.

Parameters:

b - true if closing the editor window by clicking "X" is treated the same as clicking the "OK" button

treatWindowClosingAsOK

public boolean treatWindowClosingAsOK()

Returns true if closing the editor window by clicking "X" is treated the same as clicking the "OK" button.

Returns:

true if closing the editor window by clicking "X" is treated the same as clicking the "OK" button; false otherwise