org.netbeans.spi.options

Class AdvancedOption

java.lang.Object

org.netbeans.spi.options.AdvancedOption

public abstract class AdvancedOption
extends Object

This class represents one category (like "Ant" or "Form Editor") in Miscellaneous Panel of Options Dialog.

Normally panels are registered using OptionsPanelController.SubRegistration. They may also be registered in a layer manually as follows:

 <folder name="OptionsDialog">
     <folder name="Advanced">
         <file name="FooAdvancedPanel.instance">
             <attr name="instanceCreate" methodvalue="org.netbeans.spi.options.AdvancedOption.createSubCategory"/>
             <attr name="controller" newvalue="org.foo.ToDoOptionsController"/>
             <attr name="displayName" bundlevalue="org.foo.Bundle#LBL_Foo"/>
             <attr name="toolTip" bundlevalue="org.foo.Bundle#HINT_Foo"/>
             <attr name="keywords" bundlevalue="org.foo.Bundle#KW_Foo"/>
             <attr name="keywordsCategory" stringvalue="Advanced/FooSubTabInOptions"/>
         </file>
     </folder>
 </folder>

where:
controller should be an instance of OptionsPanelController
displayName should be a localized string for your tab display name
toolTip should be a localized string for your tab tool tip Currently unused.
keywords should be localized keywords list, separated by comma in Bundle, for quickserach purposes
keywordsCategory should be relative path to your panel inside Options dialog

No explicit sorting recognized (may be sorted e.g. by display name).

Related documentation

• NetBeans Options Window Module Tutorial

See Also:

OptionsCategory, OptionsPanelController

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AdvancedOption() Deprecated. Use OptionsPanelController.SubRegistration instead.

Method Summary

Modifier and Type	Method and Description
abstract OptionsPanelController	create() Returns OptionsPanelController for this category.
abstract String	getDisplayName() Returns name of category used in Advanced Panel of Options Dialog.
abstract String	getTooltip() Returns tooltip to be used on category name.

Methods inherited from class java.lang.Object

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

Constructor Detail

AdvancedOption

@Deprecated
protected AdvancedOption()

Deprecated. Use OptionsPanelController.SubRegistration instead.

Method Detail

getDisplayName

public abstract String getDisplayName()

Returns name of category used in Advanced Panel of Options Dialog.

Returns:

name of category

getTooltip

public abstract String getTooltip()

Returns tooltip to be used on category name.

Currently unused.

Returns:

tooltip for this category

create

public abstract OptionsPanelController create()

Returns OptionsPanelController for this category. PanelController creates visual component to be used inside of Advanced Panel.

Returns:

new instance of OptionsPanelController for this advanced options category