Enhydra 5.1 API

org.enhydra.tool.codegen.wizard
Class CodeGenWizard

java.lang.Object
  |
  +--org.enhydra.tool.common.DialogHandler
        |
        +--org.enhydra.tool.common.wizard.TBWizard
              |
              +--org.enhydra.tool.codegen.wizard.CodeGenWizard
All Implemented Interfaces:
java.util.EventListener, FirstFocusListener, RootEditor

public class CodeGenWizard
extends TBWizard
implements RootEditor

The CodeGenDialog defines a default container for presenting wizards. To use this class you need to a create one or more CodeGenPage objects and add them to this dialog. This dialog supplies action buttons for the Previous, Next, Finish, Cancel and Help.

This class is used when creating a standalone wizard. Use the OpenTools BasicWizard when developing JBuilder add-ins.


Field Summary
 
Fields inherited from class org.enhydra.tool.common.DialogHandler
res
 
Constructor Summary
CodeGenWizard()
           
CodeGenWizard(CodeGen cg)
           
 
Method Summary
 void addSelectionListener(GenSelectionListener l)
           
 void back()
           
protected  void clearAll()
          Clear all object references.
 void finish()
           
 CodeGen getCodeGen()
           
static java.lang.String getDefaultTitle()
           
 java.io.File[] getGeneratedFiles()
          Get an array of references to generated files.
 Generator[] getGenerators()
          Get the list of available generators.
protected  java.lang.String getProgressTitle()
           
 Generator getSelection()
          Get the generator selected by the user.
 java.lang.String getTitle()
           
 boolean isAllowRootEdit()
           
static void main(java.lang.String[] args)
           
 void next()
           
 void removeSelecitonListener(GenSelectionListener l)
           
 void setAllowRootEdit(boolean allow)
           
 void setCodeGen(CodeGen cd)
          Set the list of available generators.
 void setSelection(Generator selection)
          Set the selected generator for a user and by pass the selection page.
 
Methods inherited from class org.enhydra.tool.common.wizard.TBWizard
addWizardPage, cancel, createButtonListener, getButtonPanel, getDeck, getInnerPanel, getLargeIcon, onFirstFocus, refreshButtons, setDeck, setLargeIcon
 
Methods inherited from class org.enhydra.tool.common.DialogHandler
addHelpListener, closeWindow, getOption, getProgressMeter, notifyHelpListeners, openProgress, removeHelpListener, setOption, showAbout, showDialog
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CodeGenWizard

public CodeGenWizard(CodeGen cg)

CodeGenWizard

public CodeGenWizard()
              throws GeneratorException
Method Detail

main

public static void main(java.lang.String[] args)

isAllowRootEdit

public boolean isAllowRootEdit()
Specified by:
isAllowRootEdit in interface RootEditor

setAllowRootEdit

public void setAllowRootEdit(boolean allow)
Specified by:
setAllowRootEdit in interface RootEditor

getGeneratedFiles

public java.io.File[] getGeneratedFiles()
Get an array of references to generated files.

Returns:
An array of generated files. May have a zero length or be null if no files have been generated.

getGenerators

public Generator[] getGenerators()
Get the list of available generators.

Returns:
An array of generators from which a user can make a selection.

setCodeGen

public void setCodeGen(CodeGen cd)
Set the list of available generators.


getCodeGen

public CodeGen getCodeGen()

getSelection

public Generator getSelection()
Get the generator selected by the user.

Returns:
The generator to show options for and to use for generating a project.

setSelection

public void setSelection(Generator selection)
                  throws GeneratorException
Set the selected generator for a user and by pass the selection page.

Parameters:
selection - A generator containing option pages.
Throws:
GeneratorException - Thrown if unable to create option pages for the selection.

back

public void back()
Overrides:
back in class TBWizard

next

public void next()
Overrides:
next in class TBWizard

finish

public void finish()
Overrides:
finish in class TBWizard

getDefaultTitle

public static java.lang.String getDefaultTitle()

clearAll

protected void clearAll()
Description copied from class: TBWizard
Clear all object references.

Overrides:
clearAll in class TBWizard

getTitle

public java.lang.String getTitle()
Specified by:
getTitle in class DialogHandler

getProgressTitle

protected java.lang.String getProgressTitle()
Specified by:
getProgressTitle in class DialogHandler

addSelectionListener

public void addSelectionListener(GenSelectionListener l)

removeSelecitonListener

public void removeSelecitonListener(GenSelectionListener l)

Enhydra 5.1 API