Package com.jme3.awt

Class AWTSettingsDialog

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

com.jme3.awt.AWTSettingsDialog

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

public final class AWTSettingsDialog
extends JFrame

SettingsDialog displays a Swing dialog box to interactively configure the AppSettings of a desktop application before start() is invoked. The AppSettings instance to be configured is passed to the constructor.

Author:

Mark Powell, Eric Woroshow, Joshua Slack - reworked for proper use of GL commands.

See Also:

• AppSettings
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AWTSettingsDialog.SelectionListener

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

JFrame.AccessibleJFrame

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

Frame.AccessibleAWTFrame

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

Window.AccessibleAWTWindow, Window.Type

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
static final int	APPROVE_SELECTION
static final int	CANCEL_SELECTION
static final int	NO_SELECTION

Fields inherited from class javax.swing.JFrame

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

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

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AWTSettingsDialog(com.jme3.system.AppSettings source, String imageFile, boolean loadSettings)	Instantiate a SettingsDialog for the primary display.
protected	AWTSettingsDialog(com.jme3.system.AppSettings source, URL imageFile, boolean loadSettings)	/** Instantiate a SettingsDialog for the primary display.

Method Summary

Modifier and Type	Method	Description
int	getMinHeight()
int	getMinWidth()
int	getUserSelection()
void	setImage(String image)	setImage sets the background image of the dialog.
void	setImage(URL image)	setImage sets the background image of this dialog.
void	setMinHeight(int minHeight)
void	setMinWidth(int minWidth)
void	setSelectionListener(AWTSettingsDialog.SelectionListener sl)
void	showDialog()	showDialog sets this dialog as visible, and brings it to the front.
static boolean	showDialog(com.jme3.system.AppSettings sourceSettings)
static boolean	showDialog(com.jme3.system.AppSettings sourceSettings, boolean loadSettings)
static boolean	showDialog(com.jme3.system.AppSettings sourceSettings, String imageFile, boolean loadSettings)
static boolean	showDialog(com.jme3.system.AppSettings sourceSettings, URL imageFile, boolean loadSettings)

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, 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 java.awt.MenuContainer

getFont, postEvent

Field Details

NO_SELECTION

public static final int NO_SELECTION

See Also:

• Constant Field Values

APPROVE_SELECTION

public static final int APPROVE_SELECTION

See Also:

• Constant Field Values

CANCEL_SELECTION

public static final int CANCEL_SELECTION

See Also:

• Constant Field Values

Constructor Details

AWTSettingsDialog

protected AWTSettingsDialog(com.jme3.system.AppSettings source,
 String imageFile,
 boolean loadSettings)

Instantiate a SettingsDialog for the primary display.

Parameters:

source - the AppSettings (not null)

imageFile - the image file to use as the title of the dialog; null will result in to image being displayed

loadSettings - if true, copy the settings, otherwise merge them

Throws:

IllegalArgumentException - if the source is null

AWTSettingsDialog

protected AWTSettingsDialog(com.jme3.system.AppSettings source,
 URL imageFile,
 boolean loadSettings)

/** Instantiate a SettingsDialog for the primary display.

Parameters:

source - the AppSettings object (not null)

imageFile - the image file to use as the title of the dialog; null will result in to image being displayed

loadSettings - if true, copy the settings, otherwise merge them

Throws:

IllegalArgumentException - if the source is null

Method Details

showDialog

public static boolean showDialog(com.jme3.system.AppSettings sourceSettings)

showDialog

public static boolean showDialog(com.jme3.system.AppSettings sourceSettings,
 boolean loadSettings)

showDialog

public static boolean showDialog(com.jme3.system.AppSettings sourceSettings,
 String imageFile,
 boolean loadSettings)

showDialog

public static boolean showDialog(com.jme3.system.AppSettings sourceSettings,
 URL imageFile,
 boolean loadSettings)

setSelectionListener

public void setSelectionListener(AWTSettingsDialog.SelectionListener sl)

getUserSelection

public int getUserSelection()

getMinWidth

public int getMinWidth()

setMinWidth

public void setMinWidth(int minWidth)

getMinHeight

public int getMinHeight()

setMinHeight

public void setMinHeight(int minHeight)

setImage

public void setImage(String image)

setImage sets the background image of the dialog.

Parameters:

image - String representing the image file.

setImage

public void setImage(URL image)

setImage sets the background image of this dialog.

Parameters:

image - URL pointing to the image file.

showDialog

public void showDialog()

showDialog sets this dialog as visible, and brings it to the front.