当前页面: 在线文档首页 > NetBeans API Javadoc (Current Development Version)

OptionsDisplayer (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.api.options
Class OptionsDisplayer

java.lang.Object
  org.netbeans.api.options.OptionsDisplayer

---

public final class OptionsDisplayer
extends Object

Permits Options Dialog to open the options dialog with some category pre-selected.

Since:

1.5

---

Method Summary
static OptionsDisplayer	getDefault()           Get the default OptionsDisplayer
boolean	open()           Open the options dialog with no guarantee which category is pre-selected.
boolean	open(String categoryId)           Open the options dialog with some category pre-selected.

 

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

 

Method Detail

getDefault

public static OptionsDisplayer getDefault()

Get the default OptionsDisplayer

Returns:

the default instance

---

open

public boolean open()

Open the options dialog with no guarantee which category is pre-selected.

Returns:

true if optins dialog was sucesfully opened with some pre-selected category. If no category is registered at all then false will be returned and options dialog won't be opened.

---

open

public boolean open(String categoryId)

Open the options dialog with some category pre-selected.

Parameters:

categoryId - ID representing required category which is registration name (e.g. "FooOptionsPanelID" for following registration:

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

Returns:

true if optins dialog was sucesfully opened with required category pre-selected. If this method is called when options dialog is already opened then this method will return immediately false without affecting currently selected category in opened options dialog. If categoryId passed as a parameter does not correspond to any of registered categories then false is returned and options dialog is not opened at all (e.g. in case that module providing such category is not installed or enabled).

---

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

---

Built on May 28 2007.  |  Portions Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.