Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse JDT
Release 3.5

org.eclipse.jdt.ui.wizards
Class NewPackageWizardPage

java.lang.Object
  extended by 

org.eclipse.jface.dialogs.DialogPage
      extended by 

org.eclipse.jface.wizard.WizardPage
          extended by 

org.eclipse.jdt.ui.wizards.NewElementWizardPage
              extended by 

org.eclipse.jdt.ui.wizards.NewContainerWizardPage
                  extended by 
org.eclipse.jdt.ui.wizards.NewPackageWizardPage
All Implemented Interfaces:
IDialogPage, IMessageProvider, IWizardPage

public class NewPackageWizardPage
extends NewContainerWizardPage

Wizard page to create a new package.

Note: This class is not intended to be subclassed, but clients can instantiate. To implement a different kind of a new package wizard page, extend NewContainerWizardPage.

Since:
2.0
Restriction:
This class is not intended to be subclassed by clients.

Field Summary
 
Fields inherited from class org.eclipse.jdt.ui.wizards. NewContainerWizardPage
CONTAINER, fContainerStatus
 
Fields inherited from interface org.eclipse.jface.dialogs. IMessageProvider
ERROR, INFORMATION, NONE, WARNING
 
Constructor Summary
NewPackageWizardPage ()
          Creates a new NewPackageWizardPage
 
Method Summary
 void createControl ( Composite parent)
           
 void createPackage ( IProgressMonitor monitor)
          Creates the new package using the entered field values.
  IResource getModifiedResource ()
          Returns the resource handle that corresponds to the element to was created or will be created.
  IPackageFragment getNewPackageFragment ()
          Returns the created package fragment.
  String getPackageText ()
          Returns the content of the package input field.
  IRunnableWithProgress getRunnable ()
          Returns a runnable that creates a package using the current settings.
protected  void handleFieldChanged ( String fieldName)
          Hook method that gets called when a field on this page has changed.
 void init ( IStructuredSelection selection)
          The wizard owning this page is responsible for calling this method with the current selection.
protected  void setFocus ()
          Sets the focus to the package name input field.
 void setPackageText ( String str, boolean canBeModified)
          Sets the content of the package input field to the given value.
 void setVisible (boolean visible)
           
 
Methods inherited from class org.eclipse.jdt.ui.wizards. NewContainerWizardPage
chooseContainer, containerChanged, createContainerControls, getContainerLabel, getCurrentTextSelection, getInitialJavaElement, getJavaProject, getMaxFieldWidth, getPackageFragmentRoot, getPackageFragmentRootText, getWorkspaceRoot, initContainerPage, setFocusOnContainer, setPackageFragmentRoot
 
Methods inherited from class org.eclipse.jdt.ui.wizards. NewElementWizardPage
updateStatus, updateStatus
 
Methods inherited from class org.eclipse.jface.wizard. WizardPage
canFlipToNextPage, getContainer, getDialogSettings, getImage, getName, getNextPage, getPreviousPage, getShell, getWizard, isCurrentPage, isPageComplete, setDescription, setErrorMessage, setImageDescriptor, setMessage, setPageComplete, setPreviousPage, setTitle, setWizard, toString
 
Methods inherited from class org.eclipse.jface.dialogs. DialogPage
convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, dispose, getControl, getDescription, getDialogFontName, getErrorMessage, getFont, getMessage, getMessageType, getTitle, getToolTipText, initializeDialogUnits, isControlCreated, performHelp, setButtonLayoutData, setControl, setMessage
 
Methods inherited from class java.lang. Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.eclipse.jface.dialogs. IDialogPage
dispose, getControl, getDescription, getErrorMessage, getMessage, getTitle, performHelp
 

Constructor Detail

NewPackageWizardPage

public NewPackageWizardPage()
Creates a new NewPackageWizardPage

Method Detail

init

public void init(
IStructuredSelection selection)
The wizard owning this page is responsible for calling this method with the current selection. The selection is used to initialize the fields of the wizard page.

Parameters:
selection - used to initialize the fields

createControl

public void createControl(
Composite parent)

setVisible

public void setVisible(boolean visible)
Specified by:
setVisible in interface IDialogPage
Overrides:
setVisible in class NewElementWizardPage
See Also:
IDialogPage.setVisible(boolean)

setFocus

protected void setFocus()
Sets the focus to the package name input field.


handleFieldChanged

protected void handleFieldChanged(
String fieldName)
Description copied from class: NewContainerWizardPage
Hook method that gets called when a field on this page has changed. For this page the method gets called when the source folder field changes.

Every sub type is responsible to call this method when a field on its page has changed. Subtypes override (extend) the method to add verification when a own field has a dependency to an other field. For example the class name input must be verified again when the package field changes (check for duplicated class names).

Overrides:
handleFieldChanged in class NewContainerWizardPage
Parameters:
fieldName - The name of the field that has changed (field id). For the source folder the field id is CONTAINER

getPackageText

public 
String getPackageText()
Returns the content of the package input field.

Returns:
the content of the package input field

setPackageText

public void setPackageText(
String str,
                           boolean canBeModified)
Sets the content of the package input field to the given value.

Parameters:
str - the new package input field text
canBeModified - if true the package input field can be modified; otherwise it is read-only.

getModifiedResource

public 
IResource getModifiedResource()
Returns the resource handle that corresponds to the element to was created or will be created.

Returns:
A resource or null if the page contains illegal values.
Since:
3.0

getRunnable

public 
IRunnableWithProgress getRunnable()
Returns a runnable that creates a package using the current settings.

Returns:
the runnable that creates the new package

getNewPackageFragment

public 
IPackageFragment getNewPackageFragment()
Returns the created package fragment. This method only returns a valid value after getRunnable or createPackage have been executed.

Returns:
the created package fragment

createPackage

public void createPackage(
IProgressMonitor monitor)
                   throws 
CoreException,
                          
InterruptedException
Creates the new package using the entered field values.

Parameters:
monitor - a progress monitor to report progress. The progress monitor must not be null
Throws:
CoreException - Thrown if creating the package failed.
InterruptedException - Thrown when the operation has been canceled.
Since:
2.1

Eclipse JDT
Release 3.5

Copyright (c) IBM Corp. and others 2000, 2008. All Rights Reserved.

 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire