OptionsCategory (Options Dialog and SPI) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

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

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.spi.options
Class OptionsCategory

java.lang.Object
  org.netbeans.spi.options.OptionsCategory

public abstract class OptionsCategory
extends Object
extends Object

Implementation of this class represents one category (like "Fonts & Colors" or "Editor") in Options Dialog. It should be registerred in layers:

 <folder name="OptionsDialog">
     <file name="FooOptionsPanel.instance">
         <attr name="instanceClass" stringvalue="org.foo.FooOptionsPanel"/>
     </file>
 </folder>

Use standard way how to sort items registered in layers:

 <attr name="GeneralPanel.instance/FooOptionsPanel.instance" boolvalue="true"/>

See Also:: AdvancedOption, OptionsPanelController

Constructor Summary

OptionsCategory()


Method Summary

abstract OptionsPanelController create()
          Returns new OptionsPanelController for this category.

abstract String getCategoryName()
          Returns name of category used in list on the left side of Options Dialog.

Icon getIcon()
          Returns 32x32 icon used in list on the left side of Options Dialog.

String getIconBase()
          Deprecated. This method will not be a part of NB50! Use getIcon() instead.

abstract String getTitle()
          This text will be used in title component on the top of Options Dialog when your panel will be selected.

Methods inherited from class java.lang.Object

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

Constructor Summary
`OptionsCategory()`

Method Summary
`abstract OptionsPanelController`	`create()` Returns new `OptionsPanelController` for this category.
`abstract String`	`getCategoryName()` Returns name of category used in list on the left side of Options Dialog.
`Icon`	`getIcon()` Returns 32x32 icon used in list on the left side of Options Dialog.
`String`	`getIconBase()` Deprecated. This method will not be a part of NB50! Use `getIcon()` instead.
`abstract String`	`getTitle()` This text will be used in title component on the top of Options Dialog when your panel will be selected.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

OptionsCategory

public OptionsCategory()

Method Detail

getIconBase

public String getIconBase()

Deprecated. This method will not be a part of NB50! Use getIcon() instead.

Returns base name of 32x32 icon (gif, png) used in list on the left side of Options Dialog. See AbstractNode#setIconBase method for more info.

Returns:: base name of 32x32 icon

getIcon

public Icon getIcon()

Returns 32x32 icon used in list on the left side of Options Dialog.

Returns:: 32x32 icon

getCategoryName

public abstract String getCategoryName()

Returns name of category used in list on the left side of Options Dialog.

Returns:: name of category

getTitle

public abstract String getTitle()

This text will be used in title component on the top of Options Dialog when your panel will be selected.

Returns:: title of this panel

create

public abstract OptionsPanelController create()

Returns new OptionsPanelController for this category. PanelController creates visual component to be used inside of the Options Dialog. You should not do any time-consuming operations inside the constructor, because it blocks initialization of OptionsDialog. Initialization should be implemented in update method.

Returns:: new instance of PanelController for this options category