com.github.sbugat.rundeckmonitor.wizard

Class WizardPanelDescriptor

java.lang.Object

com.github.sbugat.rundeckmonitor.wizard.WizardPanelDescriptor

Direct Known Subclasses:

MonitorConfigurationWizardPanelDescriptor, ProjectConfigurationWizardPanelDescriptor, RundeckConfigurationWizardPanelDescriptor

public abstract class WizardPanelDescriptor
extends Object

Generic wizard panel with a next and previous step.

Author:

Sylvain bugat

Field Summary

Fields

Modifier and Type	Field and Description
private ConfigurationWizardStep	back Previous panel or null.
private ConfigurationWizardStep	next Next panel or null.
private ConfigurationWizardStep	panelIdentifier Panel identifier.
private RundeckMonitorConfiguration	rundeckMonitorConfiguration RunDeck monitor configuration.

Constructor Summary

Constructors

Constructor and Description
WizardPanelDescriptor(ConfigurationWizardStep panelIdentifierArg, ConfigurationWizardStep backArg, ConfigurationWizardStep nextArg, RundeckMonitorConfiguration rundeckMonitorConfigurationArg) Copyr arguments to constants.

Method Summary

Methods

Modifier and Type	Method and Description
void	aboutToDisplayPanel() Method called before diplaying a panel for dynamic content update.
ConfigurationWizardStep	getBack() Return the previous wizard panel or null.
ConfigurationWizardStep	getNext() Return the next wizard panel or null.
abstract Component	getPanelComponent() Get the main component of a panel.
ConfigurationWizardStep	getPanelDescriptorIdentifier() Get the panel identifier.
RundeckMonitorConfiguration	getRundeckMonitorConfiguration() Get the RunDeck monitor main configuration.
abstract boolean	validate() Default method to validate the wizard step, must return true if input data are valid.

Methods inherited from class java.lang.Object

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

Field Detail

panelIdentifier

private final ConfigurationWizardStep panelIdentifier

Panel identifier.

back

private final ConfigurationWizardStep back

Previous panel or null.

next

private final ConfigurationWizardStep next

Next panel or null.

rundeckMonitorConfiguration

private final RundeckMonitorConfiguration rundeckMonitorConfiguration

RunDeck monitor configuration.

Constructor Detail

WizardPanelDescriptor

public WizardPanelDescriptor(ConfigurationWizardStep panelIdentifierArg,
                     ConfigurationWizardStep backArg,
                     ConfigurationWizardStep nextArg,
                     RundeckMonitorConfiguration rundeckMonitorConfigurationArg)

Copyr arguments to constants.

Parameters:

panelIdentifierArg - panel identifier

backArg - previous panel or null if none

nextArg - next panel or null if none

rundeckMonitorConfigurationArg - RunDeck monitor configuration shared by all panels

Method Detail

getPanelComponent

public abstract Component getPanelComponent()

Get the main component of a panel.

Returns:

the main component

getPanelDescriptorIdentifier

public final ConfigurationWizardStep getPanelDescriptorIdentifier()

Get the panel identifier.

Returns:

the panel identifier

getRundeckMonitorConfiguration

public final RundeckMonitorConfiguration getRundeckMonitorConfiguration()

Get the RunDeck monitor main configuration.

Returns:

monitor configuration

getNext

public final ConfigurationWizardStep getNext()

Return the next wizard panel or null.

Returns:

next panel

getBack

public final ConfigurationWizardStep getBack()

Return the previous wizard panel or null.

Returns:

previous panel

aboutToDisplayPanel

public void aboutToDisplayPanel()

Method called before diplaying a panel for dynamic content update.

validate

public abstract boolean validate()

Default method to validate the wizard step, must return true if input data are valid.

Returns:

true if valid, false otherwise