Package org.apache.hop.ui.hopgui.welcome

Class WelcomeDialogOptions

java.lang.Object

org.apache.hop.ui.hopgui.welcome.WelcomeDialogOptions

All Implemented Interfaces:

IConfigOptions, IGuiPluginCompositeWidgetsListener

@ConfigPlugin(id="WelcomeDialogOption",
              description="Enable or disable the welcome dialog")
@GuiPlugin(description="i18n::WelcomeDialog.Description")
public class WelcomeDialogOptions
extends Object
implements IConfigOptions, IGuiPluginCompositeWidgetsListener

Field Summary

Fields

Modifier and Type	Field	Description
protected static Class<?>	PKG

Constructor Summary

Constructors

Constructor	Description
WelcomeDialogOptions()

Method Summary

Modifier and Type	Method	Description
static WelcomeDialogOptions	getInstance()
boolean	handleOption(ILogChannel log, IHasHopMetadataProvider hasHopMetadataProvider, IVariables variables)
boolean	isWelcomeDialogDisabled()	Gets welcomeDialogDisabled
boolean	isWelcomeDialogEnabled()	Gets welcomeDialogEnabled
boolean	isWelcomeDialogShowAtStartup()	Gets welcomeDialogShowAtStartup
void	persistContents(GuiCompositeWidgets compositeWidgets)	Will be called when the changed data needs to be persisted
void	setWelcomeDialogDisabled(boolean welcomeDialogDisabled)	Sets welcomeDialogDisabled
void	setWelcomeDialogEnabled(boolean welcomeDialogEnabled)	Sets welcomeDialogEnabled
void	setWelcomeDialogShowAtStartup(boolean welcomeDialogShowAtStartup)	Sets welcomeDialogShowAtStartup
void	widgetModified(GuiCompositeWidgets compositeWidgets, org.eclipse.swt.widgets.Control changedWidget, String widgetId)	This method is called when a widget was modified
void	widgetsCreated(GuiCompositeWidgets compositeWidgets)	This method is called when all the widgets are created
void	widgetsPopulated(GuiCompositeWidgets compositeWidgets)	This method is called when all the widgets have received data, right before they're shown

Methods inherited from class java.lang.Object

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

Field Detail

PKG

protected static Class<?> PKG

Constructor Detail

WelcomeDialogOptions

public WelcomeDialogOptions()

Method Detail

getInstance

public static WelcomeDialogOptions getInstance()

handleOption

public boolean handleOption(ILogChannel log,
                            IHasHopMetadataProvider hasHopMetadataProvider,
                            IVariables variables)
                     throws HopException

Specified by:

handleOption in interface IConfigOptions

Throws:

HopException

isWelcomeDialogDisabled

public boolean isWelcomeDialogDisabled()

Gets welcomeDialogDisabled

Returns:

value of welcomeDialogDisabled

setWelcomeDialogDisabled

public void setWelcomeDialogDisabled(boolean welcomeDialogDisabled)

Sets welcomeDialogDisabled

Parameters:

welcomeDialogDisabled - value of welcomeDialogDisabled

isWelcomeDialogEnabled

public boolean isWelcomeDialogEnabled()

Gets welcomeDialogEnabled

Returns:

value of welcomeDialogEnabled

setWelcomeDialogEnabled

public void setWelcomeDialogEnabled(boolean welcomeDialogEnabled)

Sets welcomeDialogEnabled

Parameters:

welcomeDialogEnabled - value of welcomeDialogEnabled

isWelcomeDialogShowAtStartup

public boolean isWelcomeDialogShowAtStartup()

Gets welcomeDialogShowAtStartup

Returns:

value of welcomeDialogShowAtStartup

setWelcomeDialogShowAtStartup

public void setWelcomeDialogShowAtStartup(boolean welcomeDialogShowAtStartup)

Sets welcomeDialogShowAtStartup

Parameters:

welcomeDialogShowAtStartup - value of welcomeDialogShowAtStartup

widgetsCreated

public void widgetsCreated(GuiCompositeWidgets compositeWidgets)

Description copied from interface: IGuiPluginCompositeWidgetsListener

This method is called when all the widgets are created

Specified by:

widgetsCreated in interface IGuiPluginCompositeWidgetsListener

widgetsPopulated

public void widgetsPopulated(GuiCompositeWidgets compositeWidgets)

Description copied from interface: IGuiPluginCompositeWidgetsListener

This method is called when all the widgets have received data, right before they're shown

Specified by:

widgetsPopulated in interface IGuiPluginCompositeWidgetsListener

widgetModified

public void widgetModified(GuiCompositeWidgets compositeWidgets,
                           org.eclipse.swt.widgets.Control changedWidget,
                           String widgetId)

Description copied from interface: IGuiPluginCompositeWidgetsListener

This method is called when a widget was modified

Specified by:

widgetModified in interface IGuiPluginCompositeWidgetsListener

Parameters:

compositeWidgets - All the widgets to reference

changedWidget - The widget that got changed

widgetId - The ID of the widget changed.

persistContents

public void persistContents(GuiCompositeWidgets compositeWidgets)

Description copied from interface: IGuiPluginCompositeWidgetsListener

Will be called when the changed data needs to be persisted

Specified by:

persistContents in interface IGuiPluginCompositeWidgetsListener

Parameters:

compositeWidgets - The widgets