org.openide.explorer.propertysheet

Class PropertySheet

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.openide.explorer.propertysheet.PropertySheet

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

PropertySheetView

public class PropertySheet
extends JPanel

Implements a property sheet for a set of nodes. Can be used as a standalone component (e.g. without a connection to ExplorerManager). For example to display properties of a JavaBean one could use:

 Object bean = ...;
 JPanel container = ...;
 PropertySheet ps = new PropertySheet();
 ps.setNodes(new Node[] { new BeanNode(bean) });
 container.add(ps);
 

Note that this class should be final, but for backward compatibility, cannot be. Subclassing this class is strongly discouraged

See Also:

Serialized Form

Nested Class Summary

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 and Description
static int	ALWAYS_AS_STRING Deprecated. Relic of the original property sheet implementation, useless.
protected static Icon	iAlphaSort Deprecated. Presumably noone uses this variable. If you want to customize the property sheet look you can change the image files directly (or use your own).
protected static Icon	iCustomize Deprecated. Presumably noone uses this variable. If you want to customize the property sheet look you can change the image files directly (or use your own).
protected static Icon	iDisplayWritableOnly Deprecated. Presumably noone uses this variable. If you want to customize the property sheet look you can change the image files directly (or use your own).
protected static Icon	iNoSort Deprecated. Presumably noone uses this variable. If you want to customize the property sheet look you can change the image files directly (or use your own).
protected static Icon	iTypeSort Deprecated. Presumably noone uses this variable. If you want to customize the property sheet look you can change the image files directly (or use your own).
static int	PAINTING_PREFERRED Deprecated. Relic of the original property sheet implementation, does useless.
static String	PROPERTY_CURRENT_PAGE Deprecated. Relic of the original property sheet implementation, , will never be fired.
static String	PROPERTY_DISABLED_PROPERTY_COLOR Deprecated. Relic of the original property sheet implementation, , will never be fired.
static String	PROPERTY_DISPLAY_WRITABLE_ONLY Deprecated. Relic of the original property sheet implementation, will never be fired.
static String	PROPERTY_PLASTIC Deprecated. Relic of the original property sheet implementation, , will never be fired.
static String	PROPERTY_PROPERTY_PAINTING_STYLE Deprecated. Relic of the original property sheet implementation, will never be fired.
static String	PROPERTY_SORTING_MODE Deprecated. Relic of the original property sheet implementation, will never be fired.
static String	PROPERTY_VALUE_COLOR Deprecated. Relic of the original property sheet implementation, will never be fired.
static int	SORTED_BY_NAMES Constant for by-name sorting mode.
static int	SORTED_BY_TYPES Deprecated. Not supported since NetBeans 3.6
static int	STRING_PREFERRED Deprecated. Relic of the original property sheet implementation, does useless.
static int	UNSORTED Constant for unsorted sorting mode.

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

Constructor and Description
PropertySheet() Create a new property sheet

Method Summary

Modifier and Type	Method and Description
void	addNotify()
protected JPopupMenu	createPopupMenu() Subclasses may override this method to create a custom popup menu that will show on right-click in the property sheet.
void	firePropertyChange(String propertyName, boolean oldValue, boolean newValue)
int	getCurrentPage() Deprecated. Relic of the original property sheet implementation. Does nothing.
Color	getDisabledPropertyColor() Deprecated. Relic of the original property sheet implementation. Display of properties is handled by the look and feel.
boolean	getDisplayWritableOnly() Deprecated. Relic of the original property sheet implementation. Does nothing.
boolean	getPlastic() Deprecated. Relic of the original property sheet implementation. Does nothing.
int	getPropertyPaintingStyle() Deprecated. Relic of the original property sheet implementation. Does nothing.
protected FeatureDescriptor	getSelection() Retrieve currently selected property or PropertySet.
int	getSortingMode() Get the sorting mode.
Color	getValueColor() Deprecated. Relic of the original property sheet implementation. Display of properties is handled by the look and feel.
protected boolean	isExpanded(FeatureDescriptor fd) Check if the PropertySet the given property belongs to is expanded or not.
boolean	isQuickSearchAllowed()
void	removeNotify()
void	requestFocus() Overridden to route focus requests to the table
boolean	requestFocusInWindow() Overridden to route focus requests to the table
void	setCurrentPage(int index) Deprecated. Relic of the original property sheet implementation. Does nothing.
boolean	setCurrentPage(String str) Deprecated. Relic of the original property sheet implementation. Does nothing.
void	setDescriptionAreaVisible(boolean val) Set the visibility of the description area.
void	setDisabledPropertyColor(Color color) Deprecated. Relic of the original property sheet implementation. Does nothing.
void	setDisplayWritableOnly(boolean b) Deprecated. Relic of the original property sheet implementation. Does nothing.
void	setNodes(Node[] nodes) Set the nodes explored by this property sheet.
void	setPlastic(boolean plastic) Deprecated. Relic of the original property sheet implementation. Display of properties is handled by the look and feel.
void	setPopupEnabled(boolean val) Set whether or not the popup menu should be available on right-click.
void	setPropertyPaintingStyle(int style) Deprecated. Relic of the original property sheet implementation. Does nothing.
void	setQuickSearchAllowed(boolean isQuickSearchAllowed) Allows one to set whether or not the quick search feature should be enabled on this instance.
void	setSortingMode(int sortingMode) Set the sorting mode.
void	setValueColor(Color color) Deprecated. Relic of the original property sheet implementation. Display of properties is handled by the look and feel.
protected void	toggleExpanded(FeatureDescriptor fd) Expand or collapse the PropertySet the given property belongs to.
void	updateUI()

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, 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, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, 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

PROPERTY_SORTING_MODE

@Deprecated
public static final String PROPERTY_SORTING_MODE

Deprecated. Relic of the original property sheet implementation, will never be fired.

Deprecated - no code outside the property sheet should be interested in how items are sorted.

See Also:

Constant Field Values

PROPERTY_VALUE_COLOR

@Deprecated
public static final String PROPERTY_VALUE_COLOR

Deprecated. Relic of the original property sheet implementation, will never be fired.

Property giving current value color.

See Also:

Constant Field Values

PROPERTY_DISABLED_PROPERTY_COLOR

@Deprecated
public static final String PROPERTY_DISABLED_PROPERTY_COLOR

Deprecated. Relic of the original property sheet implementation, , will never be fired.

Property giving current disabled property color.

See Also:

Constant Field Values

PROPERTY_CURRENT_PAGE

@Deprecated
public static final String PROPERTY_CURRENT_PAGE

Deprecated. Relic of the original property sheet implementation, , will never be fired.

Property with the current page index.

See Also:

Constant Field Values

PROPERTY_PLASTIC

@Deprecated
public static final String PROPERTY_PLASTIC

Deprecated. Relic of the original property sheet implementation, , will never be fired.

Property for plastic mode.

See Also:

Constant Field Values

PROPERTY_PROPERTY_PAINTING_STYLE

@Deprecated
public static final String PROPERTY_PROPERTY_PAINTING_STYLE

Deprecated. Relic of the original property sheet implementation, will never be fired.

Property for the painting style.

See Also:

Constant Field Values

PROPERTY_DISPLAY_WRITABLE_ONLY

@Deprecated
public static final String PROPERTY_DISPLAY_WRITABLE_ONLY

Deprecated. Relic of the original property sheet implementation, will never be fired.

Property for whether only writable properties should be displayed.

See Also:

Constant Field Values

ALWAYS_AS_STRING

@Deprecated
public static final int ALWAYS_AS_STRING

Deprecated. Relic of the original property sheet implementation, useless.

Constant for showing properties as a string always.

See Also:

Constant Field Values

STRING_PREFERRED

@Deprecated
public static final int STRING_PREFERRED

Deprecated. Relic of the original property sheet implementation, does useless.

Constant for preferably showing properties as string.

See Also:

Constant Field Values

PAINTING_PREFERRED

@Deprecated
public static final int PAINTING_PREFERRED

Deprecated. Relic of the original property sheet implementation, does useless.

Constant for preferably painting property values.

See Also:

Constant Field Values

UNSORTED

public static final int UNSORTED

Constant for unsorted sorting mode.

See Also:

Constant Field Values

SORTED_BY_NAMES

public static final int SORTED_BY_NAMES

Constant for by-name sorting mode.

See Also:

Constant Field Values

SORTED_BY_TYPES

@Deprecated
public static final int SORTED_BY_TYPES

Deprecated. Not supported since NetBeans 3.6

Constant for by-type sorting mode.

See Also:

Constant Field Values

iNoSort

@Deprecated
protected static Icon iNoSort

Deprecated. Presumably noone uses this variable. If you want to customize the property sheet look you can change the image files directly (or use your own).

Icon for the toolbar.

iAlphaSort

@Deprecated
protected static Icon iAlphaSort

Deprecated. Presumably noone uses this variable. If you want to customize the property sheet look you can change the image files directly (or use your own).

Icon for the toolbar.

iTypeSort

@Deprecated
protected static Icon iTypeSort

Deprecated. Presumably noone uses this variable. If you want to customize the property sheet look you can change the image files directly (or use your own).

Icon for the toolbar.

iDisplayWritableOnly

@Deprecated
protected static Icon iDisplayWritableOnly

Deprecated. Presumably noone uses this variable. If you want to customize the property sheet look you can change the image files directly (or use your own).

Icon for the toolbar.

iCustomize

@Deprecated
protected static Icon iCustomize

Deprecated. Presumably noone uses this variable. If you want to customize the property sheet look you can change the image files directly (or use your own).

Icon for the toolbar.

Constructor Detail

PropertySheet

public PropertySheet()

Create a new property sheet

Method Detail

addNotify

public void addNotify()

Overrides:

addNotify in class JComponent

updateUI

public void updateUI()

Overrides:

updateUI in class JPanel

removeNotify

public void removeNotify()

Overrides:

removeNotify in class JComponent

isQuickSearchAllowed

public boolean isQuickSearchAllowed()

Returns:

true if the quick search feature is currently allowed, false otherwise. To be allowed, quick search must not have been disabled either globally or on this instance

Since:

6.37

setQuickSearchAllowed

public void setQuickSearchAllowed(boolean isQuickSearchAllowed)

Allows one to set whether or not the quick search feature should be enabled on this instance.

Parameters:

isQuickSearchAllowed - true if the quick search feature should be allowed on this instance, false otherwise.

Since:

6.37

setPopupEnabled

public final void setPopupEnabled(boolean val)

Set whether or not the popup menu should be available on right-click.

Parameters:

val - If true, right-clicking the property sheet will show a popup offering sorting options, show/hide description area, etc.

Since:

6.9

setDescriptionAreaVisible

public final void setDescriptionAreaVisible(boolean val)

Set the visibility of the description area.

Parameters:

val - Whether or not it should be visible

Since:

6.9

requestFocus

public void requestFocus()

Overridden to route focus requests to the table

Overrides:

requestFocus in class JComponent

requestFocusInWindow

public boolean requestFocusInWindow()

Overridden to route focus requests to the table

Overrides:

requestFocusInWindow in class JComponent

setNodes

public void setNodes(Node[] nodes)

Set the nodes explored by this property sheet.

Parameters:

nodes - nodes to be explored or null to clear the sheet

setPropertyPaintingStyle

@Deprecated
public void setPropertyPaintingStyle(int style)

Deprecated. Relic of the original property sheet implementation. Does nothing.

Deprecated, does nothing.

Parameters:

style - Irrelevant

getPropertyPaintingStyle

@Deprecated
public int getPropertyPaintingStyle()

Deprecated. Relic of the original property sheet implementation. Does nothing.

Deprecated, returns no meaningful value.

Returns:

the mode

See Also:

PropertySheet.setPropertyPaintingStyle(int)

setSortingMode

public void setSortingMode(int sortingMode)
                    throws PropertyVetoException

Set the sorting mode.

Parameters:

sortingMode - one of PropertySheet.UNSORTED or PropertySheet.SORTED_BY_NAMES. PropertySheet.SORTED_BY_TYPES is no longer supported.

Throws:

PropertyVetoException - if a value other than one of the defined sorting modes is set

getSortingMode

public int getSortingMode()

Get the sorting mode.

Returns:

the mode

See Also:

PropertySheet.setSortingMode(int)

setCurrentPage

@Deprecated
public void setCurrentPage(int index)

Deprecated. Relic of the original property sheet implementation. Does nothing.

Deprecated. Does nothing.

Parameters:

index - index of the page to select

setCurrentPage

@Deprecated
public boolean setCurrentPage(String str)

Deprecated. Relic of the original property sheet implementation. Does nothing.

Deprecated. Does nothing.

Parameters:

str - name of the tab to select

Returns:

always returns false

getCurrentPage

@Deprecated
public int getCurrentPage()

Deprecated. Relic of the original property sheet implementation. Does nothing.

Deprecated. Does nothing.

Returns:

index of currently selected page

setPlastic

@Deprecated
public void setPlastic(boolean plastic)

Deprecated. Relic of the original property sheet implementation. Display of properties is handled by the look and feel.

Deprecated. Does nothing.

Parameters:

plastic - true if so

getPlastic

@Deprecated
public boolean getPlastic()

Deprecated. Relic of the original property sheet implementation. Does nothing.

Test whether buttons in sheet are plastic.

Returns:

true if so

setValueColor

@Deprecated
public void setValueColor(Color color)

Deprecated. Relic of the original property sheet implementation. Display of properties is handled by the look and feel.

Deprecated. Does nothing.

Parameters:

color - the new color

getValueColor

@Deprecated
public Color getValueColor()

Deprecated. Relic of the original property sheet implementation. Display of properties is handled by the look and feel.

Deprecated. Does nothing.

Returns:

the color

setDisabledPropertyColor

@Deprecated
public void setDisabledPropertyColor(Color color)

Deprecated. Relic of the original property sheet implementation. Does nothing.

Deprecated. Does nothing.

Parameters:

color - the new color

getDisabledPropertyColor

@Deprecated
public Color getDisabledPropertyColor()

Deprecated. Relic of the original property sheet implementation. Display of properties is handled by the look and feel.

Deprecated. Does not return a meaningful value.

Returns:

the color

setDisplayWritableOnly

@Deprecated
public void setDisplayWritableOnly(boolean b)

Deprecated. Relic of the original property sheet implementation. Does nothing.

Deprecated. Does nothing.

Parameters:

b - true if this is desired

getDisplayWritableOnly

@Deprecated
public boolean getDisplayWritableOnly()

Deprecated. Relic of the original property sheet implementation. Does nothing.

Deprecated. Does not return a meaningful value.

Returns:

true if so

createPopupMenu

protected JPopupMenu createPopupMenu()

Subclasses may override this method to create a custom popup menu that will show on right-click in the property sheet.

Returns:

Custom popup menu or null to use the default popup menu provided by this class.

Since:

6.47

isExpanded

protected final boolean isExpanded(FeatureDescriptor fd)

Check if the PropertySet the given property belongs to is expanded or not.

Parameters:

fd - Property or PropertySet to check.

Returns:

True if the PropertySet the given property belongs is expanded.

Since:

6.47

toggleExpanded

protected final void toggleExpanded(FeatureDescriptor fd)

Expand or collapse the PropertySet the given property belongs to.

Parameters:

fd -

Since:

6.47

getSelection

protected final FeatureDescriptor getSelection()

Retrieve currently selected property or PropertySet.

Returns:

Selected property or PropertySet or null if there is no selection.

Since:

6.47

firePropertyChange

public void firePropertyChange(String propertyName,
                               boolean oldValue,
                               boolean newValue)

Overrides:

firePropertyChange in class JComponent