All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sun.wizards.builder.resolver.WizardCreator

java.lang.Object
   |
   +----com.sun.wizards.builder.resolver.WizardCreator

public class WizardCreator

extends Object

WizardCreator(ResourceResolver)

Creates a wizard with the specified default resolver

addCollection(ResourceCollection)

Adds a collection to this wizard creator, to be written into the archive.

addResource(String, ResourceWriter)

Adds a resource to the archive. Deprecated.

getArchiveName()

Returns the name of this wizard archive (without the ".class" extension)

getBaselineImage()

Gqets the name of the baselineImage to be included in this wizard.

getFileNames(String, String[])

Returns filename (without paths or extensions) of all files with the specified extensions from the specified path

getIcon()

Gets the name of the icon to be included in this wizard.

getImage()

Gets the name of the image to be included in this wizard.

getRoot()

Returns the WizardComposite object that is the root of the client tree.

getWizardRuntimeClasspath()

getWizardRuntimeClasspath looks at the classpath for the wizard class files.

getWizardState()

Returns the WizardState object that will be written into the wizard archive.

setArchiveName(String)

Sets the name of this archive, omitting the ".class" extension.

setBaselineImage(String)

Sets the baselineImage for this product.

setCancelMsg(Msg)

Set the text that will appear when the user clicks the 'cancel' button

setExitMsg(Msg)

Set the text that will appear when the user clicks the 'exit' button

setIcon(String)

Sets the icon for this product.

setImage(String)

Sets the image for this wizard.

setRoot(WizardComposite)

Sets the WizardComposite object that will be the root of the client panel tree.

setWizardState(WizardState)

Sets the WizardState object that will be written into the wizard archive.

writeArchive(File)

Writes the wizard archive to the specified output stream.

 public WizardCreator(ResourceResolver resolver)

Creates a wizard with the specified default resolver

Parameters:

resolver - The resolver to use for resources that are not assigned a particular resolver.

 public void addCollection(ResourceCollection collection)

Adds a collection to this wizard creator, to be written into the archive.

Parameters:

collection - The collection to add to the wizard.

 public void addResource(String name,
                         ResourceWriter writer)

Note: addResource() is deprecated.

Adds a resource to the archive. The resource will be called (through the ResourceWriter interface) to write its contents into the archive.

Parameters:

name - The name of the resource to add.

writer - The writer responsible for writing the resource bits.

 public void setImage(String imageName)

Sets the image for this wizard. The image will appear on the left side of the wizard. It should be specified in wizard resource form ([packageName].[imagename_without_extension]). It is recommended that this image be 120 pixels wide x 290 pixels long. Make sure you include your image in the resource collections (by overriding setResources()) or your image will not be included in the archive!

Parameters:

imageName - The name of the image, in wizard resource form.

 public WizardState getWizardState()

Returns the WizardState object that will be written into the wizard archive.

Returns:

The WizardState to be written into the wizard archive.

 public void setWizardState(WizardState state)

Sets the WizardState object that will be written into the wizard archive.

Parameters:

state - The state to be used to write into the wizard archive

 public WizardComposite getRoot()

Returns the WizardComposite object that is the root of the client tree.

Returns:

The WizardComposite to be written into the wizard archive, or null if none has been set.

 public void setRoot(WizardComposite root)

Sets the WizardComposite object that will be the root of the client panel tree. wizard archive.

Parameters:

root - The root of the client panel tree

 public String getArchiveName()

Returns the name of this wizard archive (without the ".class" extension)

Returns:

the name of this wizard archive (without the ".class" extension)

 public void setArchiveName(String archiveName)

Sets the name of this archive, omitting the ".class" extension.

Parameters:

archiveName - The name of this archive

 public String getImage()

Gets the name of the image to be included in this wizard.

Returns:

The name of the image.

 public void setIcon(String iconName)

Sets the icon for this product. The icon will appear on the left side of the wizard. It should be specified in wizard resource form ([packageName].[imagename_without_extension]) Make sure you include your image in the resource collections (by overriding setResources()) or your image will not be included in the archive!

Parameters:

iconName - The name of the icon, in wizard resource form. It is recommended that this image be 48 pixels square.

 public String getIcon()

Gets the name of the icon to be included in this wizard.

Returns:

The name of the icon.

 public void setBaselineImage(String baselineImage)

Sets the baselineImage for this product. The baselineImage will appear below the console image on the left side of the wizard. It should be specified in wizard resource form ([packageName].[imagename_without_extension]). It is recommended that this image be 120 pixels wide x 30 pixels long.Make sure you include your image in the resource collections (by overriding setResources()) or your image will not be included in the archive!

Parameters:

baselineImage - The name of the baselineImage, in wizard resource form.

 public String getBaselineImage()

Gqets the name of the baselineImage to be included in this wizard.

Returns:

The name of the baselineImage.

 public void setExitMsg(Msg exitMsg)

Set the text that will appear when the user clicks the 'exit' button

Parameters:

exitMsg - The localized Msg that should appear when the user presses the "Exit" Button. If no text is supplied via this method, then the wizard will not prompt the user when the exit button is pressed, and simply exit. If text is supplied, it will be localized at runtime Using the correct locale resource bundle, by using the Msg class to produce the desired localized text.

See Also:

Msg

 public void setCancelMsg(Msg cancelMsg)

Set the text that will appear when the user clicks the 'cancel' button

Parameters:

cancelMsg - The localized Msg that should appear when the user presses the "Cancel" Button. If no text is supplied via this method, then the wizard will not prompt the user when the cancel button is pressed, and simply cancel whatever it was doing at the time. If text is supplied, it will be localized using the correct runtime locale resource bundle and the supplied key.

See Also:

Msg

 public String getWizardRuntimeClasspath()

getWizardRuntimeClasspath looks at the classpath for the wizard class files.

Returns:

The absolute pathname of the specified class.

 public static String[] getFileNames(String path,
                                     String exts[])

Returns filename (without paths or extensions) of all files with the specified extensions from the specified path

Parameters:

path - The path to the files.

exts - The file extensions to look for.

 public void writeArchive(File archiveFile)

Writes the wizard archive to the specified output stream.

Parameters:

out - The stream to write the wizard to. Classes using this Class should set up an output stream first, then call this method.

All Packages  Class Hierarchy  This Package  Previous  Next  Index