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

Class ConfigurationPerspective

java.lang.Object

org.apache.hop.ui.hopgui.perspective.configuration.ConfigurationPerspective

All Implemented Interfaces:

IActionContextHandlersProvider, IHopPerspective, TabClosable

@HopPerspectivePlugin(id="160-HopConfigurationPerspective",
                      name="i18n::ConfigurationPerspective.Name",
                      description="i18n::ConfigurationPerspective.Description",
                      image="ui/images/gear.svg")
@GuiPlugin(description="i18n::HopConfigurationPerspective.GuiPlugin.Description")
public class ConfigurationPerspective
extends Object
implements IHopPerspective, TabClosable

Field Summary

Fields

Modifier and Type	Field	Description
static String	CONFIG_PERSPECTIVE_TABS
org.eclipse.swt.custom.CTabFolder	configTabs

Constructor Summary

Constructors

Constructor	Description
ConfigurationPerspective()

Method Summary

Modifier and Type	Method	Description
void	activate()	Switch to this perspective (shown).
void	closeTab(org.eclipse.swt.custom.CTabFolderEvent event, org.eclipse.swt.custom.CTabItem tabItem)	Close the tab on the perspective
IHopFileTypeHandler	getActiveFileTypeHandler()	Get the active file type handler capable of saving, executing, printing, ...
List<IGuiContextHandler>	getContextHandlers()
org.eclipse.swt.widgets.Control	getControl()
String	getId()
static ConfigurationPerspective	getInstance()
List<TabItemHandler>	getItems()	Get the list of tabs handled by and currently open in the perspective
List<org.eclipse.swt.custom.CTabItem>	getOtherTabs(org.eclipse.swt.custom.CTabItem selectedTabItem)	Get all the other tabs of the selected one
List<ISearchable>	getSearchables()
List<IHopFileType>	getSupportedHopFileTypes()	Get a list of supported file types for this perspective
org.eclipse.swt.custom.CTabFolder	getTabFolder()	Get the tabFolder of the perspective
List<org.eclipse.swt.custom.CTabItem>	getTabsToLeft(org.eclipse.swt.custom.CTabItem selectedTabItem)	Get all the tabs on the left-hand side of the selected one
List<org.eclipse.swt.custom.CTabItem>	getTabsToRight(org.eclipse.swt.custom.CTabItem selectedTabItem)	Get all the tabs on the right-hand side of the selected one
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.
void	showSystemVariablesTab()

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_PERSPECTIVE_TABS

public static final String CONFIG_PERSPECTIVE_TABS

See Also:

Constant Field Values

configTabs

public org.eclipse.swt.custom.CTabFolder configTabs

Constructor Detail

ConfigurationPerspective

public ConfigurationPerspective()

Method Detail

getInstance

public static ConfigurationPerspective getInstance()

getContextHandlers

public List<IGuiContextHandler> getContextHandlers()

Specified by:

getContextHandlers in interface IActionContextHandlersProvider

getId

public String getId()

Specified by:

getId in interface IHopPerspective

getActiveFileTypeHandler

public IHopFileTypeHandler getActiveFileTypeHandler()

Description copied from interface: IHopPerspective

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

Specified by:

getActiveFileTypeHandler in interface IHopPerspective

Returns:

The active file type handler

setActiveFileTypeHandler

public void setActiveFileTypeHandler(IHopFileTypeHandler activeFileTypeHandler)

Description copied from interface: IHopPerspective

Set the focus on the given file type handler.

Specified by:

setActiveFileTypeHandler in interface IHopPerspective

getSupportedHopFileTypes

public List<IHopFileType> getSupportedHopFileTypes()

Description copied from interface: IHopPerspective

Get a list of supported file types for this perspective

Specified by:

getSupportedHopFileTypes in interface IHopPerspective

Returns:

The list of supported file types

activate

@GuiKeyboardShortcut(control=true,
                     shift=true,
                     key=99)
@GuiOsxKeyboardShortcut(command=true,
                        shift=true,
                        key=99)
public void activate()

Description copied from interface: IHopPerspective

Switch to this perspective (shown).

Specified by:

activate in interface IHopPerspective

perspectiveActivated

public void perspectiveActivated()

Description copied from interface: IHopPerspective

Notify this perspective that it has been activated.

Specified by:

perspectiveActivated in interface IHopPerspective

navigateToPreviousFile

public void navigateToPreviousFile()

Description copied from interface: IHopPerspective

Navigate the file usage history to the previous file

Specified by:

navigateToPreviousFile in interface IHopPerspective

navigateToNextFile

public void navigateToNextFile()

Description copied from interface: IHopPerspective

Navigate the file usage history to the next file

Specified by:

navigateToNextFile in interface IHopPerspective

isActive

public boolean isActive()

Description copied from interface: IHopPerspective

See if this perspective is active (shown)

Specified by:

isActive in interface IHopPerspective

Returns:

True if the perspective is currently shown

initialize

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

Description copied from interface: IHopPerspective

Initialize this perspective

Specified by:

initialize in interface IHopPerspective

Parameters:

hopGui - The parent Hop GUI

showSystemVariablesTab

public void showSystemVariablesTab()

hasNavigationPreviousFile

public boolean hasNavigationPreviousFile()

Specified by:

hasNavigationPreviousFile in interface IHopPerspective

hasNavigationNextFile

public boolean hasNavigationNextFile()

Specified by:

hasNavigationNextFile in interface IHopPerspective

getControl

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

Specified by:

getControl in interface IHopPerspective

Returns:

The control of this perspective

remove

public boolean remove(IHopFileTypeHandler typeHandler)

Description copied from interface: IHopPerspective

Remove this file type handler from the perspective

Specified by:

remove in interface IHopPerspective

Parameters:

typeHandler - The file type handler to remove

Returns:

getItems

public List<TabItemHandler> getItems()

Description copied from interface: IHopPerspective

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

Specified by:

getItems in interface IHopPerspective

Returns:

The list of tab items

getSearchables

public List<ISearchable> getSearchables()

Specified by:

getSearchables in interface IHopPerspective

Returns:

A list of searchable items

closeTab

public void closeTab(org.eclipse.swt.custom.CTabFolderEvent event,
                     org.eclipse.swt.custom.CTabItem tabItem)

Description copied from interface: TabClosable

Close the tab on the perspective

Specified by:

closeTab in interface TabClosable

getTabsToRight

public List<org.eclipse.swt.custom.CTabItem> getTabsToRight(org.eclipse.swt.custom.CTabItem selectedTabItem)

Description copied from interface: TabClosable

Get all the tabs on the right-hand side of the selected one

Specified by:

getTabsToRight in interface TabClosable

getTabsToLeft

public List<org.eclipse.swt.custom.CTabItem> getTabsToLeft(org.eclipse.swt.custom.CTabItem selectedTabItem)

Description copied from interface: TabClosable

Get all the tabs on the left-hand side of the selected one

Specified by:

getTabsToLeft in interface TabClosable

getOtherTabs

public List<org.eclipse.swt.custom.CTabItem> getOtherTabs(org.eclipse.swt.custom.CTabItem selectedTabItem)

Description copied from interface: TabClosable

Get all the other tabs of the selected one

Specified by:

getOtherTabs in interface TabClosable

getTabFolder

public org.eclipse.swt.custom.CTabFolder getTabFolder()

Description copied from interface: TabClosable

Get the tabFolder of the perspective

Specified by:

getTabFolder in interface TabClosable