Java Doc for WizardContext.java in  » Database-Client » iSQL-Viewer » org » isqlviewer » ui » wizards » 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 » Database Client » iSQL Viewer » org.isqlviewer.ui.wizards 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.isqlviewer.ui.wizards.WizardContext

WizardContext
abstract public class WizardContext (Code)
Context to support custom wizards by providing common functionality.

This object is in the same spirit of a ServletContext, this class represents common functionality for all custom wizards.
author:
   Mark A. Kobold <mkobold at isqlviewer dot com>
version:
   1.0




Constructor Summary
protected  WizardContext(SwingEventManager eventManager)
    

Method Summary
public  voiddebug(Object message, Throwable error)
     Logs debugging messages and supplementary exception.
public  voiddebug(Object message)
     Logs message for debugging purposes.
public  voiderror(Object message, Throwable error)
     Logs error messages and supplementary exception.
public  voiderror(Object message)
     Logs an error message.
public  ObjectgetAttribute(String name)
     Returns the context attribute with the given name, or null if there is no attribute by that name.
public  Enumeration<String>getAttributeNames()
     Provides an enumeration of all available attributes in the current context.
public  SwingEventManagergetEventManager()
    
public  voidinfo(Object message, Throwable error)
     Logs informational error and supplementary message.
public  voidinfo(Object message)
     Logs an informational message.
abstract public  voidinvokeNext()
     Allows pragmatic navigation through other events beyond clicking 'Next' in a wizard.
public  voidmarkTextComponentIncorrect(JTextComponent textArea)
     Marks a text component as invalid to the user.
public  voidremoveAttribute(String name)
     Removes the selected attribute by name from this context.
public  voidsetAttribute(String name, Object attribute)
     Sets an attribute in this context.
abstract public  voidshowErrorDialog(Throwable error, String message)
     Shows a generic error dialog to the user with an error and message.
public  voidshowErrorDialog(Component owner, Throwable error, String message)
     Shows a generic error dialog to the user with an error and message.
abstract public  voidshowInformationDialog(String message)
     Shows a generic information dialog to the user with a message

This implementation allows wizard code to notify the user informational message without having to have a reference to an actual visual component.

public  voidshowInformationDialog(Component owner, String message)
    
public  voidunmarkTextComponentIncorrect(JTextComponent textArea)
     Restores an invalid text component to its original state.
abstract public  voidupdateSteps(Collection<Step> newSteps)
     Updates the list of setps after the current step.

Often wizards will allow a user to take different action leading to different set of steps.

public  voidwarn(Object message, Throwable error)
     Logs warning messages and supplementary exception.
public  voidwarn(Object message)
     Logs warning messages.


Constructor Detail
WizardContext
protected WizardContext(SwingEventManager eventManager)(Code)




Method Detail
debug
public void debug(Object message, Throwable error)(Code)
Logs debugging messages and supplementary exception.

if debug messages are enabled the message and exception will be logged to designated destination.
Parameters:
  message - debug message to log.
Parameters:
  error - exception associated with the message.




debug
public void debug(Object message)(Code)
Logs message for debugging purposes.

if debugging is enabled the message will be logged to designated destination.
Parameters:
  message - debug information to log.




error
public void error(Object message, Throwable error)(Code)
Logs error messages and supplementary exception.

if error messages are enabled the message and exception will be logged to designated destination.
Parameters:
  message - error message to log.
Parameters:
  error - exception associated with the message.




error
public void error(Object message)(Code)
Logs an error message.

if error logging is enabled the message will be logged to designated destination.
Parameters:
  message - error message to log.




getAttribute
public Object getAttribute(String name)(Code)
Returns the context attribute with the given name, or null if there is no attribute by that name.

An attribute allows a wizard runner instance to give the custom wizard additional information inbetween steps. an Object containing the value of the attribute, or null if no attribute exists matching the given name
throws:
  NullPointerException - if name is null




getAttributeNames
public Enumeration<String> getAttributeNames()(Code)
Provides an enumeration of all available attributes in the current context.

enumeration of all the attribute names currently bound in this context.




getEventManager
public SwingEventManager getEventManager()(Code)



info
public void info(Object message, Throwable error)(Code)
Logs informational error and supplementary message.

if informational messages are enabled the message and exception will be logged to designated destination.
Parameters:
  message - informational message to log.
Parameters:
  error - exception associated with the message.




info
public void info(Object message)(Code)
Logs an informational message.

if informational loggins is enabled the message will be logged to designated destination.
Parameters:
  message - informational message to log.




invokeNext
abstract public void invokeNext()(Code)
Allows pragmatic navigation through other events beyond clicking 'Next' in a wizard.




markTextComponentIncorrect
public void markTextComponentIncorrect(JTextComponent textArea)(Code)
Marks a text component as invalid to the user.

If a text field has invalid input than this method should be called to provide consistent feedback to the user with the notion of invalid input.
Parameters:
  textArea - to mark as incorrect or invalid.
See Also:   WizardContext.unmarkTextComponentIncorrect(JTextComponent)




removeAttribute
public void removeAttribute(String name)(Code)
Removes the selected attribute by name from this context.

Once the attribute has been removed it will no longer be accesible from this context.
Parameters:
  name - of the attribute to remove.
throws:
  NullPointerException - if name is null.




setAttribute
public void setAttribute(String name, Object attribute)(Code)
Sets an attribute in this context.

If an attribute already exists with the given name it will override it with the new value.
Parameters:
  name - of the object to bound to this context.
Parameters:
  attribute - the value being bound to this context by the given name.
throws:
  NullPointerException - if name or attribute are null;




showErrorDialog
abstract public void showErrorDialog(Throwable error, String message)(Code)
Shows a generic error dialog to the user with an error and message.

This implementation allows wizard code to notify the user of an error without having to have a reference to an actual visual component.
Parameters:
  error - with an accompanying stack-trace the display can be null.
Parameters:
  message - descriptive message as to the source of error.




showErrorDialog
public void showErrorDialog(Component owner, Throwable error, String message)(Code)
Shows a generic error dialog to the user with an error and message.

This implementation allows wizard code to notify the user of an error without having to have a reference to an actual visual component.
Parameters:
  error - with an accompanying stack-trace the display can be null.
Parameters:
  message - descriptive message as to the source of error.
Parameters:
  owner - component owner to show the error dialog from.




showInformationDialog
abstract public void showInformationDialog(String message)(Code)
Shows a generic information dialog to the user with a message

This implementation allows wizard code to notify the user informational message without having to have a reference to an actual visual component.
Parameters:
  message - descriptive message to the user.




showInformationDialog
public void showInformationDialog(Component owner, String message)(Code)
Shows a generic information dialog to the user with a message


Parameters:
  message - descriptive message to the user.
Parameters:
  owner - component owner to show the informational dialog from.




unmarkTextComponentIncorrect
public void unmarkTextComponentIncorrect(JTextComponent textArea)(Code)
Restores an invalid text component to its original state.

Use this method in conjunction with markTextComponentIncorrect() when the user input has become valid.
Parameters:
  textArea - to restore and mark as valid.
See Also:   WizardContext.markTextComponentIncorrect(JTextComponent)




updateSteps
abstract public void updateSteps(Collection<Step> newSteps)(Code)
Updates the list of setps after the current step.

Often wizards will allow a user to take different action leading to different set of steps. this function allows a wizard to change the steps following the current step. So that the user will see the new steps they will be taking as part of thier choice in the wizard.
Parameters:
  newSteps - collection of steps to modify after the current step.




warn
public void warn(Object message, Throwable error)(Code)
Logs warning messages and supplementary exception.


Parameters:
  message - warning message to log.
Parameters:
  error - exception associated with the message.




warn
public void warn(Object message)(Code)
Logs warning messages.


Parameters:
  message - warning information to log.




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.