types
Class GUIFile

java.lang.Object
  types.GUIFile

public abstract class GUIFile
extends Object

The GUI definition file.

Nested Class Summary

static class	GUIFile.EventHandler A handler declared in the GUI file as part of the controller.
static class	GUIFile.Flag The enumeration type of flags set in the file.

Field Summary

String	filename The filename of the original source file.
Set<GUIFile.Flag>	flags The set of flags that are set in the file.
List<? extends GUIFile.EventHandler>	handlers A list of the handlers declared in the file.
List<? extends Widget>	widgets A list of all the widgets defined in the file.

Constructor Summary

protected

GUIFile(String filename, List<? extends Widget> widgets, Set<GUIFile.Flag> flags, List<? extends GUIFile.EventHandler> handlers)

Method Summary

abstract String	getControllerId()
abstract String	getPackageId()
abstract String	getProjectName()
protected abstract void	setControllerId(String controllerId) Set the identifier for the controller class to be generated.
abstract void	setPackageId(String packageId) Set the package identifier for generated files.
abstract void	setProjectName(String projectName) Set the identifier of the generated class.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

filename

public final String filename

The filename of the original source file.

widgets

public final List<? extends Widget> widgets

A list of all the widgets defined in the file. Immutable.

flags

public final Set<GUIFile.Flag> flags

The set of flags that are set in the file. May be changed if needed, as by command-line arguments.

handlers

public final List<? extends GUIFile.EventHandler> handlers

A list of the handlers declared in the file.

Constructor Detail

GUIFile

protected GUIFile(String filename,
                  List<? extends Widget> widgets,
                  Set<GUIFile.Flag> flags,
                  List<? extends GUIFile.EventHandler> handlers)

Parameters:

filename - The name of the original file.

widgets - The list to be used for widgets.

flags - The set to be used for flags.

handlers - The list to be used for handlers.

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getControllerId

public abstract String getControllerId()

Returns:

The identifier of the controller class to be generated.

setControllerId

protected abstract void setControllerId(String controllerId)

Set the identifier for the controller class to be generated.

Parameters:

controllerId - The new identifier.

getPackageId

public abstract String getPackageId()

Returns:

The package identifier for generated files.

setPackageId

public abstract void setPackageId(String packageId)

Set the package identifier for generated files.

Parameters:

packageId - The new package identifier.

getProjectName

public abstract String getProjectName()

Returns:

The identifier of the generated class.

setProjectName

public abstract void setProjectName(String projectName)

Set the identifier of the generated class.

Parameters:

projectName - The new identifier.