org.netbeans.modules.options.api/1 1.12.2

org.netbeans.spi.options
Class AdvancedOption

java.lang.Object
  extended by 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. Its instances should be registered in layers and created by createSubCategory factory method 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 pointer to Bundle where your tab displayname is stored
toolTip should be a pointer to Bundle where your tab toolTip is stored
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

See Also:
OptionsCategory, OptionsPanelController

Constructor Summary
AdvancedOption()
           
 
Method Summary
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

public AdvancedOption()
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.

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

org.netbeans.modules.options.api/1 1.12.2

Built on September 9 2009.  |  Portions Copyright 1997-2009 Sun Microsystems, Inc. All rights reserved.