Package adams.gui.application

Class AbstractBootstrappPreferencesPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

adams.gui.core.BasePanel

adams.gui.application.AbstractPreferencesPanel

adams.gui.application.AbstractBootstrappPreferencesPanel

All Implemented Interfaces:

adams.gui.application.PreferencesPanel, ImageObserver, MenuContainer, Serializable, Comparable<adams.gui.application.PreferencesPanel>, Accessible

Direct Known Subclasses:

RenjinSettingsPanel

public abstract class AbstractBootstrappPreferencesPanel
extends adams.gui.application.AbstractPreferencesPanel

Ancestor for panels that allow managing of dependencies for bootstrapp.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
protected adams.gui.core.BaseHtmlEditorPane	m_EditorPaneInfo	the label with the option info text.
protected adams.gui.goe.GenericArrayEditorPanel	m_PanelArtifacts	the artifacts.
protected adams.gui.goe.GenericArrayEditorPanel	m_PanelExclusions	the exclusions.
protected JPanel	m_PanelInfo	the panel with optional info text.
protected adams.gui.core.ParameterPanel	m_PanelParameters	the parameters.
protected adams.gui.goe.GenericArrayEditorPanel	m_PanelRepositories	the repositories.
protected adams.core.Properties	m_Properties	the properties.

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor	Description
AbstractBootstrappPreferencesPanel()

Method Summary

Modifier and Type	Method	Description
String	activate()	Activates the setup.
boolean	canReset()	Returns whether the panel supports resetting the options.
protected com.github.fracpete.bootstrapp.Main	configureBootstrapp(adams.core.Properties props)	Configures the bootstrap instance to use.
protected adams.core.base.MavenArtifact[]	getArtifacts()	Returns the artifacts to display.
protected abstract String	getDefaultInfoText()	The default info text to display (gets converted to HTML automatically).
protected adams.core.base.MavenArtifactExclusion[]	getExclusions()	Returns the exclusions to display.
String	getInfoText()	Returns the current info text.
protected abstract String	getOutputDir()	Returns the directory to use for the libraries.
protected adams.core.Properties	getProperties()	Returns the properties and reads them from disk if necessary.
protected abstract String	getPropertiesFile()	Returns the name of the properties file to load.
protected adams.core.base.MavenRepository[]	getRepositories()	Returns the repositories to display.
protected void	initGUI()	Initializes the members.
boolean	requiresWrapper()	Returns whether the panel requires a wrapper scrollpane/panel for display.
String	reset()	Resets the settings to their default.
void	setInfoText(String value)	Sets the info text to display (gets converted to HTML automatically).
protected adams.core.Properties	toProperties()	Turns the parameters in the GUI into a properties object.

Methods inherited from class adams.gui.application.AbstractPreferencesPanel

compareTo, equals, getPanels, getTitle

Methods inherited from class adams.gui.core.BasePanel

afterHide, afterShow, beforeHide, beforeShow, closeParent, finishInit, getParentChild, getParentDialog, getParentFrame, getParentInternalFrame, getParentTitle, initialize, main, printErrorMessage, printException, setEnabledCascade, setEnabledCascade, setParentTitle, setVisible

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

m_PanelInfo

protected JPanel m_PanelInfo

the panel with optional info text.

m_EditorPaneInfo

protected adams.gui.core.BaseHtmlEditorPane m_EditorPaneInfo

the label with the option info text.

m_PanelParameters

protected adams.gui.core.ParameterPanel m_PanelParameters

the parameters.

m_PanelArtifacts

protected adams.gui.goe.GenericArrayEditorPanel m_PanelArtifacts

the artifacts.

m_PanelExclusions

protected adams.gui.goe.GenericArrayEditorPanel m_PanelExclusions

the exclusions.

m_PanelRepositories

protected adams.gui.goe.GenericArrayEditorPanel m_PanelRepositories

the repositories.

m_Properties

protected adams.core.Properties m_Properties

the properties.

Constructor Detail

AbstractBootstrappPreferencesPanel

public AbstractBootstrappPreferencesPanel()

Method Detail

initGUI

protected void initGUI()

Initializes the members.

Overrides:

initGUI in class adams.gui.core.BasePanel

getDefaultInfoText

protected abstract String getDefaultInfoText()

The default info text to display (gets converted to HTML automatically).

Returns:

the text, null to disable

setInfoText

public void setInfoText(String value)

Sets the info text to display (gets converted to HTML automatically).

Parameters:

value - the text, null or empty string to hide

getInfoText

public String getInfoText()

Returns the current info text.

Returns:

the text

getPropertiesFile

protected abstract String getPropertiesFile()

Returns the name of the properties file to load.

Returns:

the filename (no path)

getProperties

protected adams.core.Properties getProperties()

Returns the properties and reads them from disk if necessary.

Returns:

the properties to use

getArtifacts

protected adams.core.base.MavenArtifact[] getArtifacts()

Returns the artifacts to display.

Returns:

the artifacts

getExclusions

protected adams.core.base.MavenArtifactExclusion[] getExclusions()

Returns the exclusions to display.

Returns:

the artifacts

getRepositories

protected adams.core.base.MavenRepository[] getRepositories()

Returns the repositories to display.

Returns:

the repositories

getOutputDir

protected abstract String getOutputDir()

Returns the directory to use for the libraries.

Returns:

the full path

toProperties

protected adams.core.Properties toProperties()

Turns the parameters in the GUI into a properties object.

Returns:

the properties

requiresWrapper

public boolean requiresWrapper()

Returns whether the panel requires a wrapper scrollpane/panel for display.

Specified by:

requiresWrapper in interface adams.gui.application.PreferencesPanel

Specified by:

requiresWrapper in class adams.gui.application.AbstractPreferencesPanel

Returns:

true if wrapper required

configureBootstrapp

protected com.github.fracpete.bootstrapp.Main configureBootstrapp(adams.core.Properties props)
                                                           throws Exception

Configures the bootstrap instance to use.

Parameters:

props - the properties to use

Returns:

the configured instance

Throws:

Exception

activate

public String activate()

Activates the setup.

Specified by:

activate in interface adams.gui.application.PreferencesPanel

Specified by:

activate in class adams.gui.application.AbstractPreferencesPanel

Returns:

null if successfully activated, otherwise error message

canReset

public boolean canReset()

Returns whether the panel supports resetting the options.

Specified by:

canReset in interface adams.gui.application.PreferencesPanel

Overrides:

canReset in class adams.gui.application.AbstractPreferencesPanel

Returns:

true if supported

reset

public String reset()

Resets the settings to their default.

Specified by:

reset in interface adams.gui.application.PreferencesPanel

Overrides:

reset in class adams.gui.application.AbstractPreferencesPanel

Returns:

null if successfully reset, otherwise error message