Package org.apache.hop.ui.hopgui.perspective

Interface IHopPerspective

All Superinterfaces:

IActionContextHandlersProvider

All Known Implementing Classes:

ConfigurationPerspective, EmptyHopPerspective, ExecutionPerspective, ExplorerPerspective, HopDataOrchestrationPerspective, HopPluginExplorePerspective, HopSearchPerspective, MetadataPerspective

public interface IHopPerspective
extends IActionContextHandlersProvider

This interface describes the methods of a Hop GUI perspective.

Method Summary

Modifier and Type	Method	Description
void	activate()	Switch to this perspective (shown).
IHopFileTypeHandler	getActiveFileTypeHandler()	Get the active file type handler capable of saving, executing, printing, ...
org.eclipse.swt.widgets.Control	getControl()
String	getId()
List<TabItemHandler>	getItems()	Get the list of tabs handled by and currently open in the perspective
List<ISearchable>	getSearchables()
List<IHopFileType>	getSupportedHopFileTypes()	Get a list of supported file types for this perspective
boolean	hasNavigationNextFile()
boolean	hasNavigationPreviousFile()
void	initialize(HopGui hopGui, org.eclipse.swt.widgets.Composite parent)	Initialize this perspective
boolean	isActive()	See if this perspective is active (shown)
void	navigateToNextFile()	Navigate the file usage history to the next file
void	navigateToPreviousFile()	Navigate the file usage history to the previous file
void	perspectiveActivated()	Notify this perspective that it has been activated.
boolean	remove(IHopFileTypeHandler typeHandler)	Remove this file type handler from the perspective
void	setActiveFileTypeHandler(IHopFileTypeHandler activeFileTypeHandler)	Set the focus on the given file type handler.

Methods inherited from interface org.apache.hop.ui.hopgui.context.IActionContextHandlersProvider

getContextHandlers

Method Detail

getId

String getId()

getActiveFileTypeHandler

IHopFileTypeHandler getActiveFileTypeHandler()

Get the active file type handler capable of saving, executing, printing, ... a file

Returns:

The active file type handler

setActiveFileTypeHandler

void setActiveFileTypeHandler(IHopFileTypeHandler activeFileTypeHandler)

Set the focus on the given file type handler.

Parameters:

activeFileTypeHandler -

getSupportedHopFileTypes

List<IHopFileType> getSupportedHopFileTypes()

Get a list of supported file types for this perspective

Returns:

The list of supported file types

activate

void activate()

Switch to this perspective (shown).

perspectiveActivated

void perspectiveActivated()

Notify this perspective that it has been activated.

navigateToPreviousFile

void navigateToPreviousFile()

Navigate the file usage history to the previous file

navigateToNextFile

void navigateToNextFile()

Navigate the file usage history to the next file

isActive

boolean isActive()

See if this perspective is active (shown)

Returns:

True if the perspective is currently shown

initialize

void initialize(HopGui hopGui,
                org.eclipse.swt.widgets.Composite parent)

Initialize this perspective

Parameters:

hopGui - The parent Hop GUI

hasNavigationPreviousFile

boolean hasNavigationPreviousFile()

hasNavigationNextFile

boolean hasNavigationNextFile()

getControl

org.eclipse.swt.widgets.Control getControl()

Returns:

The control of this perspective

remove

boolean remove(IHopFileTypeHandler typeHandler)

Remove this file type handler from the perspective

Parameters:

typeHandler - The file type handler to remove

Returns:

getItems

List<TabItemHandler> getItems()

Get the list of tabs handled by and currently open in the perspective

Returns:

The list of tab items

getSearchables

List<ISearchable> getSearchables()

Returns:

A list of searchable items