ch.sahits.phpclassgenerator.wizards
Class PhpClassWizard

java.lang.Object
  org.eclipse.jface.wizard.Wizard
      ch.sahits.phpclassgenerator.wizards.PhpClassWizard

All Implemented Interfaces:

org.eclipse.jface.wizard.IWizard, org.eclipse.ui.INewWizard, org.eclipse.ui.IWorkbenchWizard

public class PhpClassWizard
extends org.eclipse.jface.wizard.Wizard
implements org.eclipse.ui.INewWizard

This is a sample new wizard. Its role is to create a new file resource in the provided container. If the container resource (a folder or a project) is selected in the workspace when the wizard is opened, it will accept it as the target container. The wizard creates one file with the extension "php". If a sample multi-page editor (also available as a template) is registered for the same extension, it will be able to open it. $Revision: 1.2 $ changed by $Author: hotzst $ at $Date: 2007/10/27 18:03:08 $

Field Summary

private CodeGenerator	cg
private PhpClassWizardDBPage	dbPage
private PhpClassWizardPage	page
private org.eclipse.jface.viewers.ISelection	selection

Fields inherited from class org.eclipse.jface.wizard.Wizard

DEFAULT_IMAGE

Constructor Summary

PhpClassWizard()
Constructor for PhpClassWizard.

Method Summary

void	addPages() Adding the page to the wizard.
private void	doFinish(java.lang.String containerName, java.lang.String fileName, java.lang.String templatePath, java.lang.String product, java.lang.String host, java.lang.String db, java.lang.String user, java.lang.String passwd, java.lang.String tableName, org.eclipse.core.runtime.IProgressMonitor monitor) The worker method.
private java.lang.String	exception2String(java.lang.Exception e)
void	init(org.eclipse.ui.IWorkbench workbench, org.eclipse.jface.viewers.IStructuredSelection selection) We will accept the selection in the workbench to see if we can initialize from it.
private java.io.InputStream	openContentStream() We will initialize file contents with a sample text.
boolean	performFinish() This method is called when 'Finish' button is pressed in the wizard.
private void	throwCoreException(java.lang.String message)

Methods inherited from class org.eclipse.jface.wizard.Wizard

addPage, canFinish, createPageControls, dispose, getContainer, getDefaultPageImage, getDialogSettings, getNextPage, getPage, getPageCount, getPages, getPreviousPage, getShell, getStartingPage, getTitleBarColor, getWindowTitle, isHelpAvailable, needsPreviousAndNextButtons, needsProgressMonitor, performCancel, setContainer, setDefaultPageImageDescriptor, setDialogSettings, setForcePreviousAndNextButtons, setHelpAvailable, setNeedsProgressMonitor, setTitleBarColor, setWindowTitle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.jface.wizard.IWizard

canFinish, createPageControls, dispose, getContainer, getDefaultPageImage, getDialogSettings, getNextPage, getPage, getPageCount, getPages, getPreviousPage, getStartingPage, getTitleBarColor, getWindowTitle, isHelpAvailable, needsPreviousAndNextButtons, needsProgressMonitor, performCancel, setContainer

Field Detail

page

private PhpClassWizardPage page

dbPage

private PhpClassWizardDBPage dbPage

selection

private org.eclipse.jface.viewers.ISelection selection

cg

private CodeGenerator cg

Constructor Detail

PhpClassWizard

public PhpClassWizard()

Constructor for PhpClassWizard.

Method Detail

addPages

public void addPages()

Adding the page to the wizard.

Specified by:

addPages in interface org.eclipse.jface.wizard.IWizard

Overrides:

addPages in class org.eclipse.jface.wizard.Wizard

performFinish

public boolean performFinish()

This method is called when 'Finish' button is pressed in the wizard. We will create an operation and run it using wizard as execution context.

Specified by:

performFinish in interface org.eclipse.jface.wizard.IWizard

Specified by:

performFinish in class org.eclipse.jface.wizard.Wizard

Returns:

true if all actions could be completed

doFinish

private void doFinish(java.lang.String containerName,
                      java.lang.String fileName,
                      java.lang.String templatePath,
                      java.lang.String product,
                      java.lang.String host,
                      java.lang.String db,
                      java.lang.String user,
                      java.lang.String passwd,
                      java.lang.String tableName,
                      org.eclipse.core.runtime.IProgressMonitor monitor)
               throws org.eclipse.core.runtime.CoreException

The worker method. It will find the container, create the file if missing or just replace its contents, and open the editor on the newly created file.

Parameters:

tableName -

passwd -

user -

db -

host -

product -

templatePath -

Throws:

org.eclipse.core.runtime.CoreException

openContentStream

private java.io.InputStream openContentStream()

We will initialize file contents with a sample text.

throwCoreException

private void throwCoreException(java.lang.String message)
                         throws org.eclipse.core.runtime.CoreException

Throws:

org.eclipse.core.runtime.CoreException

init

public void init(org.eclipse.ui.IWorkbench workbench,
                 org.eclipse.jface.viewers.IStructuredSelection selection)

We will accept the selection in the workbench to see if we can initialize from it.

Specified by:

init in interface org.eclipse.ui.IWorkbenchWizard

See Also:

IWorkbenchWizard.init(IWorkbench, IStructuredSelection)

exception2String

private java.lang.String exception2String(java.lang.Exception e)