org.primordion.xholon.io

Interface IXholon2Gui

All Known Implementing Classes:

Xholon2Svg, Xholon2Svg

public interface IXholon2Gui

Any node in an executing Xholon model can generate its own GUI.

Since:

0.7.1 (Created on October 21, 2007)

See Also:

Xholon Project website

Field Summary

Fields

Modifier and Type	Field and Description
static int	GUI_TYPE_CONTOUR
static int	GUI_TYPE_DOMAINSPECIFIC
static int	GUI_TYPE_NONE
static int	GUI_TYPE_ROOTONLY
static int	GUI_TYPE_TREE

Method Summary

Methods

Modifier and Type	Method and Description
boolean	initialize(java.lang.Object out, java.lang.String modelName, IXholon root) Initialize.
void	setParams(java.lang.String params) Set various run time parameters for generating and launching a GUI.
void	writeAll() Write out all parts of the GUI file.

Field Detail

GUI_TYPE_NONE

static final int GUI_TYPE_NONE

See Also:

Constant Field Values

GUI_TYPE_TREE

static final int GUI_TYPE_TREE

See Also:

Constant Field Values

GUI_TYPE_CONTOUR

static final int GUI_TYPE_CONTOUR

See Also:

Constant Field Values

GUI_TYPE_ROOTONLY

static final int GUI_TYPE_ROOTONLY

See Also:

Constant Field Values

GUI_TYPE_DOMAINSPECIFIC

static final int GUI_TYPE_DOMAINSPECIFIC

See Also:

Constant Field Values

Method Detail

initialize

boolean initialize(java.lang.Object out,
                 java.lang.String modelName,
                 IXholon root)

Initialize.

Parameters:

out - Name of the output GUI file, or an instance of Writer, or another type of output object.

modelName - Name of the model.

root - Root of the hierarchy to write out (composite or inheritance structure).

Returns:

Whether or not the initialization succeeded.

setParams

void setParams(java.lang.String params)

Set various run time parameters for generating and launching a GUI.

Parameters:

params - A String containing a comma delimited series of parameters. The parameters, in their proper order, are:

guiPathName guiType widthInPixels webSite shouldShowDescription shouldShowStateMachineEntities shouldLaunchGui

ex: ./gui/,1,200,file:///C:/Xholon/gui/,true,false,true

ex: /jetty-6.1.5/webapps/xholon/,2,200,http://localhost:8080/xholon/,false,false,true

writeAll

void writeAll()

Write out all parts of the GUI file.