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

Class HopSearchPerspective

java.lang.Object

org.apache.hop.ui.hopgui.perspective.search.HopSearchPerspective

All Implemented Interfaces:

IActionContextHandlersProvider, IHopPerspective

@HopPerspectivePlugin(id="400-HopSearchPerspective",
                      name="i18n::HopSearchPerspective.Name",
                      description="i18n::HopSearchPerspective.Description",
                      image="ui/images/search.svg")
@GuiPlugin(description="i18n::HopSearchPerspective.GuiPlugin.Description")
public class HopSearchPerspective
extends Object
implements IHopPerspective

Field Summary

Fields

Modifier and Type	Field	Description
static String	AUDIT_TYPE_SEARCH_LOCATION
static String	AUDIT_TYPE_SEARCH_STRING
static String	ID_PERSPECTIVE_TOOLBAR_ITEM

Constructor Summary

Constructors

Constructor	Description
HopSearchPerspective()

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, ...
List<IGuiContextHandler>	getContextHandlers()
org.eclipse.swt.widgets.Control	getControl()
HopGui	getHopGui()	Gets hopGui
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.
void	setHopGui(HopGui hopGui)

Methods inherited from class java.lang.Object

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

Field Detail

ID_PERSPECTIVE_TOOLBAR_ITEM

public static final String ID_PERSPECTIVE_TOOLBAR_ITEM

See Also:

Constant Field Values

AUDIT_TYPE_SEARCH_LOCATION

public static final String AUDIT_TYPE_SEARCH_LOCATION

See Also:

Constant Field Values

AUDIT_TYPE_SEARCH_STRING

public static final String AUDIT_TYPE_SEARCH_STRING

See Also:

Constant Field Values

Constructor Detail

HopSearchPerspective

public HopSearchPerspective()

Method Detail

getId

public String getId()

Specified by:

getId in interface IHopPerspective

activate

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

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

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

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

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

hasNavigationPreviousFile

public boolean hasNavigationPreviousFile()

Specified by:

hasNavigationPreviousFile in interface IHopPerspective

hasNavigationNextFile

public boolean hasNavigationNextFile()

Specified by:

hasNavigationNextFile in interface IHopPerspective

getHopGui

public HopGui getHopGui()

Gets hopGui

Returns:

value of hopGui

setHopGui

public void setHopGui(HopGui hopGui)

Parameters:

hopGui - The hopGui to set

getControl

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

Specified by:

getControl in interface IHopPerspective

Returns:

The control of this perspective

getContextHandlers

public List<IGuiContextHandler> getContextHandlers()

Specified by:

getContextHandlers in interface IActionContextHandlersProvider

getSearchables

public List<ISearchable> getSearchables()

Specified by:

getSearchables in interface IHopPerspective

Returns:

A list of searchable items