com.aquafold.openapi.project
Interface AQDashboard

public interface AQDashboard

AQDashboard is a representation of the HTML view to be rendered to the user in the project's Workspace. It contains an API to construct a set of buttons in a toolbar, which will be rendered in the HTML view before any other script HTML is rendered. This allows for a navigation of scripts within a web-based interface. When run within Aqua Data Server environment, the script output is inserted into a generated html page.

Method Summary

void	addToolbarButton(String action, String title, String tooltip, String icon) Adds a button to the dashboard toolbar.
void	addToolbarSeparator() Adds a toolbar separator.
void	clearToolbarButtons() Removes all toolbar buttons.

Method Detail

addToolbarButton

void addToolbarButton(String action,
                      String title,
                      String tooltip,
                      String icon)

Adds a button to the dashboard toolbar.

Parameters:

action - URL of the associated action.

title - Button text.

tooltip - Button tool tip.

icon - Button icon URL (null for none)

clearToolbarButtons

void clearToolbarButtons()

Removes all toolbar buttons.

addToolbarSeparator

void addToolbarSeparator()

Adds a toolbar separator.