Java Doc for WizardPreferencesPage.java in  » IDE-Eclipse » ui-workbench » org » eclipse » ui » internal » wizards » preferences » 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 Eclipse » ui workbench » org.eclipse.ui.internal.wizards.preferences 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.eclipse.ui.internal.wizards.preferences.WizardPreferencesPage

All known Subclasses:   org.eclipse.ui.internal.wizards.preferences.WizardPreferencesImportPage1,  org.eclipse.ui.internal.wizards.preferences.WizardPreferencesExportPage1,
WizardPreferencesPage
abstract public class WizardPreferencesPage extends WizardPage implements Listener,IOverwriteQuery(Code)
Base class for preference export/import pages.
since:
   3.1


Field Summary
final protected static  intCOMBO_HISTORY_LENGTH
    
protected  ButtonchooseImportsButton
    
protected  CombodestinationNameField
    
protected  Texttext
    
protected  TabletransfersTable
    

Constructor Summary
protected  WizardPreferencesPage(String pageName)
    

Method Summary
protected  voidaddDestinationItem(String value)
    
protected  String[]addToHistory(String[] history, String newEntry)
     Adds an entry to a history, while taking care of duplicate history items and excessively long histories.
protected  voidaddToHistory(List history, String newEntry)
     Adds an entry to a history, while taking care of duplicate history items and excessively long histories.
protected  booleanallowNewContainerName()
    
protected  ButtoncreateButton(Composite parent, int id, String label, boolean defaultButton)
     Creates a new button with the given id.

The Dialog implementation of this framework method creates a standard push button, registers for selection events including button presses and registers default buttons with its shell.

public  voidcreateControl(Composite parent)
     (non-Javadoc) Method declared on IDialogPage.
protected  voidcreateDestinationGroup(Composite parent)
    
protected  voidcreateOptionsGroup(Composite parent)
     Create the export options specification widgets.
abstract protected  voidcreateTransferArea(Composite composite)
    
protected  voidcreateTransfersList(Composite composite)
    
protected  booleandeterminePageCompletion()
     Returns whether this page is complete.
public  voiddispose()
    
protected  booleanensureDirectoryExists(File directory)
     Attempts to ensure that the specified directory exists on the local file system.
protected  booleanensureTargetIsValid(File file)
     If the target for export does not exist then attempt to create it.
public  booleanfinish()
     The Finish button was pressed.
abstract protected  StringgetAllButtonText()
    
abstract protected  StringgetChooseButtonText()
    
abstract protected  StringgetDestinationLabel()
    
protected  StringgetDestinationValue()
    
abstract protected  intgetFileDialogStyle()
    
abstract protected  StringgetFileDialogTitle()
    
protected  IPreferenceFilter[]getFilters()
    
abstract protected  StringgetInvalidDestinationMessage()
     Return the message that indicates an invalid destination.
protected  PreferenceTransferElement[]getPreferenceTransferElements()
    
protected  PreferenceTransferElement[]getTransfers()
    
protected  voidgiveFocusToDestination()
    
protected  voidhandleDestinationBrowseButtonPressed()
    
public  voidhandleEvent(Event e)
    
protected  voidinternalSaveWidgetValues()
     Hook method for saving widget values for restoration by the next instance of this class.
public  StringqueryOverwrite(String pathString)
     The WizardDataTransfer implementation of this IOverwriteQuery method asks the user whether the existing resource at the given path should be overwritten.
protected  booleanqueryYesNoQuestion(String message)
     Displays a Yes/No question to the user with the specified message and returns the user's response.
protected  voidrestoreWidgetValues()
     Hook method for restoring widget values to the values that they held last time this wizard was used to completion.
protected  voidsaveWidgetValues()
    
protected  voidsetAllChecked(boolean bool)
    
protected  voidsetDestinationValue(String value)
    
public  voidsetPageComplete()
    
protected  voidsetPreferenceTransfers()
    
abstract protected  booleantransfer(IPreferenceFilter[] transfers)
    
protected  voidupdatePageCompletion()
     Determine if the page is complete and update the page appropriately.
protected  booleanvalidDestination()
    
protected  booleanvalidateDestinationGroup()
     Validate the destination group. true if the group is valid.
protected  booleanvalidateOptionsGroup()
     Returns whether this page's options group's controls currently all contain valid values.

The WizardPreferencesPage implementation of this method returns true if the button to transfer all preferences is selected OR at least one of the individual items are checked.

protected  booleanvalidateSourceGroup()
     Returns whether this page's source specification controls currently all contain valid values.

The WizardDataTransferPage implementation of this method returns true.


Field Detail
COMBO_HISTORY_LENGTH
final protected static int COMBO_HISTORY_LENGTH(Code)



chooseImportsButton
protected Button chooseImportsButton(Code)



destinationNameField
protected Combo destinationNameField(Code)



text
protected Text text(Code)



transfersTable
protected Table transfersTable(Code)




Constructor Detail
WizardPreferencesPage
protected WizardPreferencesPage(String pageName)(Code)

Parameters:
  pageName -




Method Detail
addDestinationItem
protected void addDestinationItem(String value)(Code)
Add the passed value to self's destination widget's history
Parameters:
  value - java.lang.String



addToHistory
protected String[] addToHistory(String[] history, String newEntry)(Code)
Adds an entry to a history, while taking care of duplicate history items and excessively long histories. The assumption is made that all histories should be of length WizardDataTransferPage.COMBO_HISTORY_LENGTH.
Parameters:
  history - the current history
Parameters:
  newEntry - the entry to add to the history



addToHistory
protected void addToHistory(List history, String newEntry)(Code)
Adds an entry to a history, while taking care of duplicate history items and excessively long histories. The assumption is made that all histories should be of length WizardDataTransferPage.COMBO_HISTORY_LENGTH.
Parameters:
  history - the current history
Parameters:
  newEntry - the entry to add to the history



allowNewContainerName
protected boolean allowNewContainerName()(Code)



createButton
protected Button createButton(Composite parent, int id, String label, boolean defaultButton)(Code)
Creates a new button with the given id.

The Dialog implementation of this framework method creates a standard push button, registers for selection events including button presses and registers default buttons with its shell. The button id is stored as the buttons client data. Note that the parent's layout is assumed to be a GridLayout and the number of columns in this layout is incremented. Subclasses may override.


Parameters:
  parent - the parent composite
Parameters:
  id - the id of the button (see IDialogConstants.*_IDconstants for standard dialog button ids)
Parameters:
  label - the label from the button
Parameters:
  defaultButton - true if the button is to be the default button,and false otherwise



createControl
public void createControl(Composite parent)(Code)
(non-Javadoc) Method declared on IDialogPage.



createDestinationGroup
protected void createDestinationGroup(Composite parent)(Code)
Create the export destination specification widgets
Parameters:
  parent - org.eclipse.swt.widgets.Composite



createOptionsGroup
protected void createOptionsGroup(Composite parent)(Code)
Create the export options specification widgets.
Parameters:
  parent - org.eclipse.swt.widgets.Composite



createTransferArea
abstract protected void createTransferArea(Composite composite)(Code)

Parameters:
  composite -



createTransfersList
protected void createTransfersList(Composite composite)(Code)

Parameters:
  composite -



determinePageCompletion
protected boolean determinePageCompletion()(Code)
Returns whether this page is complete. This determination is made based upon the current contents of this page's controls. Subclasses wishing to include their controls in this determination should override the hook methods validateSourceGroup and/or validateOptionsGroup. true if this page is complete, andfalse if incomplete
See Also:   WizardPreferencesPage.validateSourceGroup
See Also:   WizardPreferencesPage.validateOptionsGroup



dispose
public void dispose()(Code)



ensureDirectoryExists
protected boolean ensureDirectoryExists(File directory)(Code)
Attempts to ensure that the specified directory exists on the local file system. Answers a boolean indicating success. boolean
Parameters:
  directory - java.io.File



ensureTargetIsValid
protected boolean ensureTargetIsValid(File file)(Code)
If the target for export does not exist then attempt to create it. Answer a boolean indicating whether the target exists (ie.- if it either pre-existed or this method was able to create it) boolean



finish
public boolean finish()(Code)
The Finish button was pressed. Try to do the required work now and answer a boolean indicating success. If false is returned then the wizard will not close. boolean



getAllButtonText
abstract protected String getAllButtonText()(Code)



getChooseButtonText
abstract protected String getChooseButtonText()(Code)



getDestinationLabel
abstract protected String getDestinationLabel()(Code)
Answer the string to display in self as the destination type java.lang.String



getDestinationValue
protected String getDestinationValue()(Code)
Answer the contents of self's destination specification widget java.lang.String



getFileDialogStyle
abstract protected int getFileDialogStyle()(Code)



getFileDialogTitle
abstract protected String getFileDialogTitle()(Code)



getFilters
protected IPreferenceFilter[] getFilters()(Code)
the preference transfer filters



getInvalidDestinationMessage
abstract protected String getInvalidDestinationMessage()(Code)
Return the message that indicates an invalid destination. String



getPreferenceTransferElements
protected PreferenceTransferElement[] getPreferenceTransferElements()(Code)
the list of transfer elements



getTransfers
protected PreferenceTransferElement[] getTransfers()(Code)



giveFocusToDestination
protected void giveFocusToDestination()(Code)
Set the current input focus to self's destination entry field



handleDestinationBrowseButtonPressed
protected void handleDestinationBrowseButtonPressed()(Code)
Open an appropriate destination browser so that the user can specify a source to import from



handleEvent
public void handleEvent(Event e)(Code)
Handle all events and enablements for widgets in this page
Parameters:
  e - Event



internalSaveWidgetValues
protected void internalSaveWidgetValues()(Code)
Hook method for saving widget values for restoration by the next instance of this class.



queryOverwrite
public String queryOverwrite(String pathString)(Code)
The WizardDataTransfer implementation of this IOverwriteQuery method asks the user whether the existing resource at the given path should be overwritten.
Parameters:
  pathString - the user's reply: one of "YES", "NO","ALL", or "CANCEL"



queryYesNoQuestion
protected boolean queryYesNoQuestion(String message)(Code)
Displays a Yes/No question to the user with the specified message and returns the user's response.
Parameters:
  message - the question to ask true for Yes, and false for No



restoreWidgetValues
protected void restoreWidgetValues()(Code)
Hook method for restoring widget values to the values that they held last time this wizard was used to completion.



saveWidgetValues
protected void saveWidgetValues()(Code)



setAllChecked
protected void setAllChecked(boolean bool)(Code)

Parameters:
  bool -



setDestinationValue
protected void setDestinationValue(String value)(Code)
Set the contents of self's destination specification widget to the passed value
Parameters:
  value - java.lang.String



setPageComplete
public void setPageComplete()(Code)
Check whether the internal state of the page is complete and update the dialog



setPreferenceTransfers
protected void setPreferenceTransfers()(Code)



transfer
abstract protected boolean transfer(IPreferenceFilter[] transfers)(Code)

Parameters:
  transfers - boolean



updatePageCompletion
protected void updatePageCompletion()(Code)
Determine if the page is complete and update the page appropriately.



validDestination
protected boolean validDestination()(Code)



validateDestinationGroup
protected boolean validateDestinationGroup()(Code)
Validate the destination group. true if the group is valid. Ifnot set the error message and return false.



validateOptionsGroup
protected boolean validateOptionsGroup()(Code)
Returns whether this page's options group's controls currently all contain valid values.

The WizardPreferencesPage implementation of this method returns true if the button to transfer all preferences is selected OR at least one of the individual items are checked. Subclasses may reimplement this method.

true indicating validity of all controls in theoptions group



validateSourceGroup
protected boolean validateSourceGroup()(Code)
Returns whether this page's source specification controls currently all contain valid values.

The WizardDataTransferPage implementation of this method returns true. Subclasses may reimplement this hook method.

true indicating validity of all controls in thesource specification group



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