Package net.mcreator.ui.modgui

Class ModElementGUI<GE extends GeneratableElement>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

net.mcreator.ui.views.ViewBase

net.mcreator.ui.modgui.ModElementGUI<GE>

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, IHelpContext, ISearchable, ITextFieldSearchable

Direct Known Subclasses:

AchievementGUI, ArmorGUI, AttributeGUI, BannerPatternGUI, BiomeGUI, BlockGUI, CommandGUI, CustomElementGUI, CustomGUIGUI, DamageTypeGUI, DimensionGUI, EnchantmentGUI, FeatureGUI, FluidGUI, FunctionGUI, GameRuleGUI, ItemExtensionGUI, ItemGUI, KeyBindGUI, LivingEntityGUI, LootTableGUI, OverlayGUI, PaintingGUI, ParticleGUI, PlantGUI, PotionEffectGUI, PotionGUI, ProcedureGUI, ProjectileGUI, RecipeGUI, StructureGUI, TabGUI, ToolGUI, VillagerProfessionGUI, VillagerTradeGUI

public abstract class ModElementGUI<GE extends GeneratableElement>
extends ViewBase
implements IHelpContext, ITextFieldSearchable

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ModElementGUI.ModElementCreatedListener<GE extends GeneratableElement>

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 final ModElement	modElement

Fields inherited from class net.mcreator.ui.views.ViewBase

mcreator

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 net.mcreator.ui.help.IHelpContext

NONE

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor	Description
ModElementGUI(MCreator mcreator, ModElement modElement, boolean editingMode)

Method Summary

Modifier and Type	Method	Description
final ModElementGUIPage	addPage(String name, JComponent component)
final ModElementGUIPage	addPage(String name, JComponent component, boolean scroll)
final ModElementGUIPage	addPage(JComponent component)
final ModElementGUIPage	addPage(JComponent component, boolean scroll)
protected void	afterGeneratableElementGenerated()
protected void	afterGeneratableElementStored()
protected boolean	allowCodePreview()
String	contextName()
abstract URI	contextURL()
protected final void	finalizeGUI()
abstract GE	getElementFromGUI()
ModElement	getModElement()
JTextComponent	getSearchTextField()
ImageIcon	getViewIcon()
String	getViewName()
protected abstract void	initGUI()
final boolean	isEditingMode()
void	onViewClosed()
protected abstract void	openInEditingMode(GE generatableElement)	This method is called to open a mod element in the GUI
void	reloadDataLists()
void	setModElementCreatedListener(ModElementGUI.ModElementCreatedListener<GE> modElementCreatedListener)
void	setTargetFolder(FolderElement targetFolder)
ViewBase	showView()
final AggregatedValidationResult	validateAllPages()
IHelpContext	withEntry(String entry)

Methods inherited from class net.mcreator.ui.views.ViewBase

getMCreator

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, 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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.mcreator.ui.help.IHelpContext

entry, owner

Methods inherited from interface net.mcreator.ui.search.ITextFieldSearchable

search

Field Details

modElement

@Nonnull
protected final ModElement modElement

Constructor Details

ModElementGUI

public ModElementGUI(MCreator mcreator,
 @Nonnull
 ModElement modElement,
 boolean editingMode)

Method Details

addPage

public final ModElementGUIPage addPage(JComponent component)

addPage

public final ModElementGUIPage addPage(JComponent component,
 boolean scroll)

addPage

public final ModElementGUIPage addPage(String name,
 JComponent component)

addPage

public final ModElementGUIPage addPage(String name,
 JComponent component,
 boolean scroll)

setTargetFolder

public void setTargetFolder(@Nullable
 FolderElement targetFolder)

setModElementCreatedListener

public void setModElementCreatedListener(ModElementGUI.ModElementCreatedListener<GE> modElementCreatedListener)

getViewName

public String getViewName()

Specified by:

getViewName in class ViewBase

getViewIcon

public ImageIcon getViewIcon()

Overrides:

getViewIcon in class ViewBase

showView

public ViewBase showView()

Overrides:

showView in class ViewBase

finalizeGUI

protected final void finalizeGUI()

getModElement

@Nonnull
public ModElement getModElement()

initGUI

protected abstract void initGUI()

afterGeneratableElementStored

protected void afterGeneratableElementStored()

afterGeneratableElementGenerated

protected void afterGeneratableElementGenerated()

allowCodePreview

protected boolean allowCodePreview()

onViewClosed

public void onViewClosed()

reloadDataLists

public void reloadDataLists()

getSearchTextField

public JTextComponent getSearchTextField()

Specified by:

getSearchTextField in interface ITextFieldSearchable

openInEditingMode

protected abstract void openInEditingMode(GE generatableElement)

This method is called to open a mod element in the GUI

getElementFromGUI

public abstract GE getElementFromGUI()

isEditingMode

public final boolean isEditingMode()

validateAllPages

public final AggregatedValidationResult validateAllPages()

contextName

@Nullable
public String contextName()

Specified by:

contextName in interface IHelpContext

withEntry

@Nullable
public IHelpContext withEntry(String entry)

Specified by:

withEntry in interface IHelpContext

contextURL

@Nullable
public abstract URI contextURL()
                        throws URISyntaxException

Specified by:

contextURL in interface IHelpContext

Throws:

URISyntaxException