org.tigris.gef.properties.ui
Class PropSheet

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JPanel
                  extended by org.tigris.gef.properties.ui.PropSheet
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.beans.PropertyChangeListener, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible
Direct Known Subclasses:
PropSheetCategory

public class PropSheet
extends javax.swing.JPanel
implements java.beans.PropertyChangeListener

Class that defines the interface for several different kinds of panels that can edit a group of properties. The only subclass supplied with GEF is PropSheetCategory, but others could be defined.

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.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
protected  boolean _autoApply
          True iff every change shold be immeadiatly carried out.
protected  java.util.Hashtable _editorsPds
           
protected  boolean _ignorePropChanges
           
protected  long _lastUpdateTime
           
protected  java.util.Hashtable _pdsEditors
           
protected  java.util.Hashtable _pendingStores
          The changes to that object that have not been carried out yet.
protected  java.awt.Font _propertiesFont
           
protected  java.lang.Object _sel
          The object being edited.
protected  java.lang.String _tabName
          Name used to identify this sheet to the user.
static int MIN_UPDATE
           
 
Fields inherited from class javax.swing.JComponent
accessibleContext, 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
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
PropSheet()
           
 
Method Summary
 void apply()
          Take all property changes that have been stored and actually change the state of the selected object.
protected  void applyProperty(java.beans.PropertyDescriptor pd, java.lang.Object value)
           
 boolean canEdit(java.lang.Object item)
           
 java.awt.Font getPropertiesFont()
           
 java.lang.String getTabName()
           
 void propertyChange(java.beans.PropertyChangeEvent e)
          The selected object may have changed one of its properties.
 void revert()
          Abandon any stored changes that have not been applied yet.
 void setAutoApply(boolean aa)
           
 void setPropertiesFont(java.awt.Font f)
           
 void setSelection(java.lang.Object s)
           
 void setTabName(java.lang.String tn)
           
 void setVisible(boolean b)
           
 void store(java.beans.PropertyDescriptor pd, java.lang.Object value)
          When the user changes a value in a widget, record that fact until the next apply (which may be done immeadiatly).
 void updateComponent(java.beans.PropertyDescriptor pd)
           
 void updateComponents()
           
 
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, 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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, 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, transferFocusBackward, 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, hide, 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, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

_sel

protected java.lang.Object _sel
The object being edited.


_pendingStores

protected java.util.Hashtable _pendingStores
The changes to that object that have not been carried out yet.


_pdsEditors

protected java.util.Hashtable _pdsEditors

_editorsPds

protected java.util.Hashtable _editorsPds

_autoApply

protected boolean _autoApply
True iff every change shold be immeadiatly carried out.


_ignorePropChanges

protected boolean _ignorePropChanges

_tabName

protected java.lang.String _tabName
Name used to identify this sheet to the user.


_propertiesFont

protected java.awt.Font _propertiesFont

_lastUpdateTime

protected long _lastUpdateTime

MIN_UPDATE

public static final int MIN_UPDATE
See Also:
Constant Field Values
Constructor Detail

PropSheet

public PropSheet()
Method Detail

setSelection

public void setSelection(java.lang.Object s)

setAutoApply

public void setAutoApply(boolean aa)

getTabName

public java.lang.String getTabName()

setTabName

public void setTabName(java.lang.String tn)

canEdit

public boolean canEdit(java.lang.Object item)

setVisible

public void setVisible(boolean b)
Overrides:
setVisible in class javax.swing.JComponent

getPropertiesFont

public java.awt.Font getPropertiesFont()

setPropertiesFont

public void setPropertiesFont(java.awt.Font f)

store

public void store(java.beans.PropertyDescriptor pd,
                  java.lang.Object value)
When the user changes a value in a widget, record that fact until the next apply (which may be done immeadiatly).


apply

public void apply()
Take all property changes that have been stored and actually change the state of the selected object.


applyProperty

protected void applyProperty(java.beans.PropertyDescriptor pd,
                             java.lang.Object value)

revert

public void revert()
Abandon any stored changes that have not been applied yet.


updateComponents

public void updateComponents()

updateComponent

public void updateComponent(java.beans.PropertyDescriptor pd)

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent e)
The selected object may have changed one of its properties.

Specified by:
propertyChange in interface java.beans.PropertyChangeListener