Package org.apache.hop.ui.hopgui

Class HopGui

java.lang.Object

org.apache.hop.ui.hopgui.HopGui

All Implemented Interfaces:

ISearchableProvider, IHasHopMetadataProvider, IActionContextHandlersProvider

@GuiPlugin(description="The main hop graphical user interface")
public class HopGui
extends Object
implements IActionContextHandlersProvider, ISearchableProvider, IHasHopMetadataProvider

Field Summary

Fields

Modifier and Type	Field	Description
static String	APP_NAME
HopGuiAuditDelegate	auditDelegate
HopGuiContextDelegate	contextDelegate
MetadataManager<DatabaseMeta>	databaseMetaManager
static String	DEFAULT_HOP_GUI_NAMESPACE
HopGuiFileDelegate	fileDelegate
HopGuiFileRefreshDelegate	fileRefreshDelegate
boolean	firstShowing
static String	GUI_PLUGIN_PERSPECTIVES_PARENT_ID
MetadataManager<HopServer>	hopServerManager
static String	ID_MAIN_MENU
static String	ID_MAIN_MENU_EDIT_ALIGN_BOTTOM
static String	ID_MAIN_MENU_EDIT_ALIGN_LEFT
static String	ID_MAIN_MENU_EDIT_ALIGN_RIGHT
static String	ID_MAIN_MENU_EDIT_ALIGN_TOP
static String	ID_MAIN_MENU_EDIT_COPY
static String	ID_MAIN_MENU_EDIT_CUT
static String	ID_MAIN_MENU_EDIT_DELETE
static String	ID_MAIN_MENU_EDIT_DISTRIBUTE_HORIZONTAL
static String	ID_MAIN_MENU_EDIT_DISTRIBUTE_VERTICAL
static String	ID_MAIN_MENU_EDIT_FIND
static String	ID_MAIN_MENU_EDIT_NAV_NEXT
static String	ID_MAIN_MENU_EDIT_NAV_PREV
static String	ID_MAIN_MENU_EDIT_PARENT_ID
static String	ID_MAIN_MENU_EDIT_PASTE
static String	ID_MAIN_MENU_EDIT_REDO
static String	ID_MAIN_MENU_EDIT_SELECT_ALL
static String	ID_MAIN_MENU_EDIT_SNAP_TO_GRID
static String	ID_MAIN_MENU_EDIT_UNDO
static String	ID_MAIN_MENU_EDIT_UNSELECT_ALL
static String	ID_MAIN_MENU_FILE
static String	ID_MAIN_MENU_FILE_CLOSE
static String	ID_MAIN_MENU_FILE_CLOSE_ALL
static String	ID_MAIN_MENU_FILE_EXIT
static String	ID_MAIN_MENU_FILE_EXPORT_TO_SVG
static String	ID_MAIN_MENU_FILE_NEW
static String	ID_MAIN_MENU_FILE_OPEN
static String	ID_MAIN_MENU_FILE_OPEN_RECENT
static String	ID_MAIN_MENU_FILE_SAVE
static String	ID_MAIN_MENU_FILE_SAVE_AS
static String	ID_MAIN_MENU_HELP_ABOUT
static String	ID_MAIN_MENU_HELP_PARENT_ID
static String	ID_MAIN_MENU_RUN_DEBUG
static String	ID_MAIN_MENU_RUN_PARENT_ID
static String	ID_MAIN_MENU_RUN_PAUSE
static String	ID_MAIN_MENU_RUN_PREVIEW
static String	ID_MAIN_MENU_RUN_RESUME
static String	ID_MAIN_MENU_RUN_START
static String	ID_MAIN_MENU_RUN_STOP
static String	ID_MAIN_MENU_TOOLS_DATABASE_CLEAR_CACHE
static String	ID_MAIN_MENU_TOOLS_PARENT_ID
static String	ID_MAIN_TOOLBAR
static String	ID_MAIN_TOOLBAR_MENU
static String	ID_MAIN_TOOLBAR_NEW
static String	ID_MAIN_TOOLBAR_OPEN
static String	ID_MAIN_TOOLBAR_SAVE
static String	ID_MAIN_TOOLBAR_SAVE_AS
MetadataManager<PartitionSchema>	partitionManager
HopGuiUndoDelegate	undoDelegate

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HopGui()

Method Summary

Modifier and Type	Method	Description
protected void	addMainToolbar()
protected void	addPerspectivesToolbar()
static boolean	editConfigFile(org.eclipse.swt.widgets.Shell shell, String configFilename, DescribedVariablesConfigFile variablesConfigFile, String selectedVariable)
IHopFileTypeHandler	getActiveFileTypeHandler()
IHopPerspective	getActivePerspective()	Gets activePerspective
static HopGuiPipelineGraph	getActivePipelineGraph()	Convenience method to pick up the active pipeline graph
static HopGuiWorkflowGraph	getActiveWorkflowGraph()
List<String>	getCommandLineArguments()	Gets commandLineArguments
static ConfigurationPerspective	getConfigurationPerspective()
List<IGuiContextHandler>	getContextHandlers()	What are the contexts to consider: - the file types registered - the available metadata types
MetadataManager<DatabaseMeta>	getDatabaseMetaManager()	Gets databaseMetaManager
static HopDataOrchestrationPerspective	getDataOrchestrationPerspective()
org.eclipse.swt.widgets.Display	getDisplay()	Gets display
HopGuiEventsHandler	getEventsHandler()	Gets eventsHandler
static ExecutionPerspective	getExecutionPerspective()
static ExplorerPerspective	getExplorerPerspective()
HopGuiFileDelegate	getFileDelegate()	Gets fileDelegate
String	getId()	Gets the unique id of this HopGui instance
static HopGui	getInstance()
ILogChannel	getLog()	Gets log
ILoggingObject	getLoggingObject()	Gets loggingObject
org.eclipse.swt.widgets.Composite	getMainHopGuiComposite()	Gets mainHopGuiComposite
org.eclipse.swt.widgets.Menu	getMainMenu()	Gets mainMenu
GuiMenuWidgets	getMainMenuWidgets()	Gets mainMenuWidgets
org.eclipse.swt.widgets.Composite	getMainPerspectivesComposite()	Gets mainPerspectivesComposite
org.eclipse.swt.widgets.ToolBar	getMainToolbar()	Gets mainToolbar
GuiToolbarWidgets	getMainToolbarWidgets()	Gets mainToolbarWidgets
static MetadataPerspective	getMetadataPerspective()
MultiMetadataProvider	getMetadataProvider()	Gets metadataProvider
MetadataManager<PartitionSchema>	getPartitionManager()	Gets partitionManager
HopPerspectiveManager	getPerspectiveManager()	Gets perspectiveManager
org.eclipse.swt.widgets.ToolBar	getPerspectivesToolbar()	Gets perspectivesToolbar
PropsUi	getProps()	Gets props
List<ISearchablesLocation>	getSearchablesLocations()	Create a list of all the searcheables locations.
org.eclipse.swt.widgets.Shell	getShell()	Gets shell
HopGuiUndoDelegate	getUndoDelegate()	Gets undoDelegate
IVariables	getVariables()	Gets the variables
void	handleFileCapabilities(IHopFileType fileType, boolean changed, boolean running, boolean paused)	We're given a bunch of capabilities from IHopFileType In this method we'll enable/disable menu and toolbar items
boolean	isActivePerspective(IHopPerspective perspective)
boolean	isOpeningLastFiles()	Gets openingLastFiles
boolean	isReOpeningFiles()	Gets reOpeningFiles
static void	main(String[] arguments)
void	menu()	A toolbar which shows all the menu item options in a context dialog.
void	menuEdit()
void	menuEditAlignBottom()
void	menuEditAlignLeft()
void	menuEditAlignRight()
void	menuEditAlignTop()
void	menuEditCopySelected()
void	menuEditCutSelected()
void	menuEditDeleteSelected()
void	menuEditDistributeHorizontal()
void	menuEditDistributeVertical()
void	menuEditFind()
void	menuEditNavigateNextFile()
void	menuEditNavigatePreviousFile()
void	menuEditPaste()
void	menuEditRedo()
void	menuEditSelectAll()
void	menuEditSnapToGrid()
void	menuEditUndo()
void	menuEditUnselectAll()
void	menuFile()
void	menuFileClose()
void	menuFileCloseAll()
void	menuFileExit()
void	menuFileExportToSvg()
void	menuFileNew()
void	menuFileOpen()
void	menuFileOpenRecent()
void	menuFileSave()
void	menuFileSaveAs()
void	menuHelp()
void	menuHelpAbout()
void	menuRun()
void	menuRunDebug()
void	menuRunPause()
void	menuRunPreview()
void	menuRunResume()
void	menuRunStart()
void	menuRunStop()
void	menuTools()
void	menuToolsDatabaseClearCache()
void	nextPerspective()
protected void	open()	Build the shell
void	previousPerspective()
void	replaceKeyboardShortcutListeners(Object parentObject)	Replace the listeners based on the @GuiKeyboardShortcut annotations
void	replaceKeyboardShortcutListeners(org.eclipse.swt.widgets.Control control, HopGuiKeyHandler keyHandler)
void	setActivePerspective(IHopPerspective perspective)
void	setCommandLineArguments(List<String> commandLineArguments)
void	setDatabaseMetaManager(MetadataManager<DatabaseMeta> databaseMetaManager)
void	setEventsHandler(HopGuiEventsHandler eventsHandler)
void	setFileDelegate(HopGuiFileDelegate fileDelegate)
void	setMainHopGuiComposite(org.eclipse.swt.widgets.Composite mainHopGuiComposite)
void	setMainMenu(org.eclipse.swt.widgets.Menu mainMenu)
void	setMainMenuWidgets(GuiMenuWidgets mainMenuWidgets)
void	setMainPerspectivesComposite(org.eclipse.swt.widgets.Composite mainPerspectivesComposite)
void	setMainToolbar(org.eclipse.swt.widgets.ToolBar mainToolbar)
void	setMainToolbarWidgets(GuiToolbarWidgets mainToolbarWidgets)
void	setMetadataProvider(MultiMetadataProvider metadataProvider)
void	setOpeningLastFiles(boolean openingLastFiles)
void	setParametersAsVariablesInUI(INamedParameterDefinitions namedParameters, IVariables variables)
void	setPartitionManager(MetadataManager<PartitionSchema> partitionManager)
void	setPerspectiveManager(HopPerspectiveManager perspectiveManager)
void	setPerspectivesToolbar(org.eclipse.swt.widgets.ToolBar perspectivesToolbar)
void	setProps(PropsUi props)
void	setReOpeningFiles(boolean reOpeningFiles)	Sets reOpeningFiles
void	setShell(org.eclipse.swt.widgets.Shell shell)
void	setUndoDelegate(HopGuiUndoDelegate undoDelegate)
void	setUndoMenu(IUndo undoInterface)
void	setVariables(IVariables variables)

Methods inherited from class java.lang.Object

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

Field Detail

ID_MAIN_MENU

public static final String ID_MAIN_MENU

See Also:

Constant Field Values

ID_MAIN_MENU_FILE

public static final String ID_MAIN_MENU_FILE

See Also:

Constant Field Values

ID_MAIN_MENU_FILE_NEW

public static final String ID_MAIN_MENU_FILE_NEW

See Also:

Constant Field Values

ID_MAIN_MENU_FILE_OPEN

public static final String ID_MAIN_MENU_FILE_OPEN

See Also:

Constant Field Values

ID_MAIN_MENU_FILE_OPEN_RECENT

public static final String ID_MAIN_MENU_FILE_OPEN_RECENT

See Also:

Constant Field Values

ID_MAIN_MENU_FILE_SAVE

public static final String ID_MAIN_MENU_FILE_SAVE

See Also:

Constant Field Values

ID_MAIN_MENU_FILE_SAVE_AS

public static final String ID_MAIN_MENU_FILE_SAVE_AS

See Also:

Constant Field Values

ID_MAIN_MENU_FILE_EXPORT_TO_SVG

public static final String ID_MAIN_MENU_FILE_EXPORT_TO_SVG

See Also:

Constant Field Values

ID_MAIN_MENU_FILE_CLOSE

public static final String ID_MAIN_MENU_FILE_CLOSE

See Also:

Constant Field Values

ID_MAIN_MENU_FILE_CLOSE_ALL

public static final String ID_MAIN_MENU_FILE_CLOSE_ALL

See Also:

Constant Field Values

ID_MAIN_MENU_FILE_EXIT

public static final String ID_MAIN_MENU_FILE_EXIT

See Also:

Constant Field Values

ID_MAIN_MENU_EDIT_PARENT_ID

public static final String ID_MAIN_MENU_EDIT_PARENT_ID

See Also:

Constant Field Values

ID_MAIN_MENU_EDIT_UNDO

public static final String ID_MAIN_MENU_EDIT_UNDO

See Also:

Constant Field Values

ID_MAIN_MENU_EDIT_REDO

public static final String ID_MAIN_MENU_EDIT_REDO

See Also:

Constant Field Values

ID_MAIN_MENU_EDIT_SELECT_ALL

public static final String ID_MAIN_MENU_EDIT_SELECT_ALL

See Also:

Constant Field Values

ID_MAIN_MENU_EDIT_UNSELECT_ALL

public static final String ID_MAIN_MENU_EDIT_UNSELECT_ALL

See Also:

Constant Field Values

ID_MAIN_MENU_EDIT_FIND

public static final String ID_MAIN_MENU_EDIT_FIND

See Also:

Constant Field Values

ID_MAIN_MENU_EDIT_COPY

public static final String ID_MAIN_MENU_EDIT_COPY

See Also:

Constant Field Values

ID_MAIN_MENU_EDIT_PASTE

public static final String ID_MAIN_MENU_EDIT_PASTE

See Also:

Constant Field Values

ID_MAIN_MENU_EDIT_CUT

public static final String ID_MAIN_MENU_EDIT_CUT

See Also:

Constant Field Values

ID_MAIN_MENU_EDIT_DELETE

public static final String ID_MAIN_MENU_EDIT_DELETE

See Also:

Constant Field Values

ID_MAIN_MENU_EDIT_SNAP_TO_GRID

public static final String ID_MAIN_MENU_EDIT_SNAP_TO_GRID

See Also:

Constant Field Values

ID_MAIN_MENU_EDIT_ALIGN_LEFT

public static final String ID_MAIN_MENU_EDIT_ALIGN_LEFT

See Also:

Constant Field Values

ID_MAIN_MENU_EDIT_ALIGN_RIGHT

public static final String ID_MAIN_MENU_EDIT_ALIGN_RIGHT

See Also:

Constant Field Values

ID_MAIN_MENU_EDIT_ALIGN_TOP

public static final String ID_MAIN_MENU_EDIT_ALIGN_TOP

See Also:

Constant Field Values

ID_MAIN_MENU_EDIT_ALIGN_BOTTOM

public static final String ID_MAIN_MENU_EDIT_ALIGN_BOTTOM

See Also:

Constant Field Values

ID_MAIN_MENU_EDIT_DISTRIBUTE_HORIZONTAL

public static final String ID_MAIN_MENU_EDIT_DISTRIBUTE_HORIZONTAL

See Also:

Constant Field Values

ID_MAIN_MENU_EDIT_DISTRIBUTE_VERTICAL

public static final String ID_MAIN_MENU_EDIT_DISTRIBUTE_VERTICAL

See Also:

Constant Field Values

ID_MAIN_MENU_EDIT_NAV_PREV

public static final String ID_MAIN_MENU_EDIT_NAV_PREV

See Also:

Constant Field Values

ID_MAIN_MENU_EDIT_NAV_NEXT

public static final String ID_MAIN_MENU_EDIT_NAV_NEXT

See Also:

Constant Field Values

ID_MAIN_MENU_RUN_PARENT_ID

public static final String ID_MAIN_MENU_RUN_PARENT_ID

See Also:

Constant Field Values

ID_MAIN_MENU_RUN_START

public static final String ID_MAIN_MENU_RUN_START

See Also:

Constant Field Values

ID_MAIN_MENU_RUN_PAUSE

public static final String ID_MAIN_MENU_RUN_PAUSE

See Also:

Constant Field Values

ID_MAIN_MENU_RUN_RESUME

public static final String ID_MAIN_MENU_RUN_RESUME

See Also:

Constant Field Values

ID_MAIN_MENU_RUN_STOP

public static final String ID_MAIN_MENU_RUN_STOP

See Also:

Constant Field Values

ID_MAIN_MENU_RUN_PREVIEW

public static final String ID_MAIN_MENU_RUN_PREVIEW

See Also:

Constant Field Values

ID_MAIN_MENU_RUN_DEBUG

public static final String ID_MAIN_MENU_RUN_DEBUG

See Also:

Constant Field Values

ID_MAIN_MENU_TOOLS_PARENT_ID

public static final String ID_MAIN_MENU_TOOLS_PARENT_ID

See Also:

Constant Field Values

ID_MAIN_MENU_TOOLS_DATABASE_CLEAR_CACHE

public static final String ID_MAIN_MENU_TOOLS_DATABASE_CLEAR_CACHE

See Also:

Constant Field Values

ID_MAIN_MENU_HELP_PARENT_ID

public static final String ID_MAIN_MENU_HELP_PARENT_ID

See Also:

Constant Field Values

ID_MAIN_MENU_HELP_ABOUT

public static final String ID_MAIN_MENU_HELP_ABOUT

See Also:

Constant Field Values

ID_MAIN_TOOLBAR

public static final String ID_MAIN_TOOLBAR

See Also:

Constant Field Values

ID_MAIN_TOOLBAR_MENU

public static final String ID_MAIN_TOOLBAR_MENU

See Also:

Constant Field Values

ID_MAIN_TOOLBAR_NEW

public static final String ID_MAIN_TOOLBAR_NEW

See Also:

Constant Field Values

ID_MAIN_TOOLBAR_OPEN

public static final String ID_MAIN_TOOLBAR_OPEN

See Also:

Constant Field Values

ID_MAIN_TOOLBAR_SAVE

public static final String ID_MAIN_TOOLBAR_SAVE

See Also:

Constant Field Values

ID_MAIN_TOOLBAR_SAVE_AS

public static final String ID_MAIN_TOOLBAR_SAVE_AS

See Also:

Constant Field Values

GUI_PLUGIN_PERSPECTIVES_PARENT_ID

public static final String GUI_PLUGIN_PERSPECTIVES_PARENT_ID

See Also:

Constant Field Values

DEFAULT_HOP_GUI_NAMESPACE

public static final String DEFAULT_HOP_GUI_NAMESPACE

See Also:

Constant Field Values

firstShowing

public boolean firstShowing

APP_NAME

public static final String APP_NAME

See Also:

Constant Field Values

databaseMetaManager

public MetadataManager<DatabaseMeta> databaseMetaManager

hopServerManager

public MetadataManager<HopServer> hopServerManager

partitionManager

public MetadataManager<PartitionSchema> partitionManager

fileDelegate

public HopGuiFileDelegate fileDelegate

undoDelegate

public HopGuiUndoDelegate undoDelegate

contextDelegate

public HopGuiContextDelegate contextDelegate

auditDelegate

public HopGuiAuditDelegate auditDelegate

fileRefreshDelegate

public HopGuiFileRefreshDelegate fileRefreshDelegate

Constructor Detail

HopGui

protected HopGui()

Method Detail

getInstance

public static final HopGui getInstance()

main

public static void main(String[] arguments)

open

protected void open()

Build the shell

menu

@GuiToolbarElement(root="HopGui-Toolbar",
                   id="toolbar-10000-menu",
                   image="ui/images/logo_bw.svg",
                   toolTip="i18n::HopGui.Menu")
public void menu()

A toolbar which shows all the menu item options in a context dialog.

menuFile

@GuiMenuElement(root="HopGui-Menu",
                id="10000-menu-file",
                label="i18n::HopGui.Menu.File",
                parentId="HopGui-Menu")
public void menuFile()

menuFileNew

@GuiMenuElement(root="HopGui-Menu",
                id="10010-menu-file-new",
                label="i18n::HopGui.Menu.File.New",
                image="ui/images/add.svg",
                parentId="10000-menu-file")
@GuiToolbarElement(root="HopGui-Toolbar",
                   id="toolbar-10010-new",
                   image="ui/images/add.svg",
                   toolTip="i18n::HopGui.Menu.File.New")
@GuiKeyboardShortcut(control=true,
                     key=110)
@GuiOsxKeyboardShortcut(command=true,
                        key=110)
public void menuFileNew()

menuFileOpen

@GuiMenuElement(root="HopGui-Menu",
                id="10020-menu-file-open",
                label="i18n::HopGui.Menu.File.Open",
                image="ui/images/open.svg",
                parentId="10000-menu-file")
@GuiToolbarElement(root="HopGui-Toolbar",
                   id="toolbar-10020-open",
                   image="ui/images/open.svg",
                   toolTip="i18n::HopGui.Menu.File.Open",
                   separator=true)
@GuiKeyboardShortcut(control=true,
                     key=111)
@GuiOsxKeyboardShortcut(command=true,
                        key=111)
public void menuFileOpen()

menuFileOpenRecent

@GuiMenuElement(root="HopGui-Menu",
                id="10025-menu-file-open-recent",
                label="i18n::HopGui.Menu.File.Open.Recent",
                image="ui/images/open.svg",
                parentId="10000-menu-file")
public void menuFileOpenRecent()

menuFileSave

@GuiMenuElement(root="HopGui-Menu",
                id="10030-menu-file-save",
                label="i18n::HopGui.Menu.File.Save",
                image="ui/images/save.svg",
                parentId="10000-menu-file")
@GuiToolbarElement(root="HopGui-Toolbar",
                   id="toolbar-10040-save",
                   image="ui/images/save.svg",
                   toolTip="i18n::HopGui.Menu.File.Save")
@GuiKeyboardShortcut(control=true,
                     key=115)
@GuiOsxKeyboardShortcut(command=true,
                        key=115)
public void menuFileSave()

menuFileSaveAs

@GuiMenuElement(root="HopGui-Menu",
                id="10040-menu-file-save-as",
                label="i18n::HopGui.Menu.File.SaveAs",
                image="ui/images/save-as.svg",
                parentId="10000-menu-file")
@GuiToolbarElement(root="HopGui-Toolbar",
                   id="toolbar-10050-save-as",
                   image="ui/images/save-as.svg",
                   toolTip="i18n::HopGui.Menu.File.SaveAs")
@GuiKeyboardShortcut(control=true,
                     shift=true,
                     key=115)
@GuiOsxKeyboardShortcut(command=true,
                        shift=true,
                        key=115)
public void menuFileSaveAs()

menuFileExportToSvg

@GuiMenuElement(root="HopGui-Menu",
                id="10050-menu-file-export-to-svg",
                separator=true,
                label="i18n::HopGui.Menu.File.ExportToSVG",
                image="ui/images/image.svg",
                parentId="10000-menu-file")
public void menuFileExportToSvg()

menuFileClose

@GuiMenuElement(root="HopGui-Menu",
                id="10090-menu-file-close",
                label="i18n::HopGui.Menu.File.Close",
                parentId="10000-menu-file",
                image="ui/images/close.svg",
                separator=true)
@GuiKeyboardShortcut(control=true,
                     key=119)
@GuiOsxKeyboardShortcut(command=true,
                        key=119)
public void menuFileClose()

menuFileCloseAll

@GuiMenuElement(root="HopGui-Menu",
                id="10100-menu-file-close-all",
                label="i18n::HopGui.Menu.File.Close.All",
                parentId="10000-menu-file",
                image="ui/images/close.svg")
@GuiKeyboardShortcut(control=true,
                     shift=true,
                     key=119)
@GuiOsxKeyboardShortcut(command=true,
                        shift=true,
                        key=119)
public void menuFileCloseAll()

menuFileExit

@GuiMenuElement(root="HopGui-Menu",
                id="10900-menu-file-exit",
                label="i18n::HopGui.Menu.File.Quit",
                parentId="10000-menu-file",
                image="ui/images/shutdown.svg",
                separator=true)
@GuiKeyboardShortcut(control=true,
                     key=113)
@GuiOsxKeyboardShortcut(command=true,
                        key=113)
public void menuFileExit()

menuEdit

@GuiMenuElement(root="HopGui-Menu",
                id="20000-menu-edit",
                label="i18n::HopGui.Menu.Edit",
                parentId="HopGui-Menu")
public void menuEdit()

menuEditUndo

@GuiMenuElement(root="HopGui-Menu",
                id="20010-menu-edit-undo",
                label="i18n::HopGui.Menu.Edit.Undo",
                image="ui/images/undo.svg",
                parentId="20000-menu-edit")
@GuiKeyboardShortcut(control=true,
                     key=122)
@GuiOsxKeyboardShortcut(command=true,
                        key=122)
public void menuEditUndo()

menuEditRedo

@GuiMenuElement(root="HopGui-Menu",
                id="20020-menu-edit-redo",
                label="i18n::HopGui.Menu.Edit.Redo",
                image="ui/images/redo.svg",
                parentId="20000-menu-edit")
@GuiKeyboardShortcut(control=true,
                     shift=true,
                     key=122)
@GuiOsxKeyboardShortcut(command=true,
                        shift=true,
                        key=122)
public void menuEditRedo()

menuEditSelectAll

@GuiMenuElement(root="HopGui-Menu",
                id="20050-menu-edit-select-all",
                label="i18n::HopGui.Menu.Edit.SelectAll",
                parentId="20000-menu-edit",
                image="ui/images/select-all.svg",
                separator=true)
@GuiKeyboardShortcut(control=true,
                     key=97)
@GuiOsxKeyboardShortcut(command=true,
                        key=97)
public void menuEditSelectAll()

menuEditUnselectAll

@GuiMenuElement(root="HopGui-Menu",
                id="20060-menu-edit-unselect-all",
                label="i18n::HopGui.Menu.Edit.ClearSelection",
                parentId="20000-menu-edit",
                image="ui/images/unselect-all.svg")
@GuiKeyboardShortcut(key=27)
@GuiOsxKeyboardShortcut(key=27)
public void menuEditUnselectAll()

menuEditFind

@GuiMenuElement(root="HopGui-Menu",
                id="20070-menu-edit-find",
                label="i18n::HopGui.Menu.Edit.Find",
                image="ui/images/search.svg",
                parentId="20000-menu-edit")
@GuiKeyboardShortcut(key=102,
                     control=true)
@GuiOsxKeyboardShortcut(key=102,
                        command=true)
public void menuEditFind()

menuEditCopySelected

@GuiMenuElement(root="HopGui-Menu",
                id="20080-menu-edit-copy",
                label="i18n::HopGui.Menu.Edit.CopyToClipboard",
                image="ui/images/copy.svg",
                parentId="20000-menu-edit",
                separator=true)
@GuiKeyboardShortcut(control=true,
                     key=99)
@GuiOsxKeyboardShortcut(command=true,
                        key=99)
public void menuEditCopySelected()

menuEditPaste

@GuiMenuElement(root="HopGui-Menu",
                id="20090-menu-edit-paste",
                label="i18n::HopGui.Menu.Edit.PasteFromClipboard",
                image="ui/images/paste.svg",
                parentId="20000-menu-edit")
@GuiKeyboardShortcut(control=true,
                     key=118)
@GuiOsxKeyboardShortcut(command=true,
                        key=118)
public void menuEditPaste()

menuEditCutSelected

@GuiMenuElement(root="HopGui-Menu",
                id="20100-menu-edit-cut",
                label="i18n::HopGui.Menu.Edit.Cut",
                image="ui/images/cut.svg",
                parentId="20000-menu-edit")
@GuiKeyboardShortcut(control=true,
                     key=120)
@GuiOsxKeyboardShortcut(command=true,
                        key=120)
public void menuEditCutSelected()

menuEditDeleteSelected

@GuiMenuElement(root="HopGui-Menu",
                id="20110-menu-edit-delete",
                label="i18n::HopGui.Menu.Edit.Delete",
                image="ui/images/delete.svg",
                parentId="20000-menu-edit")
@GuiKeyboardShortcut(control=false,
                     key=127)
@GuiOsxKeyboardShortcut(command=false,
                        key=127)
public void menuEditDeleteSelected()

menuEditSnapToGrid

@GuiMenuElement(root="HopGui-Menu",
                id="20200-menu-edit-snap-to-grid",
                label="i18n::HopGui.Menu.Edit.SnapToGrid",
                image="ui/images/snap-to-grid.svg",
                parentId="20000-menu-edit",
                separator=true)
@GuiKeyboardShortcut(control=true,
                     key=16777223)
@GuiOsxKeyboardShortcut(command=true,
                        key=16777223)
public void menuEditSnapToGrid()

menuEditAlignLeft

@GuiMenuElement(root="HopGui-Menu",
                id="20210-menu-edit-align-left",
                parentId="20000-menu-edit",
                label="i18n::HopGui.Menu.Edit.AlignLeft",
                image="ui/images/align-left.svg")
@GuiKeyboardShortcut(control=true,
                     key=16777219)
@GuiOsxKeyboardShortcut(command=true,
                        key=16777219)
public void menuEditAlignLeft()

menuEditAlignRight

@GuiMenuElement(root="HopGui-Menu",
                id="20220-menu-edit-align-right",
                parentId="20000-menu-edit",
                label="i18n::HopGui.Menu.Edit.AlignRight",
                image="ui/images/align-right.svg")
@GuiKeyboardShortcut(control=true,
                     key=16777220)
@GuiOsxKeyboardShortcut(command=true,
                        key=16777220)
public void menuEditAlignRight()

menuEditAlignTop

@GuiMenuElement(root="HopGui-Menu",
                id="20230-menu-edit-align-top",
                parentId="20000-menu-edit",
                label="i18n::HopGui.Menu.Edit.AlignTop",
                image="ui/images/align-top.svg")
@GuiKeyboardShortcut(control=true,
                     key=16777217)
@GuiOsxKeyboardShortcut(command=true,
                        key=16777217)
public void menuEditAlignTop()

menuEditAlignBottom

@GuiMenuElement(root="HopGui-Menu",
                id="20240-menu-edit-align-bottom",
                parentId="20000-menu-edit",
                label="i18n::HopGui.Menu.Edit.AlignBottom",
                image="ui/images/align-bottom.svg")
@GuiKeyboardShortcut(control=true,
                     key=16777218)
@GuiOsxKeyboardShortcut(command=true,
                        key=16777218)
public void menuEditAlignBottom()

menuEditDistributeHorizontal

@GuiMenuElement(root="HopGui-Menu",
                id="20300-menu-edit-distribute-horizontal",
                parentId="20000-menu-edit",
                label="i18n::HopGui.Menu.Edit.DistributeHorizontally",
                image="ui/images/distribute-horizontally.svg")
@GuiKeyboardShortcut(alt=true,
                     key=16777220)
@GuiOsxKeyboardShortcut(alt=true,
                        key=16777220)
public void menuEditDistributeHorizontal()

menuEditDistributeVertical

@GuiMenuElement(root="HopGui-Menu",
                id="20320-menu-edit-distribute-vertical",
                parentId="20000-menu-edit",
                label="i18n::HopGui.Menu.Edit.DistributeVertically",
                image="ui/images/distribute-vertically.svg")
@GuiKeyboardShortcut(alt=true,
                     key=16777217)
@GuiOsxKeyboardShortcut(alt=true,
                        key=16777217)
public void menuEditDistributeVertical()

menuEditNavigatePreviousFile

@GuiMenuElement(root="HopGui-Menu",
                id="20400-menu-edit-nav-previous",
                label="i18n::HopGui.Menu.Edit.Navigate.Previous",
                parentId="20000-menu-edit",
                image="ui/images/arrow-left.svg",
                separator=true)
@GuiKeyboardShortcut(alt=true,
                     key=16777219)
public void menuEditNavigatePreviousFile()

menuEditNavigateNextFile

@GuiMenuElement(root="HopGui-Menu",
                id="20410-menu-edit-nav-next",
                label="i18n::HopGui.Menu.Edit.Navigate.Next",
                parentId="20000-menu-edit",
                image="ui/images/arrow-right.svg")
@GuiKeyboardShortcut(alt=true,
                     key=16777220)
public void menuEditNavigateNextFile()

menuRun

@GuiMenuElement(root="HopGui-Menu",
                id="30000-menu-run",
                label="i18n::HopGui.Menu.Run",
                parentId="HopGui-Menu")
public void menuRun()

menuRunStart

@GuiMenuElement(root="HopGui-Menu",
                id="30010-menu-run-execute",
                label="i18n::HopGui.Menu.Run.StartExecution",
                image="ui/images/run.svg",
                parentId="30000-menu-run")
@GuiKeyboardShortcut(key=16777233)
public void menuRunStart()

menuRunStop

@GuiMenuElement(root="HopGui-Menu",
                id="30040-menu-run-stop",
                label="i18n::HopGui.Menu.Run.StopExecution",
                image="ui/images/stop.svg",
                parentId="30000-menu-run")
public void menuRunStop()

menuRunPause

@GuiMenuElement(root="HopGui-Menu",
                id="30030-menu-run-pause",
                label="i18n::HopGui.Menu.Run.PauseExecution",
                image="ui/images/pause.svg",
                parentId="30000-menu-run",
                separator=true)
public void menuRunPause()

menuRunResume

@GuiMenuElement(root="HopGui-Menu",
                id="30035-menu-run-resume",
                label="i18n::HopGui.Menu.Run.ResumeExecution",
                image="ui/images/run.svg",
                parentId="30000-menu-run")
public void menuRunResume()

menuRunPreview

@GuiMenuElement(root="HopGui-Menu",
                id="30050-menu-run-preview",
                label="i18n::HopGui.Menu.Run.Preview",
                image="ui/images/preview.svg",
                parentId="30000-menu-run",
                separator=true)
public void menuRunPreview()

menuRunDebug

@GuiMenuElement(root="HopGui-Menu",
                id="30060-menu-run-debug",
                label="i18n::HopGui.Menu.Run.Debug",
                image="ui/images/debug.svg",
                parentId="30000-menu-run")
public void menuRunDebug()

menuTools

@GuiMenuElement(root="HopGui-Menu",
                id="40000-menu-tools",
                label="i18n::HopGui.Menu.Tools",
                parentId="HopGui-Menu")
public void menuTools()

menuToolsDatabaseClearCache

@GuiMenuElement(root="HopGui-Menu",
                id="40030-menu-tools-database-clearcache",
                label="i18n::HopGui.Menu.Tools.DatabaseClearCache",
                parentId="40000-menu-tools",
                separator=true,
                image="ui/images/clear.svg")
public void menuToolsDatabaseClearCache()

menuHelp

@GuiMenuElement(root="HopGui-Menu",
                id="90000-menu-help",
                label="i18n::HopGui.Menu.Help",
                parentId="HopGui-Menu")
public void menuHelp()

menuHelpAbout

@GuiMenuElement(root="HopGui-Menu",
                id="90009-menu-help-about",
                label="i18n::HopGui.Menu.Help.About",
                parentId="90000-menu-help",
                image="ui/images/help.svg")
public void menuHelpAbout()

addMainToolbar

protected void addMainToolbar()

addPerspectivesToolbar

protected void addPerspectivesToolbar()

setUndoMenu

public void setUndoMenu(IUndo undoInterface)

handleFileCapabilities

public void handleFileCapabilities(IHopFileType fileType,
                                   boolean changed,
                                   boolean running,
                                   boolean paused)

We're given a bunch of capabilities from IHopFileType In this method we'll enable/disable menu and toolbar items

Parameters:

fileType - The type of file to handle giving you its capabilities to take into account from IHopFileType or set by a plugin

changed - set this to true if the file content has changed

running - set this to true if the current file is running

paused - set this to true if the current file is paused

getActiveFileTypeHandler

public IHopFileTypeHandler getActiveFileTypeHandler()

replaceKeyboardShortcutListeners

public void replaceKeyboardShortcutListeners(Object parentObject)

Replace the listeners based on the @GuiKeyboardShortcut annotations

Parameters:

parentObject - The parent object containing the annotations and methods

replaceKeyboardShortcutListeners

public void replaceKeyboardShortcutListeners(org.eclipse.swt.widgets.Control control,
                                             HopGuiKeyHandler keyHandler)

getMetadataProvider

public MultiMetadataProvider getMetadataProvider()

Gets metadataProvider

Specified by:

getMetadataProvider in interface IHasHopMetadataProvider

Returns:

value of metadataProvider

setMetadataProvider

public void setMetadataProvider(MultiMetadataProvider metadataProvider)

Specified by:

setMetadataProvider in interface IHasHopMetadataProvider

Parameters:

metadataProvider - The metadataProvider to set

getShell

public org.eclipse.swt.widgets.Shell getShell()

Gets shell

Returns:

value of shell

setShell

public void setShell(org.eclipse.swt.widgets.Shell shell)

getDisplay

public org.eclipse.swt.widgets.Display getDisplay()

Gets display

Returns:

value of display

getCommandLineArguments

public List<String> getCommandLineArguments()

Gets commandLineArguments

Returns:

value of commandLineArguments

setCommandLineArguments

public void setCommandLineArguments(List<String> commandLineArguments)

Parameters:

commandLineArguments - The commandLineArguments to set

getMainPerspectivesComposite

public org.eclipse.swt.widgets.Composite getMainPerspectivesComposite()

Gets mainPerspectivesComposite

Returns:

value of mainPerspectivesComposite

setMainPerspectivesComposite

public void setMainPerspectivesComposite(org.eclipse.swt.widgets.Composite mainPerspectivesComposite)

Parameters:

mainPerspectivesComposite - The mainPerspectivesComposite to set

getPerspectiveManager

public HopPerspectiveManager getPerspectiveManager()

Gets perspectiveManager

Returns:

value of perspectiveManager

setPerspectiveManager

public void setPerspectiveManager(HopPerspectiveManager perspectiveManager)

Parameters:

perspectiveManager - The perspectiveManager to set

getVariables

public IVariables getVariables()

Gets the variables

Returns:

value of variables

setVariables

public void setVariables(IVariables variables)

Parameters:

variables - The variables to set

getProps

public PropsUi getProps()

Gets props

Returns:

value of props

setProps

public void setProps(PropsUi props)

Parameters:

props - The props to set

getLog

public ILogChannel getLog()

Gets log

Returns:

value of log

getMainMenu

public org.eclipse.swt.widgets.Menu getMainMenu()

Gets mainMenu

Returns:

value of mainMenu

setMainMenu

public void setMainMenu(org.eclipse.swt.widgets.Menu mainMenu)

Parameters:

mainMenu - The mainMenu to set

getMainToolbar

public org.eclipse.swt.widgets.ToolBar getMainToolbar()

Gets mainToolbar

Returns:

value of mainToolbar

setMainToolbar

public void setMainToolbar(org.eclipse.swt.widgets.ToolBar mainToolbar)

Parameters:

mainToolbar - The mainToolbar to set

getPerspectivesToolbar

public org.eclipse.swt.widgets.ToolBar getPerspectivesToolbar()

Gets perspectivesToolbar

Returns:

value of perspectivesToolbar

setPerspectivesToolbar

public void setPerspectivesToolbar(org.eclipse.swt.widgets.ToolBar perspectivesToolbar)

Parameters:

perspectivesToolbar - The perspectivesToolbar to set

getMainHopGuiComposite

public org.eclipse.swt.widgets.Composite getMainHopGuiComposite()

Gets mainHopGuiComposite

Returns:

value of mainHopGuiComposite

setMainHopGuiComposite

public void setMainHopGuiComposite(org.eclipse.swt.widgets.Composite mainHopGuiComposite)

Parameters:

mainHopGuiComposite - The mainHopGuiComposite to set

setActivePerspective

public void setActivePerspective(IHopPerspective perspective)

Parameters:

perspective - The perspective to active

isActivePerspective

public boolean isActivePerspective(IHopPerspective perspective)

getContextHandlers

public List<IGuiContextHandler> getContextHandlers()

What are the contexts to consider: - the file types registered - the available metadata types

Specified by:

getContextHandlers in interface IActionContextHandlersProvider

Returns:

The list of context handlers

setParametersAsVariablesInUI

public void setParametersAsVariablesInUI(INamedParameterDefinitions namedParameters,
                                         IVariables variables)

getActivePipelineGraph

public static HopGuiPipelineGraph getActivePipelineGraph()

Convenience method to pick up the active pipeline graph

Returns:

The active pipeline graph or null if none is active

getActiveWorkflowGraph

public static HopGuiWorkflowGraph getActiveWorkflowGraph()

getDataOrchestrationPerspective

public static HopDataOrchestrationPerspective getDataOrchestrationPerspective()

getMetadataPerspective

public static MetadataPerspective getMetadataPerspective()

getExecutionPerspective

public static ExecutionPerspective getExecutionPerspective()

getExplorerPerspective

public static ExplorerPerspective getExplorerPerspective()

getConfigurationPerspective

public static ConfigurationPerspective getConfigurationPerspective()

getSearchablesLocations

public List<ISearchablesLocation> getSearchablesLocations()

Create a list of all the searcheables locations. By default this means HopGui, the the current metadata

Specified by:

getSearchablesLocations in interface ISearchableProvider

Returns:

editConfigFile

public static boolean editConfigFile(org.eclipse.swt.widgets.Shell shell,
                                     String configFilename,
                                     DescribedVariablesConfigFile variablesConfigFile,
                                     String selectedVariable)
                              throws HopException

Throws:

HopException

previousPerspective

@GuiKeyboardShortcut(control=true,
                     shift=true,
                     key=16777217)
@GuiOsxKeyboardShortcut(command=true,
                        shift=true,
                        key=16777217)
public void previousPerspective()

nextPerspective

@GuiKeyboardShortcut(control=true,
                     shift=true,
                     key=16777218)
@GuiOsxKeyboardShortcut(command=true,
                        shift=true,
                        key=16777218)
public void nextPerspective()

getDatabaseMetaManager

public MetadataManager<DatabaseMeta> getDatabaseMetaManager()

Gets databaseMetaManager

Returns:

value of databaseMetaManager

setDatabaseMetaManager

public void setDatabaseMetaManager(MetadataManager<DatabaseMeta> databaseMetaManager)

Parameters:

databaseMetaManager - The databaseMetaManager to set

getPartitionManager

public MetadataManager<PartitionSchema> getPartitionManager()

Gets partitionManager

Returns:

value of partitionManager

setPartitionManager

public void setPartitionManager(MetadataManager<PartitionSchema> partitionManager)

Parameters:

partitionManager - The partitionManager to set

getFileDelegate

public HopGuiFileDelegate getFileDelegate()

Gets fileDelegate

Returns:

value of fileDelegate

setFileDelegate

public void setFileDelegate(HopGuiFileDelegate fileDelegate)

Parameters:

fileDelegate - The fileDelegate to set

getUndoDelegate

public HopGuiUndoDelegate getUndoDelegate()

Gets undoDelegate

Returns:

value of undoDelegate

setUndoDelegate

public void setUndoDelegate(HopGuiUndoDelegate undoDelegate)

Parameters:

undoDelegate - The undoDelegate to set

getActivePerspective

public IHopPerspective getActivePerspective()

Gets activePerspective

Returns:

value of activePerspective

getLoggingObject

public ILoggingObject getLoggingObject()

Gets loggingObject

Returns:

value of loggingObject

getMainMenuWidgets

public GuiMenuWidgets getMainMenuWidgets()

Gets mainMenuWidgets

Returns:

value of mainMenuWidgets

setMainMenuWidgets

public void setMainMenuWidgets(GuiMenuWidgets mainMenuWidgets)

Parameters:

mainMenuWidgets - The mainMenuWidgets to set

getMainToolbarWidgets

public GuiToolbarWidgets getMainToolbarWidgets()

Gets mainToolbarWidgets

Returns:

value of mainToolbarWidgets

setMainToolbarWidgets

public void setMainToolbarWidgets(GuiToolbarWidgets mainToolbarWidgets)

Parameters:

mainToolbarWidgets - The mainToolbarWidgets to set

isOpeningLastFiles

public boolean isOpeningLastFiles()

Gets openingLastFiles

Returns:

value of openingLastFiles

setOpeningLastFiles

public void setOpeningLastFiles(boolean openingLastFiles)

Parameters:

openingLastFiles - The openingLastFiles to set

getId

public String getId()

Gets the unique id of this HopGui instance

Returns:

value of id

getEventsHandler

public HopGuiEventsHandler getEventsHandler()

Gets eventsHandler

Returns:

value of eventsHandler

setEventsHandler

public void setEventsHandler(HopGuiEventsHandler eventsHandler)

Parameters:

eventsHandler - The eventsHandler to set

isReOpeningFiles

public boolean isReOpeningFiles()

Gets reOpeningFiles

Returns:

value of reOpeningFiles

setReOpeningFiles

public void setReOpeningFiles(boolean reOpeningFiles)

Sets reOpeningFiles

Parameters:

reOpeningFiles - value of reOpeningFiles