org.primordion.xholon.io

Class AbstractXholonGui

java.lang.Object

org.primordion.xholon.io.AbstractXholonGui

All Implemented Interfaces:

IXholonGui

Direct Known Subclasses:

XholonGuiClassic, XholonGuiD3CirclePack, XholonGuiForHtml5

public abstract class AbstractXholonGui
extends java.lang.Object
implements IXholonGui

Abstract base class for Xholon Gui implementations.

Since:

0.9.0 (Created on November 26, 2013)

See Also:

Xholon Project website

Constructor Summary

Constructors

Constructor and Description
AbstractXholonGui() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	execModel(java.lang.String mName, IApplication app) Execute a model.
java.lang.String	getModelName() Get name of the model.
IXholon	getXholonNode(java.lang.String nodeName) Try to get a IXholon node, knowing only the nodeName (the name used by a guiItem).
void	handleDrop(java.lang.String nodeName, java.lang.Object data) Handle data dragged-and-dropped onto an HTML Element (typically a TreeItem).
void	handleNodeSelection(java.lang.String nodeName, java.lang.Object guiItem, boolean isCtrlPressed) Handle selection of a node, typically caused by clicking or ctrl-clicking on a node with the left mouse button.
void	makeContextMenu(java.lang.Object guiItem, int posX, int posY) Make a context menu for a specified GUI item.
void	refresh() Refresh the entire hierarchical structure (tree, contour, etc.) being displayed in the viewer.
void	refresh(java.lang.Object guiItem, IXholon xhNode) Refresh the current node in the hierarchical structure, including its entire sub-tree.
IMessage	sendXholonHelperService(int signal, java.lang.Object data, IXholon sender) Send a synchronous message to the XholonHelperService.
abstract void	showTree(IXholon node) Show the entire IXholon tree in a GUI.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.primordion.xholon.io.IXholonGui

getGuiRoot

Constructor Detail

AbstractXholonGui

public AbstractXholonGui()

Constructor.

Method Detail

getModelName

public java.lang.String getModelName()

Get name of the model.

Returns:

Model name.

showTree

public abstract void showTree(IXholon node)

Show the entire IXholon tree in a GUI.

Specified by:

showTree in interface IXholonGui

Parameters:

node - Node from which to start showing the tree.

handleNodeSelection

public void handleNodeSelection(java.lang.String nodeName,
                       java.lang.Object guiItem,
                       boolean isCtrlPressed)

Handle selection of a node, typically caused by clicking or ctrl-clicking on a node with the left mouse button.

Specified by:

handleNodeSelection in interface IXholonGui

Parameters:

node -

nodeName -

guiItem -

sendXholonHelperService

public IMessage sendXholonHelperService(int signal,
                               java.lang.Object data,
                               IXholon sender)

Send a synchronous message to the XholonHelperService.

Parameters:

signal -

data -

sender -

Returns:

refresh

public void refresh()

Refresh the entire hierarchical structure (tree, contour, etc.) being displayed in the viewer. Subclasses may override this to refresh the GUI.

refresh

public void refresh(java.lang.Object guiItem,
           IXholon xhNode)

Refresh the current node in the hierarchical structure, including its entire sub-tree. Subclasses may override this to refresh the sub-tree in the GUI.

Parameters:

guiItem - The current item in the GUI.

node - The current IXholon node, corresponding to the guiItem.

execModel

public void execModel(java.lang.String mName,
             IApplication app)

Execute a model.

Specified by:

execModel in interface IXholonGui

Parameters:

mName - The model name.

app - Instance of the model's IApplication class.

makeContextMenu

public void makeContextMenu(java.lang.Object guiItem,
                   int posX,
                   int posY)

Make a context menu for a specified GUI item.

Specified by:

makeContextMenu in interface IXholonGui

Parameters:

guiItem -

posX -

posY -

getXholonNode

public IXholon getXholonNode(java.lang.String nodeName)

Try to get a IXholon node, knowing only the nodeName (the name used by a guiItem). This is used by XholonGuiClassicTree.

Parameters:

nodeName - (ex: "hello_2" "Hello")

Returns:

An instance of IXholon, or null.

handleDrop

public void handleDrop(java.lang.String nodeName,
              java.lang.Object data)

Handle data dragged-and-dropped onto an HTML Element (typically a TreeItem).

Specified by:

handleDrop in interface IXholonGui

Parameters:

nodeName - The text (Label) name of the Element; an IXholon node name.

data - The content dropped onto the Element (ex: a XhgolonWorkbook).