webeq3.app
Class StructureConfigurationInfo

java.lang.Object
  webeq3.app.StyleConfigurationInfo
      webeq3.app.StructureConfigurationInfo

public class StructureConfigurationInfo
extends StyleConfigurationInfo

The class holds information about configurable features for StructureEditorFrame and StructureEditorDialog.

Constructor Summary

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

Method Summary

boolean	includeNonMMLOption() Indicates if we should show the "display non-MathML tags UI"
boolean	includeRulerOption() Returns true if the ruler option is included in the General Preferences dialog.
boolean	includeToolbarOption() Overrides this method to always return false.
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	setIncludeNonMMLOption(boolean includeNonMMLUI) Sets the value to show or hide the "display non-MathML tags UI"
void	setIncludeRulerOption(boolean ruler) Sets whether to include the ruler option in the General Preferences dialog.

Methods inherited from class webeq3.app.StyleConfigurationInfo

getDefaultStyle, getMenuEntryIncluded, includeAutoItalicOption, includeButtons, includeCommonFunctionsOption, includeFontFamilyOption, includeGreekUppercaseOption, includeParenthesesStretchyOption, includeRenderDDDoublestruckOption, includeSpacebarOption, includeStylesToolbar, setDefaultStyle, setFontFamilyOption, setIncludeAutoItalicOption, setIncludeButtons, setIncludeCommonFunctionsOption, setIncludeGreekUppercaseOption, setIncludeParenthesesStretchyOption, setIncludeRenderDDDoublestruckOption, setIncludeSpacebarOption, setIncludeStylesToolbar, setIncludeToolbarOption, setMenuEntryIncluded, setTreatWindowClosingAsOK, treatWindowClosingAsOK

Methods inherited from class java.lang.Object

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

Constructor Detail

StructureConfigurationInfo

public StructureConfigurationInfo()

Constructs a new StructureConfigurationInfo object with the default options.

Method Detail

includeNonMMLOption

public boolean includeNonMMLOption()

Indicates if we should show the "display non-MathML tags UI"

Returns:

Returns true if we should show the UI, false otherwise

includeRulerOption

public boolean includeRulerOption()

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

Returns:

true if the ruler option is included; false otherwise

includeToolbarOption

public boolean includeToolbarOption()

Overrides this method to always return false.

Overrides:

includeToolbarOption in class StyleConfigurationInfo

Returns:

true if the toolbar configuration option is included; false otherwise

See Also:

StyleConfigurationInfo.includeToolbarOption()

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.

Overrides:

setHelp in class StyleConfigurationInfo

Parameters:

helpType -

Can be one of three help types:

• HelpInfo.JAVA_HELP - Context sensitive JavaHelp. (Default)
• 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 to your own version of the SDK documentation.
• HelpInfo.SINGLE_URL - An HTML page, not context sensitive, that is provided by the user. Use the setHelp(int, String) method to set the help type and path to your own 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.

Overrides:

setHelp in class StyleConfigurationInfo

Parameters:

helpType -

Can be one of three help types:

• HelpInfo.JAVA_HELP - Context sensitive JavaHelp. (Default)
• HelpInfo.HTML_HELP - Context sensitive help using HTML page provided in the SDK.
• HelpInfo.SINGLE_URL - An HTML page, not context sensitive, that is provided by the user.

helpFile -

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

• If the help_type is JAVA_HELP, this HTML file will only be used if the JavaHelp cannot be located.
• If the help_type is HTML_HELP, set this to the HTML file provided in the SDK containing anchors to support context sensitive help, or your customized version of this file.
• 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.

setIncludeNonMMLOption

public void setIncludeNonMMLOption(boolean includeNonMMLUI)

Sets the value to show or hide the "display non-MathML tags UI"

Parameters:

includeNonMMLUI - If set to true, we will show the UI, otherwise we won't

setIncludeRulerOption

public void setIncludeRulerOption(boolean ruler)

Sets whether to include the ruler option in the General Preferences dialog.

Parameters:

ruler - true if the ruler option is to be included