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
Answertopia.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.junit.wizards
Class NewTestCaseWizardPageOne


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.NewTypeWizardPage
                      extended by 
org.eclipse.jdt.junit.wizards.NewTestCaseWizardPageOne
All Implemented Interfaces:
IDialogPage, IMessageProvider, IWizardPage

public class NewTestCaseWizardPageOne
extends NewTypeWizardPage

The class NewTestCaseWizardPageOne contains controls and validation routines for the first page of the 'New JUnit TestCase Wizard'.

Clients can use the page as-is and add it to their own wizard, or extend it to modify validation or add and remove controls.

Since:
3.1

Nested Class Summary
 
Nested classes/interfaces inherited from class org.eclipse.jdt.ui.wizards. NewTypeWizardPage
NewTypeWizardPage.ImportsManager
 
Field Summary
static  String CLASS_UNDER_TEST
          Field ID of the class under test field.
static  String JUNIT4TOGGLE
          Field ID of the Junit4 toggle
 
Fields inherited from class org.eclipse.jdt.ui.wizards. NewTypeWizardPage
ANNOTATION_TYPE, CLASS_TYPE, ENCLOSING, ENCLOSINGSELECTION, ENUM_TYPE, F_ABSTRACT, F_FINAL, F_PRIVATE, F_PROTECTED, F_PUBLIC, F_STATIC, fEnclosingTypeStatus, fModifierStatus, fPackageStatus, fSuperClassStatus, fSuperInterfacesStatus, fTypeNameStatus, INTERFACE_TYPE, INTERFACES, METHODS, MODIFIERS, PACKAGE, SUPER, TYPENAME
 
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
NewTestCaseWizardPageOne ( NewTestCaseWizardPageTwo page2)
          Creates a new NewTestCaseCreationWizardPage.
 
Method Summary
 boolean canFlipToNextPage ()
           
protected   IStatus classUnderTestChanged ()
          Hook method that gets called when the class under test has changed.
protected  void createBuildPathConfigureControls ( Composite composite, int nColumns)
          Creates the controls for the JUnit 4 toggle control.
protected  void createClassUnderTestControls ( Composite composite, int nColumns)
          Creates the controls for the 'class under test' field.
 void createControl ( Composite parent)
           
protected  void createJUnit4Controls ( Composite composite, int nColumns)
          Creates the controls for the JUnit 4 toggle control.
protected  void createMethodStubSelectionControls ( Composite composite, int nColumns)
          Creates the controls for the method stub selection buttons.
protected  void createTypeMembers ( IType type, NewTypeWizardPage.ImportsManager imports, IProgressMonitor monitor)
          Hook method that gets called from createType to support adding of unanticipated methods, fields, and inner types to the created type.
  IType getClassUnderTest ()
          Returns the class to be tested.
  String getClassUnderTestText ()
          Returns the content of the class to test text field.
protected   IStatus[] getStatusList ()
          Returns all status to be consider for the validation.
protected  void handleFieldChanged ( String fieldName)
          Hook method that gets called when a field on this page has changed.
 void init ( IStructuredSelection selection)
          Initialized the page with the current selection
 boolean isJUnit4 ()
          Returns true if the test should be created as Junit 4 test
protected   IStatus packageChanged ()
          A hook method that gets called when the package field has changed.
 void setClassUnderTest ( String name)
          Sets the name of the class under test.
 void setJUnit4 (boolean isJUnit4, boolean isEnabled)
          Specifies if the test should be created as JUnit 4 test.
 void setVisible (boolean visible)
           
protected   IStatus superClassChanged ()
          Hook method that gets called when the superclass name has changed.
protected   IStatus validateIfJUnitProject ()
          The method is called when the container has changed to validate if the project is suited for the JUnit test class.
 
Methods inherited from class org.eclipse.jdt.ui.wizards. NewTypeWizardPage
addSuperInterface, chooseEnclosingType, choosePackage, chooseSuperClass, chooseSuperInterfaces, constructCUContent, containerChanged, createCommentControls, createEnclosingTypeControls, createInheritedMethods, createModifierControls, createPackageControls, createSeparator, createSuperClassControls, createSuperInterfacesControls, createType, createTypeNameControls, enableCommentControl, enclosingTypeChanged, getCompilationUnitName, getCreatedType, getEnclosingType, getEnclosingTypeLabel, getEnclosingTypeText, getFileComment, getFileComment, getModifiedResource, getModifiers, getModifiersLabel, getPackageFragment, getPackageLabel, getPackageText, getRunnable, getSuperClass, getSuperClassLabel, getSuperInterfaces, getSuperInterfacesLabel, getTemplate, getTemplate, getTypeComment, getTypeComment, getTypeName, getTypeNameLabel, initTypePage, isAddComments, isEnclosingTypeSelected, modifiersChanged, setAddComments, setEnclosingType, setEnclosingTypeSelection, setFocus, setModifiers, setPackageFragment, setSuperClass, setSuperInterfaces, setTypeName, superInterfacesChanged, typeNameChanged
 
Methods inherited from class org.eclipse.jdt.ui.wizards. NewContainerWizardPage
chooseContainer, 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
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
 

Field Detail

CLASS_UNDER_TEST

public static final 
String CLASS_UNDER_TEST
Field ID of the class under test field.

See Also:
Constant Field Values

JUNIT4TOGGLE

public static final 
String JUNIT4TOGGLE
Field ID of the Junit4 toggle

Since:
3.2
See Also:
Constant Field Values
Constructor Detail

NewTestCaseWizardPageOne

public NewTestCaseWizardPageOne(
NewTestCaseWizardPageTwo page2)
Creates a new NewTestCaseCreationWizardPage.

Parameters:
page2 - The second page
Since:
3.1
Method Detail

init

public void init(
IStructuredSelection selection)
Initialized the page with the current selection

Parameters:
selection - The selection

setJUnit4

public void setJUnit4(boolean isJUnit4,
                      boolean isEnabled)
Specifies if the test should be created as JUnit 4 test.

Parameters:
isJUnit4 - If set, a Junit 4 test will be created
isEnabled - if true the modifier fields are editable; otherwise they are read-only
Since:
3.2

isJUnit4

public boolean isJUnit4()
Returns true if the test should be created as Junit 4 test

Returns:
returns true if the test should be created as Junit 4 test
Since:
3.2

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 NewTypeWizardPage
Parameters:
fieldName - The name of the field that has changed (field id). For the source folder the field id is CONTAINER

getStatusList

protected 
IStatus[] getStatusList()
Returns all status to be consider for the validation. Clients can override.

Returns:
The list of status to consider for the validation.

createControl

public void createControl(
Composite parent)

createMethodStubSelectionControls

protected void createMethodStubSelectionControls(
Composite composite,
                                                 int nColumns)
Creates the controls for the method stub selection buttons. Expects a GridLayout with at least 3 columns.

Parameters:
composite - the parent composite
nColumns - number of columns to span

createClassUnderTestControls

protected void createClassUnderTestControls(
Composite composite,
                                            int nColumns)
Creates the controls for the 'class under test' field. Expects a GridLayout with at least 3 columns.

Parameters:
composite - the parent composite
nColumns - number of columns to span

createJUnit4Controls

protected void createJUnit4Controls(
Composite composite,
                                    int nColumns)
Creates the controls for the JUnit 4 toggle control. Expects a GridLayout with at least 3 columns.

Parameters:
composite - the parent composite
nColumns - number of columns to span
Since:
3.2

createBuildPathConfigureControls

protected void createBuildPathConfigureControls(
Composite composite,
                                                int nColumns)
Creates the controls for the JUnit 4 toggle control. Expects a GridLayout with at least 3 columns.

Parameters:
composite - the parent composite
nColumns - number of columns to span
Since:
3.2

packageChanged

protected 
IStatus packageChanged()
Description copied from class: NewTypeWizardPage
A hook method that gets called when the package field has changed. The method validates the package name and returns the status of the validation. The validation also updates the package fragment model.

Subclasses may extend this method to perform their own validation.

Overrides:
packageChanged in class NewTypeWizardPage
Returns:
the status of the validation

classUnderTestChanged

protected 
IStatus classUnderTestChanged()
Hook method that gets called when the class under test has changed. The method class under test returns the status of the validation.

Subclasses may extend this method to perform their own validation.

Returns:
the status of the validation

getClassUnderTestText

public 
String getClassUnderTestText()
Returns the content of the class to test text field.

Returns:
the name of the class to test

getClassUnderTest

public 
IType getClassUnderTest()
Returns the class to be tested.

Returns:
the class under test or null if the entered values are not valid

setClassUnderTest

public void setClassUnderTest(
String name)
Sets the name of the class under test.

Parameters:
name - The name to set

createTypeMembers

protected void createTypeMembers(
IType type,
                                 
NewTypeWizardPage.ImportsManager imports,
                                 
IProgressMonitor monitor)
                          throws 
CoreException
Description copied from class: NewTypeWizardPage
Hook method that gets called from createType to support adding of unanticipated methods, fields, and inner types to the created type.

Implementers can use any methods defined on IType to manipulate the new type.

The source code of the new type will be formatted using the platform's formatter. Needed imports are added by the wizard at the end of the type creation process using the given import manager.

Overrides:
createTypeMembers in class NewTypeWizardPage
Parameters:
type - the new type created via createType
imports - an import manager which can be used to add new imports
monitor - a progress monitor to report progress. Must not be null
Throws:
CoreException - thrown when creation of the type members failed
See Also:
NewTypeWizardPage.createType(IProgressMonitor)

setVisible

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

validateIfJUnitProject

protected 
IStatus validateIfJUnitProject()
The method is called when the container has changed to validate if the project is suited for the JUnit test class. Clients can override to modify or remove that validation.

Returns:
the status of the validation

superClassChanged

protected 
IStatus superClassChanged()
Description copied from class: NewTypeWizardPage
Hook method that gets called when the superclass name has changed. The method validates the superclass name and returns the status of the validation.

Subclasses may extend this method to perform their own validation.

Overrides:
superClassChanged in class NewTypeWizardPage
Returns:
the status of the validation

canFlipToNextPage

public boolean canFlipToNextPage()
Specified by:
canFlipToNextPage in interface IWizardPage
Overrides:
canFlipToNextPage in class WizardPage

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