de.griefed.serverpackcreator.addons.swinggui

Class ExtensionConfigPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

de.griefed.serverpackcreator.addons.swinggui.ExtensionConfigPanel

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public abstract class ExtensionConfigPanel
extends javax.swing.JPanel

Template ConfigPanel for use in ConfigPanelExtension extensions.

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JPanel.AccessibleJPanel

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.logging.log4j.Logger	LOG
protected static org.apache.logging.log4j.Logger	LOG_ADDONS
protected java.util.ArrayList<com.electronwill.nightconfig.core.CommentedConfig>	SERVERPACK_EXTENSION_CONFIG

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

Modifier	Constructor and Description
protected	ExtensionConfigPanel(VersionMeta versionMeta, ApplicationProperties applicationProperties, Utilities utilities, TabCreateServerPack tabCreateServerPack, java.util.Optional<com.electronwill.nightconfig.core.CommentedConfig> addonConfig, java.lang.String extensionName, java.lang.String pluginID) Construct a panel which allows users to further customize their ServerPackCreator experience.

Method Summary

Modifier and Type	Method and Description
abstract void	clear() Clear the interface, or in other words, reset this extensions config panel UI.
protected java.util.Optional<com.electronwill.nightconfig.core.CommentedConfig>	getAddonConfig() The global configuration of the addon which provides this ConfigPanel extension.
protected ApplicationProperties	getApplicationProperties() Get the application properties which make up the current configuration of ServerPackCreator.
protected TabCreateServerPack	getTabCreateServerPack() Get the tab in which this ConfigPanel resides in, giving you access to various fields for further operations.
protected Utilities	getUtilities() Common utilities used across ServerPackCreator.
protected VersionMeta	getVersionMeta() Get the version meta used by ServerPackCreator, giving you access to Minecraft, Forge, Fabric, LegacyFabric and Quilt versions.
java.lang.String	pluginID() The ID of the addon providing this extension implementation.
abstract java.util.ArrayList<com.electronwill.nightconfig.core.CommentedConfig>	serverPackExtensionConfig() Retrieve this extensions server pack specific configuration.
abstract void	setServerPackExtensionConfig(java.util.ArrayList<com.electronwill.nightconfig.core.CommentedConfig> serverPackExtensionConfig) Pass the extension configuration to the configuration panel so it can then, in turn, load the available configurations and make them editable, if so desired.

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, setVisible, 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, getPeer, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.apache.logging.log4j.Logger LOG

LOG_ADDONS

protected static final org.apache.logging.log4j.Logger LOG_ADDONS

SERVERPACK_EXTENSION_CONFIG

protected final java.util.ArrayList<com.electronwill.nightconfig.core.CommentedConfig> SERVERPACK_EXTENSION_CONFIG

Constructor Detail

ExtensionConfigPanel

protected ExtensionConfigPanel(VersionMeta versionMeta,
                               ApplicationProperties applicationProperties,
                               Utilities utilities,
                               TabCreateServerPack tabCreateServerPack,
                               java.util.Optional<com.electronwill.nightconfig.core.CommentedConfig> addonConfig,
                               java.lang.String extensionName,
                               java.lang.String pluginID)

Construct a panel which allows users to further customize their ServerPackCreator experience.

Parameters:

versionMeta - Instance of VersionMeta so you can work with available Minecraft, Forge, Fabric, LegacyFabric and Quilt versions.

applicationProperties - Instance of Properties The current configuration of ServerPackCreator, like the default list of clientside-only mods, the server pack directory etc.

utilities - Instance of Utilities commonly used across ServerPackCreator.

tabCreateServerPack - Instance of TabCreateServerPack to give you access to the various fields inside it, like the modpack directory, selected Minecraft, modloader and modloader versions, etc.

addonConfig - Addon specific configuration conveniently provided by ServerPackCreator. This is the global configuration of the addon which provides the ConfigPanelExtension to ServerPackCreator.

extensionName - The name the titled border of this ConfigPanel will get.

pluginID - The ID of the addon providing this extension implementation. The pluginID determines which extension specific configurations are provided to this panel, and how they are stored in a given serverpackcreator.conf.

Method Detail

getAddonConfig

protected final java.util.Optional<com.electronwill.nightconfig.core.CommentedConfig> getAddonConfig()

The global configuration of the addon which provides this ConfigPanel extension. Wrapped in an Optional, so you can check beforehand whether a config is available.

Returns:

The global addon configuration, wrapped in an Optional.

pluginID

public final java.lang.String pluginID()

The ID of the addon providing this extension implementation. The pluginID determines which extension specific configurations are provided to this panel, and how they are stored in a given serverpackcreator.conf.

Returns:

The ID of the addon which provides this extension implementation.

serverPackExtensionConfig

public abstract java.util.ArrayList<com.electronwill.nightconfig.core.CommentedConfig> serverPackExtensionConfig()

Retrieve this extensions server pack specific configuration. When no configuration with configs for this extension has been loaded yet, the returned list is empty. Fill it with life!

Returns:

Config list to be used in subsequent server pack generation runs, by various other extensions.

setServerPackExtensionConfig

public abstract void setServerPackExtensionConfig(java.util.ArrayList<com.electronwill.nightconfig.core.CommentedConfig> serverPackExtensionConfig)

Pass the extension configuration to the configuration panel so it can then, in turn, load the available configurations and make them editable, if so desired.

Parameters:

serverPackExtensionConfig - The list of extension configurations to pass to the configuration panel.

getTabCreateServerPack

protected final TabCreateServerPack getTabCreateServerPack()

Get the tab in which this ConfigPanel resides in, giving you access to various fields for further operations.

Returns:

The server pack config tab in which this ConfigPanel resides in.

getVersionMeta

protected final VersionMeta getVersionMeta()

Get the version meta used by ServerPackCreator, giving you access to Minecraft, Forge, Fabric, LegacyFabric and Quilt versions.

Returns:

The version meta used by ServerPackCreator

getApplicationProperties

protected final ApplicationProperties getApplicationProperties()

Get the application properties which make up the current configuration of ServerPackCreator. The application properties contains various settings like the fallback list of clientside-only mods, the server pack directory in which server packs are generated and stored in, and more.

Returns:

The application properties which make up the current configuration of ServerPackCreator.

getUtilities

protected final Utilities getUtilities()

Common utilities used across ServerPackCreator.

Returns:

Utilities used across ServerPackCreator.

clear

public abstract void clear()

Clear the interface, or in other words, reset this extensions config panel UI. If your Config Panel Extensions has no elements you wish to reset, then simply overwrite this method with an empty method body.

The clear()-method is called when the owning TabCreateServerPack.clearInterface()-method is called.