Java Doc for WizardDescriptor.java in  » IDE-Netbeans » openide » org » openide » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » IDE Netbeans » openide » org.openide 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.openide.NotifyDescriptor
      org.openide.DialogDescriptor
         org.openide.WizardDescriptor

All known Subclasses:   org.openide.loaders.TemplateWizardIteratorWrapper,  org.openide.loaders.NewObjectWizardPanel,  org.openide.loaders.TemplateWizard,  org.openide.loaders.TemplateWizardPanel1,  org.openide.loaders.TemplateWizardPanel2,  org.openide.loaders.TemplateWizardIterImpl,
WizardDescriptor
public class WizardDescriptor extends DialogDescriptor (Code)
Implements a basic "wizard" GUI system. A list of wizard panels may be specified and these may be traversed at the proper times using the "Previous" and "Next" buttons (or "Finish" on the last one).
See Also:   DialogDisplayer.createDialog
See Also:    Wizard Guidebook * (describes the set of properties controlling the display of wizard panels)

Inner Class :public interface Iterator
Inner Class :public interface Panel
Inner Class :public interface FinishPanel extends Panel<Data>
Inner Class :public interface ValidatingPanel extends Panel<Data>
Inner Class :public interface AsynchronousValidatingPanel extends ValidatingPanel<Data>
Inner Class :public interface FinishablePanel extends Panel<Data>
Inner Class :public interface InstantiatingIterator extends Iterator<Data>
Inner Class :public interface AsynchronousInstantiatingIterator extends InstantiatingIterator<Data>
Inner Class :public interface ProgressInstantiatingIterator extends AsynchronousInstantiatingIterator<Data>
Inner Class :public static class ArrayIterator extends Object implements Iterator<Data>
Inner Class :static class FinishAction extends Object

Field Summary
final static  RequestProcessorASYNCHRONOUS_JOBS_RP
     Request processor that is used for asynchronous jobs (background validation, asynchronous instantiation i.e.) and supports Thread.interrupted().
final public static  ObjectFINISH_OPTION
     "Finish" button option.
final public static  ObjectNEXT_OPTION
     "Next" button option.
final public static  ObjectPREVIOUS_OPTION
     "Previous" button option.
 ResourceBundlebundle
    

Constructor Summary
public  WizardDescriptor(Panel<Data>[] wizardPanels, Data settings)
     Create a new wizard from a fixed list of panels, passing some settings to the panels.
public  WizardDescriptor(Panel<WizardDescriptor>[] wizardPanels)
     Create a new wizard from a fixed list of panels with settings defaulted to this.
public  WizardDescriptor(Iterator<Data> panels, Data settings)
     Create wizard for a sequence of panels, passing some settings to the panels.
protected  WizardDescriptor()
     Constructor for subclasses.
public  WizardDescriptor(Iterator<WizardDescriptor> panels)
     Create wizard for a sequence of panels, with settings defaulted to this.

Method Summary
final  voiddoCancelClick()
    
final  voiddoFinishClick()
    
final  voiddoNextClick()
    
final  voiddoPreviousClick()
    
public  SetgetInstantiatedObjects()
     Returns set of newly instantiated objects if the wizard has been correctly finished. Returns the empty set as default.
public synchronized  Map<String, Object>getProperties()
     Read only map with stored properties.
public synchronized  ObjectgetProperty(String name)
     Getter for stored property.
public synchronized  MessageFormatgetTitleFormat()
     Getter for current format to be used to format title.
public  ObjectgetValue()
     Overriden to ensure that returned value is one of the XXX_OPTION constants.
protected  voidinitialize()
     Initializes settings.
final  booleanisFinishEnabled()
    
 booleanisForwardEnabled()
    
final  booleanisNextEnabled()
    
public  voidputProperty(String name, Object value)
     Allows Panels that use WizardDescriptor as settings object to store additional settings into it.
public  voidsetAdditionalOptions(Object[] options)
    
public  voidsetClosingOptions(Object[] options)
    
public  voidsetHelpCtx(HelpCtx helpCtx)
    
public  voidsetOptions(Object[] options)
     Set options permitted by the wizard considered as a DialogDescriptor.
final public synchronized  voidsetPanels(Iterator panels)
     Set a different list of panels.
final public synchronized  voidsetPanelsAndSettings(Iterator<Data> panels, Data settings)
     Set a different list of panels.
public  voidsetTitleFormat(MessageFormat format)
     Sets the message format to create title of the wizard. The format can take two parameters.
public  voidsetValue(Object value)
     Overrides superclass method.
protected synchronized  voidupdateState()
     Updates buttons to reflect the current state of the panels. Can be overridden by subclasses to change the options to special values.

Field Detail
ASYNCHRONOUS_JOBS_RP
final static RequestProcessor ASYNCHRONOUS_JOBS_RP(Code)
Request processor that is used for asynchronous jobs (background validation, asynchronous instantiation i.e.) and supports Thread.interrupted(). It's package-private to accessible for unit tests.



FINISH_OPTION
final public static Object FINISH_OPTION(Code)
"Finish" button option.
See Also:   WizardDescriptor.setOptions
See Also:   



NEXT_OPTION
final public static Object NEXT_OPTION(Code)
"Next" button option.
See Also:   WizardDescriptor.setOptions
See Also:   



PREVIOUS_OPTION
final public static Object PREVIOUS_OPTION(Code)
"Previous" button option.
See Also:   WizardDescriptor.setOptions
See Also:   



bundle
ResourceBundle bundle(Code)




Constructor Detail
WizardDescriptor
public WizardDescriptor(Panel<Data>[] wizardPanels, Data settings)(Code)
Create a new wizard from a fixed list of panels, passing some settings to the panels.
Parameters:
  wizardPanels - the panels to use
Parameters:
  settings - the settings to pass to panels, or null
See Also:   WizardDescriptor.WizardDescriptor(WizardDescriptor.Iterator,Object)



WizardDescriptor
public WizardDescriptor(Panel<WizardDescriptor>[] wizardPanels)(Code)
Create a new wizard from a fixed list of panels with settings defaulted to this.
Parameters:
  wizardPanels - the panels to use
See Also:   WizardDescriptor.WizardDescriptor(WizardDescriptor.Iterator,Object)



WizardDescriptor
public WizardDescriptor(Iterator<Data> panels, Data settings)(Code)
Create wizard for a sequence of panels, passing some settings to the panels.
Parameters:
  panels - iterator over all WizardDescriptor.Panels that can appear in the wizard
Parameters:
  settings - the settings to provide to the panels (may be any data understood by them)
See Also:   WizardDescriptor.Panel.readSettings
See Also:   WizardDescriptor.Panel.storeSettings



WizardDescriptor
protected WizardDescriptor()(Code)
Constructor for subclasses. The expected use is to call this constructor and then call WizardDescriptor.setPanelsAndSettings to provide the right iterator, panels and data the wizard should use. This allows to eliminate unchecked warnings as described in issue 102261.
since:
   7.4



WizardDescriptor
public WizardDescriptor(Iterator<WizardDescriptor> panels)(Code)
Create wizard for a sequence of panels, with settings defaulted to this.
Parameters:
  panels - iterator over all WizardDescriptor.Panels that can appear in the wizard




Method Detail
doCancelClick
final void doCancelClick()(Code)



doFinishClick
final void doFinishClick()(Code)



doNextClick
final void doNextClick()(Code)



doPreviousClick
final void doPreviousClick()(Code)



getInstantiatedObjects
public Set getInstantiatedObjects()(Code)
Returns set of newly instantiated objects if the wizard has been correctly finished. Returns the empty set as default. If the wizard uses the InstantiatingIterator then WizardDescriptor returns a set of Object as same as InstantiatingIterator.instantiate().
exception:
  IllegalStateException - if this method is called on the unfinished wizard a set of Objects created
since:
   4.41



getProperties
public synchronized Map<String, Object> getProperties()(Code)
Read only map with stored properties. read only map of properties stored using WizardDescriptor.putProperty method
since:
   7.2



getProperty
public synchronized Object getProperty(String name)(Code)
Getter for stored property.
Parameters:
  name - name of the property the value



getTitleFormat
public synchronized MessageFormat getTitleFormat()(Code)
Getter for current format to be used to format title. the format
See Also:   WizardDescriptor.setTitleFormat



getValue
public Object getValue()(Code)
Overriden to ensure that returned value is one of the XXX_OPTION constants.



initialize
protected void initialize()(Code)
Initializes settings.



isFinishEnabled
final boolean isFinishEnabled()(Code)



isForwardEnabled
boolean isForwardEnabled()(Code)



isNextEnabled
final boolean isNextEnabled()(Code)



putProperty
public void putProperty(String name, Object value)(Code)
Allows Panels that use WizardDescriptor as settings object to store additional settings into it.
Parameters:
  name - name of the property
Parameters:
  value - value of property



setAdditionalOptions
public void setAdditionalOptions(Object[] options)(Code)

Parameters:
  options - the options to set



setClosingOptions
public void setClosingOptions(Object[] options)(Code)

Parameters:
  options - the options to set



setHelpCtx
public void setHelpCtx(HelpCtx helpCtx)(Code)



setOptions
public void setOptions(Object[] options)(Code)
Set options permitted by the wizard considered as a DialogDescriptor. Substitutes tokens such as WizardDescriptor.NEXT_OPTION with the actual button.
Parameters:
  options - the options to set



setPanels
final public synchronized void setPanels(Iterator panels)(Code)
Set a different list of panels. Correctly updates the buttons.
Parameters:
  panels - the new list of WizardDescriptor.Panels



setPanelsAndSettings
final public synchronized void setPanelsAndSettings(Iterator<Data> panels, Data settings)(Code)
Set a different list of panels. Correctly updates the buttons.
Parameters:
  panels - the new list of WizardDescriptor.Panels
Parameters:
  settings - the new settings that will be passed to the panels
since:
   7.2



setTitleFormat
public void setTitleFormat(MessageFormat format)(Code)
Sets the message format to create title of the wizard. The format can take two parameters. The name of the current component and the name returned by the iterator that defines the order of panels. The default value is something like
 {0} wizard {1}
 
That can be expanded to something like this
 EJB wizard (1 of 8)
 
This method allows anybody to provide own title format.
Parameters:
  format - message format to the title



setValue
public void setValue(Object value)(Code)
Overrides superclass method. Adds reseting of wizard for CLOSED_OPTION.



updateState
protected synchronized void updateState()(Code)
Updates buttons to reflect the current state of the panels. Can be overridden by subclasses to change the options to special values. In such a case use:

 super.updateState ();
 setOptions (...);
 



Fields inherited from org.openide.DialogDescriptor
final public static int BOTTOM_ALIGN(Code)(Java Doc)
final public static int DEFAULT_ALIGN(Code)(Java Doc)
final public static String PROP_BUTTON_LISTENER(Code)(Java Doc)
final public static String PROP_CLOSING_OPTIONS(Code)(Java Doc)
final public static String PROP_HELP_CTX(Code)(Java Doc)
final public static String PROP_LEAF(Code)(Java Doc)
final public static String PROP_MODAL(Code)(Java Doc)
final public static String PROP_OPTIONS_ALIGN(Code)(Java Doc)
final public static int RIGHT_ALIGN(Code)(Java Doc)

Methods inherited from org.openide.DialogDescriptor
public ActionListener getButtonListener()(Code)(Java Doc)
public Object[] getClosingOptions()(Code)(Java Doc)
public HelpCtx getHelpCtx()(Code)(Java Doc)
public int getOptionsAlign()(Code)(Java Doc)
public boolean isLeaf()(Code)(Java Doc)
public boolean isModal()(Code)(Java Doc)
public void setButtonListener(ActionListener l)(Code)(Java Doc)
public void setClosingOptions(Object[] arr)(Code)(Java Doc)
public void setHelpCtx(HelpCtx helpCtx)(Code)(Java Doc)
public void setLeaf(boolean leaf)(Code)(Java Doc)
public void setModal(boolean modal)(Code)(Java Doc)
public void setOptionsAlign(int optionsAlign)(Code)(Java Doc)

Fields inherited from org.openide.NotifyDescriptor
final public static Object CANCEL_OPTION(Code)(Java Doc)
final public static Object CLOSED_OPTION(Code)(Java Doc)
final public static int DEFAULT_OPTION(Code)(Java Doc)
final public static int ERROR_MESSAGE(Code)(Java Doc)
final public static int INFORMATION_MESSAGE(Code)(Java Doc)
final public static Object NO_OPTION(Code)(Java Doc)
final public static int OK_CANCEL_OPTION(Code)(Java Doc)
final public static Object OK_OPTION(Code)(Java Doc)
final public static int PLAIN_MESSAGE(Code)(Java Doc)
final public static String PROP_DETAIL(Code)(Java Doc)
final public static String PROP_MESSAGE(Code)(Java Doc)
final public static String PROP_MESSAGE_TYPE(Code)(Java Doc)
final public static String PROP_OPTIONS(Code)(Java Doc)
final public static String PROP_OPTION_TYPE(Code)(Java Doc)
final public static String PROP_TITLE(Code)(Java Doc)
final public static String PROP_VALID(Code)(Java Doc)
final public static String PROP_VALUE(Code)(Java Doc)
final public static int QUESTION_MESSAGE(Code)(Java Doc)
final public static int WARNING_MESSAGE(Code)(Java Doc)
final public static int YES_NO_CANCEL_OPTION(Code)(Java Doc)
final public static int YES_NO_OPTION(Code)(Java Doc)
final public static Object YES_OPTION(Code)(Java Doc)

Methods inherited from org.openide.NotifyDescriptor
public void addPropertyChangeListener(PropertyChangeListener listener)(Code)(Java Doc)
protected void firePropertyChange(String propertyName, Object oldValue, Object newValue)(Code)(Java Doc)
public Object[] getAdditionalOptions()(Code)(Java Doc)
public Object getDefaultValue()(Code)(Java Doc)
public Object getMessage()(Code)(Java Doc)
public int getMessageType()(Code)(Java Doc)
public int getOptionType()(Code)(Java Doc)
public Object[] getOptions()(Code)(Java Doc)
public String getTitle()(Code)(Java Doc)
protected static String getTitleForType(int messageType)(Code)(Java Doc)
public Object getValue()(Code)(Java Doc)
final void getterCalled()(Code)(Java Doc)
protected void initialize()(Code)(Java Doc)
final public boolean isValid()(Code)(Java Doc)
public void removePropertyChangeListener(PropertyChangeListener listener)(Code)(Java Doc)
public void setAdditionalOptions(Object[] newOptions)(Code)(Java Doc)
public void setMessage(Object newMessage)(Code)(Java Doc)
public void setMessageType(int newType)(Code)(Java Doc)
public void setOptionType(int newType)(Code)(Java Doc)
public void setOptions(Object[] newOptions)(Code)(Java Doc)
public void setTitle(String newTitle)(Code)(Java Doc)
final public void setValid(boolean newValid)(Code)(Java Doc)
public void setValue(Object newValue)(Code)(Java Doc)
void setValueWithoutPCH(Object newValue)(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.