Package org.apache.hop.ui.core.dialog

Class ContextDialog

java.lang.Object

org.eclipse.swt.widgets.Dialog

org.apache.hop.ui.core.dialog.ContextDialog

@GuiPlugin(description="This dialog presents you all the actions you can take in a given context")
public class ContextDialog
extends org.eclipse.swt.widgets.Dialog

Field Summary

Fields

Modifier and Type	Field	Description
static String	AUDIT_NAME_CATEGORY_STATES
static String	AUDIT_TYPE_CONTEXT_DIALOG
static String	AUDIT_TYPE_TOOLBAR_FIXED_WIDTH
static String	AUDIT_TYPE_TOOLBAR_SHOW_CATEGORIES
static String	CATEGORY_OTHER
static String	GUI_PLUGIN_TOOLBAR_PARENT_ID
static Class<?>	PKG
static String	TOOLBAR_ITEM_CLEAR_SEARCH
static String	TOOLBAR_ITEM_COLLAPSE_ALL
static String	TOOLBAR_ITEM_ENABLE_CATEGORIES
static String	TOOLBAR_ITEM_EXPAND_ALL
static String	TOOLBAR_ITEM_FIXED_WIDTH

Constructor Summary

Constructors

Constructor	Description
ContextDialog(org.eclipse.swt.widgets.Shell parent, String title, Point location, List<GuiAction> actions, String contextId)

Method Summary

Modifier and Type	Method	Description
void	collapseAll()
void	dispose()
void	enableDisableCategories()
void	enableDisableFixedWidth()
void	expandAll()
void	filter(String text)
static ContextDialog	getInstance()	Gets the currently active instance
org.eclipse.swt.widgets.Text	getSearchTextWidget()	Gets the search text widget
boolean	isCtrlClicked()	Gets ctrlClicked
boolean	isDisposed()
boolean	isFocusLost()	Gets focusLost
boolean	isShiftClicked()	Gets shiftClicked
GuiAction	open()
void	setCtrlClicked(boolean ctrlClicked)
void	setFocusLost(boolean focusLost)
void	setShiftClicked(boolean shiftClicked)

Methods inherited from class org.eclipse.swt.widgets.Dialog

checkSubclass, getParent, getStyle, getText, setText

Methods inherited from class java.lang.Object

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

Field Detail

PKG

public static final Class<?> PKG

CATEGORY_OTHER

public static final String CATEGORY_OTHER

See Also:

Constant Field Values

GUI_PLUGIN_TOOLBAR_PARENT_ID

public static final String GUI_PLUGIN_TOOLBAR_PARENT_ID

See Also:

Constant Field Values

TOOLBAR_ITEM_COLLAPSE_ALL

public static final String TOOLBAR_ITEM_COLLAPSE_ALL

See Also:

Constant Field Values

TOOLBAR_ITEM_EXPAND_ALL

public static final String TOOLBAR_ITEM_EXPAND_ALL

See Also:

Constant Field Values

TOOLBAR_ITEM_ENABLE_CATEGORIES

public static final String TOOLBAR_ITEM_ENABLE_CATEGORIES

See Also:

Constant Field Values

TOOLBAR_ITEM_FIXED_WIDTH

public static final String TOOLBAR_ITEM_FIXED_WIDTH

See Also:

Constant Field Values

TOOLBAR_ITEM_CLEAR_SEARCH

public static final String TOOLBAR_ITEM_CLEAR_SEARCH

See Also:

Constant Field Values

AUDIT_TYPE_TOOLBAR_SHOW_CATEGORIES

public static final String AUDIT_TYPE_TOOLBAR_SHOW_CATEGORIES

See Also:

Constant Field Values

AUDIT_TYPE_TOOLBAR_FIXED_WIDTH

public static final String AUDIT_TYPE_TOOLBAR_FIXED_WIDTH

See Also:

Constant Field Values

AUDIT_TYPE_CONTEXT_DIALOG

public static final String AUDIT_TYPE_CONTEXT_DIALOG

See Also:

Constant Field Values

AUDIT_NAME_CATEGORY_STATES

public static final String AUDIT_NAME_CATEGORY_STATES

See Also:

Constant Field Values

Constructor Detail

ContextDialog

public ContextDialog(org.eclipse.swt.widgets.Shell parent,
                     String title,
                     Point location,
                     List<GuiAction> actions,
                     String contextId)

Method Detail

open

public GuiAction open()

getInstance

public static ContextDialog getInstance()

Gets the currently active instance

Returns:

The currently active instance or null if the dialog is not showing.

isDisposed

public boolean isDisposed()

dispose

public void dispose()

collapseAll

@GuiToolbarElement(root="ContextDialog-Toolbar",
                   id="ContextDialog-Toolbar-10010-CollapseAll",
                   toolTip="i18n::ContextDialog.GuiAction.CollapseCategories.Tooltip",
                   image="ui/images/collapse-all.svg")
public void collapseAll()

expandAll

@GuiToolbarElement(root="ContextDialog-Toolbar",
                   id="ContextDialog-Toolbar-10020-ExpandAll",
                   toolTip="i18n::ContextDialog.GuiAction.ExpandCategories.Tooltip",
                   image="ui/images/expand-all.svg")
public void expandAll()

enableDisableCategories

@GuiToolbarElement(root="ContextDialog-Toolbar",
                   id="ContextDialog-Toolbar-10030-EnableCategories",
                   label="i18n::ContextDialog.GuiAction.ShowCategories.Label",
                   toolTip="i18n::ContextDialog.GuiAction.ShowCategories.Tooltip",
                   type=CHECKBOX)
public void enableDisableCategories()

enableDisableFixedWidth

@GuiToolbarElement(root="ContextDialog-Toolbar",
                   id="ContextDialog-Toolbar-10040-FixedWidth",
                   label="i18n::ContextDialog.GuiAction.FixedWidth.Label",
                   toolTip="i18n::ContextDialog.GuiAction.FixedWidth.Tooltip",
                   type=CHECKBOX)
public void enableDisableFixedWidth()

getSearchTextWidget

public org.eclipse.swt.widgets.Text getSearchTextWidget()

Gets the search text widget

Returns:

the search text widget

filter

public void filter(String text)

isShiftClicked

public boolean isShiftClicked()

Gets shiftClicked

Returns:

value of shiftClicked

setShiftClicked

public void setShiftClicked(boolean shiftClicked)

Parameters:

shiftClicked - The shiftClicked to set

isCtrlClicked

public boolean isCtrlClicked()

Gets ctrlClicked

Returns:

value of ctrlClicked

setCtrlClicked

public void setCtrlClicked(boolean ctrlClicked)

Parameters:

ctrlClicked - The ctrlClicked to set

isFocusLost

public boolean isFocusLost()

Gets focusLost

Returns:

value of focusLost

setFocusLost

public void setFocusLost(boolean focusLost)

Parameters:

focusLost - The focusLost to set