maspack.widgets

Class PropertyFrame

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

maspack.widgets.PropertyFrame

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants, Disposable, PropertyWindow

Direct Known Subclasses:

LegendDisplay

public class PropertyFrame
extends javax.swing.JFrame
implements java.awt.event.ActionListener, PropertyWindow

See Also:

Serialized Form

Nested Class Summary

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

java.awt.Window.Type

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

java.awt.Component.BaselineResizeBehavior

Field Summary

Fields inherited from class javax.swing.JFrame

EXIT_ON_CLOSE

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 javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
PropertyFrame(java.lang.String name)
PropertyFrame(java.lang.String name, java.lang.String options)
PropertyFrame(java.lang.String name, java.lang.String options, PropertyPanel panel)

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e)
void	addGlobalValueChangeListener(ValueChangeListener l) Add a value change listener to all property widgets in this window and its owned windows.
OptionPanel	addOptionPanel(java.lang.String options)
OptionPanel	addOptionPanel(java.lang.String[] opts)
java.awt.Component	addWidget(java.awt.Component comp)
LabeledComponentBase	addWidget(HasProperties host, java.lang.String name)
LabeledComponentBase	addWidget(HasProperties host, java.lang.String name, double min, double max)
LabeledComponentBase	addWidget(Property prop)
LabeledComponentBase	addWidget(Property prop, double min, double max)
LabeledComponentBase	addWidget(java.lang.String labelText, HasProperties host, java.lang.String name)
LabeledComponentBase	addWidget(java.lang.String labelText, HasProperties host, java.lang.String name, double min, double max)
void	dispose() Dispose of all resources used by this object.
void	enableLiveUpdating(boolean enable)
ValueChangeListener[]	getGlobalValueChangeListeners() Get an array of all the global value change listeners defined for this window.
OptionPanel	getOptionPanel()
PropertyPanel	getPropertyPanel()
int	getReturnValue()
java.lang.Object	getSynchronizeObject() Gets the object (if any) with which property widget value changes are synchronized.
java.awt.Component	getWidget(int idx)
java.awt.Component[]	getWidgets()
boolean	isLiveUpdatingEnabled() If true, then the workspace should continuously update the property values whenever the model is rerendered.
boolean	isScrollable()
void	locateRight(java.awt.Component comp)
void	removeGlobalValueChangeListener(ValueChangeListener l) Remove a value change listener from all property widgets in this window and its owned windows.
void	setScrollable(boolean scrollable)
void	setSynchronizeObject(java.lang.Object syncObj) Sets an object with which property widget value changes are synchronized.
java.lang.String	toString()
void	updateWidgetValues() Update the value of all property widgets in this window and its owned windows.

Methods inherited from class javax.swing.JFrame

getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, 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, 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, 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, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, dispatchEvent, enable, enable, enableInputMethods, 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, getPeer, 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, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Constructor Detail

PropertyFrame

public PropertyFrame(java.lang.String name)

PropertyFrame

public PropertyFrame(java.lang.String name,
                     java.lang.String options)

PropertyFrame

public PropertyFrame(java.lang.String name,
                     java.lang.String options,
                     PropertyPanel panel)

Method Detail

addOptionPanel

public OptionPanel addOptionPanel(java.lang.String options)

addOptionPanel

public OptionPanel addOptionPanel(java.lang.String[] opts)

getOptionPanel

public OptionPanel getOptionPanel()

setScrollable

public void setScrollable(boolean scrollable)

isScrollable

public boolean isScrollable()

addWidget

public java.awt.Component addWidget(java.awt.Component comp)

addWidget

public LabeledComponentBase addWidget(Property prop)

addWidget

public LabeledComponentBase addWidget(Property prop,
                                      double min,
                                      double max)

addWidget

public LabeledComponentBase addWidget(HasProperties host,
                                      java.lang.String name)

addWidget

public LabeledComponentBase addWidget(HasProperties host,
                                      java.lang.String name,
                                      double min,
                                      double max)

addWidget

public LabeledComponentBase addWidget(java.lang.String labelText,
                                      HasProperties host,
                                      java.lang.String name)

addWidget

public LabeledComponentBase addWidget(java.lang.String labelText,
                                      HasProperties host,
                                      java.lang.String name,
                                      double min,
                                      double max)

getWidgets

public java.awt.Component[] getWidgets()

getWidget

public java.awt.Component getWidget(int idx)

getPropertyPanel

public PropertyPanel getPropertyPanel()

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Specified by:

actionPerformed in interface java.awt.event.ActionListener

getReturnValue

public int getReturnValue()

toString

public java.lang.String toString()

Overrides:

toString in class java.awt.Component

dispose

public void dispose()

Description copied from interface: PropertyWindow

Dispose of all resources used by this object.

Specified by:

dispose in interface Disposable

Specified by:

dispose in interface PropertyWindow

Overrides:

dispose in class java.awt.Window

updateWidgetValues

public void updateWidgetValues()

Description copied from interface: PropertyWindow

Update the value of all property widgets in this window and its owned windows.

Specified by:

updateWidgetValues in interface PropertyWindow

addGlobalValueChangeListener

public void addGlobalValueChangeListener(ValueChangeListener l)

Description copied from interface: PropertyWindow

Add a value change listener to all property widgets in this window and its owned windows.

Specified by:

addGlobalValueChangeListener in interface PropertyWindow

removeGlobalValueChangeListener

public void removeGlobalValueChangeListener(ValueChangeListener l)

Description copied from interface: PropertyWindow

Remove a value change listener from all property widgets in this window and its owned windows.

Specified by:

removeGlobalValueChangeListener in interface PropertyWindow

getGlobalValueChangeListeners

public ValueChangeListener[] getGlobalValueChangeListeners()

Description copied from interface: PropertyWindow

Get an array of all the global value change listeners defined for this window.

Specified by:

getGlobalValueChangeListeners in interface PropertyWindow

getSynchronizeObject

public java.lang.Object getSynchronizeObject()

Description copied from interface: PropertyWindow

Gets the object (if any) with which property widget value changes are synchronized.

Specified by:

getSynchronizeObject in interface PropertyWindow

Returns:

synchronization object for this window

setSynchronizeObject

public void setSynchronizeObject(java.lang.Object syncObj)

Description copied from interface: PropertyWindow

Sets an object with which property widget value changes are synchronized. The synchronization is used for all property widgets in this window and its owned windows.

Specified by:

setSynchronizeObject in interface PropertyWindow

Parameters:

syncObj - new synchronization object for this window

locateRight

public void locateRight(java.awt.Component comp)

isLiveUpdatingEnabled

public boolean isLiveUpdatingEnabled()

Description copied from interface: PropertyWindow

If true, then the workspace should continuously update the property values whenever the model is rerendered.

Specified by:

isLiveUpdatingEnabled in interface PropertyWindow

enableLiveUpdating

public void enableLiveUpdating(boolean enable)