edu.neu.ccs.gui
Class DisplayPanel

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  edu.neu.ccs.gui.DisplayPanel

All Implemented Interfaces:

Accessible, AlertListener, Displayable, EventListener, ImageObserver, JPTConstants, MalformedDataListener, MenuContainer, Serializable, SwingConstants

Direct Known Subclasses:

ActionsPanel, Annotation, ArrayPanel, BasePane, BufferedPanel, BufferedPanel.Painter, ColorView, Display, DisplayCollection, FileView, FontSampler, Halo, ImageViewerBase, JPFApplication, RequestImageViewer, RequestWebImageViewer, SimpleFunctionBuilder, SimpleFunctionBuilderWithIO, StringViewer, TablePanel, VisualColorList, VisualColorSampler, ZooContainer

public class DisplayPanel

extends JPanel

implements Displayable, MalformedDataListener, JPTConstants

A DisplayPanel is a JPanel that recursively propagates Displayable method calls only to contained components that are also Displayable.

This class is the base class for all panel-style containers provided by the JPT.

As of the 2.3.3, methods have been provided that permit a DisplayPanel to self-actualize, that is, to install inself in a window and open that window.

The various frame methods install this panel into a JPTFrame which is an extension of the Java class JFrame.

The various methods that have dialog in their name install this panel into a GeneralDialog which is an extension of the Java class JDialog.

Since no component should be installed in more than one frame or dialog, the user should take care to call at most one of the above methods and do this at most once while an object is alive. To support this rule and to ensure that the panel is installed in a window at construction, we recommend the following convention.

Convention: If you choose to call a frame or dialog method, do this either as the last line in a constructor or soon after the constructor returns.

Since the methods that install a DisplayPanel in a frame or dialog return that window, the caller may save the window reference and later close and reopen the window if desired.

As of 2.4.0, the class allows a caller to obtain an array of all Displayables installed in the panel.

As of 2.5.0, convenience methods were added to add borders based on the methods in class Borders.

Since:

1.0

Version:

2.5.0

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

protected Color	background Background color before alert status was entered.
protected String	codec Identifier for codec used by this panel.
static String	CODEC Bound property name for the codec property.

Fields inherited from class javax.swing.JPanel

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.Container

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface edu.neu.ccs.gui.Displayable

DEFAULT_VIEW_STATE, VIEW_STATE

Fields inherited from interface edu.neu.ccs.util.JPTConstants

ABOVE, ALIGNMENT, BELOW, BOTTOM_LEFT, BOTTOM_RIGHT, DEFAULT, FONT, INPUT_PROPERTIES, MANDATORY, OPTIONAL, ORIENTATION, TOP_LEFT, TOP_RIGHT, VALUE

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

DisplayPanel()
Constructs a panel with the default layout manager for a JPanel.

DisplayPanel(boolean isDoubleBuffered)
Constructs a panel with the default layout manager for a JPanel and the given double-buffering strategy.

DisplayPanel(LayoutManager layout)
Constructs a panel with the given layout manager.

DisplayPanel(LayoutManager layout, boolean isDoubleBuffered)
Constructs a panel with the given layout manager and the given double-buffering strategy.

Method Summary

Component	add(Component c) Adds the specified component to the end of this container.
Component	add(Component c, int index) Adds the specified component to this container at the given position.
void	add(Component c, Object constraints) Adds the specified component to the end of this container.
void	add(Component c, Object constraints, int index) Adds the specified component at the given position.
Component	add(String name, Component c) Adds the given component to this container.
Border	addBorder(Border border) Adds the given border as an outer wrapper around the current border of the component.
Component	addObject(Object object) Add the given object to this DisplayPanel at the next available position after applying the transformation of the method makeComponent.
Component	addObject(Object object, int index) Add the given object to this DisplayPanel at the given index position after applying the transformation of the method makeComponent.
Component	addObject(Object object, Object constraints) Add the given object to this DisplayPanel with the specified constaints at the next appropriate position after applying the transformation of the method makeComponent.
Component	addObject(Object object, Object constraints, int index) Add the given object to this DisplayPanel at the given index position after applying the transformation of the method makeComponent.
void	bevelBorderLowered() Adds a default lowered bevel border.
void	bevelBorderLowered(Color highlight, Color shadow) Adds a lowered bevel border with the given highlight and shadow colors.
void	bevelBorderLowered(Color highlightOuter, Color highlightInner, Color shadowInner, Color shadowOuter) Adds a lowered bevel border with the given colors.
void	bevelBorderLowered(int levels, Color highlight, Color shadow) Adds a lowered bevel border with the given parameters.
void	bevelBorderLowered(int levels, Color highlightOuter, Color highlightInner, Color shadowInner, Color shadowOuter) Adds a lowered bevel border with the given parameters.
void	bevelBorderRaised() Adds a raised bevel border.
void	bevelBorderRaised(Color highlight, Color shadow) Adds a raised bevel border with the given highlight and shadow colors.
void	bevelBorderRaised(Color highlightOuter, Color highlightInner, Color shadowInner, Color shadowOuter) Adds a raised bevel border with the given colors.
void	bevelBorderRaised(int levels, Color highlight, Color shadow) Adds a raised bevel border with the given parameters.
void	bevelBorderRaised(int levels, Color highlightOuter, Color highlightInner, Color shadowInner, Color shadowOuter) Adds a raised bevel border with the given parameters.
void	compoundBorder(Border[] borders) Adds a compound border constructed from the given array of borders.
void	compoundBorder(Border outer, Border inner) Adds a compound border constructed from the given outer and inner borders.
void	dataMalformed(MalformedDataEvent evt) Handles a malformed data event generated by a fragile input component by alerting the user through a change to the background color of the panel.
void	emptyBorder(int thickness) Adds an empty border with the given thickness.
void	emptyBorder(int vgap, int hgap) Adds an empty border with the given gaps.
void	emptyBorder(int top, int left, int bottom, int right) Adds an empty border with the given parameters.
void	endAlert(AlertEvent evt) Turns off alert status for this component and its children that are also AlertListeners.
void	etchBorderLowered() Adds a default lowered etch border.
void	etchBorderLowered(Color highlight, Color shadow) Adds a lowered etch border with the given highlight and shadow colors.
void	etchBorderLowered(int levels, Color highlight, Color shadow) Adds a lowered etch border with the given parameters.
void	etchBorderRaised() Adds a default raised etch border.
void	etchBorderRaised(Color highlight, Color shadow) Adds a raised etch border with the given highlight and shadow colors.
void	etchBorderRaised(int levels, Color highlight, Color shadow) Adds a raised etch border with the given parameters.
JPTFrame	frame() Frame this panel in a JPTFrame and open the frame; return the frame constructed.
JPTFrame	frame(int location) Frame this panel in a JPTFrame and open the frame; use the given location which should be either CENTER or one of the standard constants for one of the eight compass directions; return the frame constructed.
JPTFrame	frame(String title) Frame this panel in a JPTFrame and open the frame; use the given title for the frame; return the frame constructed.
JPTFrame	frame(String title, Insets insets) Frame this panel in a JPTFrame and open the frame; use the given title for the frame; use the given insets to inset the frame in the screen; return the frame constructed.
JPTFrame	frame(String title, int location) Frame this panel in a JPTFrame and open the frame; use the given title for the frame; use the given location which should be either CENTER or one of the standard constants for one of the eight compass directions; return the frame constructed.
JPTFrame	frame(String title, int location, Insets insets) Frame this panel in a JPTFrame and open the frame; use the given title for the frame; use the given location which should be either CENTER or one of the standard constants for one of the eight compass directions; use the given insets to inset the frame in the screen; return the frame constructed.
GeneralDialog	generalDialog(Object[][] actionData) Place this panel in a modal general dialog and open the dialog; use the action data to define the dialog buttons; return the dialog constructed.
GeneralDialog	generalDialog(Object[][] actionData, Object defaultAction) Place this panel in a modal general dialog and open the dialog; use the action data to define the dialog buttons; use the default action object to define the default button; return the dialog constructed.
GeneralDialog	generalDialog(String title, Object[][] actionData) Place this panel in a modal general dialog and open the dialog; use the given title for the dialog; use the action data to define the dialog buttons; return the dialog constructed.
GeneralDialog	generalDialog(String title, Object[][] actionData, Object defaultAction) Place this panel in a modal general dialog and open the dialog; use the given title for the dialog; use the action data to define the dialog buttons; use the default action object to define the default button; return the dialog constructed.
String	getCodec() Returns the identifier for the current CODEC to be used to combine multiple child view states into an encoded String.
String	getDefaultViewState() Returns the encoded default view state for the Displayable() objects in the panel.
String[]	getDefaultViewStates() Returns a String array of the default view states for the corresponding Displayable() items in the array returned by getDisplayables().
Displayable[]	getDisplayables() Returns an array of all Displayable objects installed as Components in this panel.
String	getViewState() Returns the encoded view state for the Displayable() objects in the panel.
String[]	getViewStates() Returns a String array of the view states for the corresponding Displayable() items in the array returned by getDisplayables().
void	lineBorder() Adds a line border with color black and thickness 1.
void	lineBorder(Color color) Adds a line border with the given color and thickness 1.
void	lineBorder(Color color, int thickness) Adds a line border with the given color and thickness.
void	lineBorder(int thickness) Adds a line border with color black and the given thickness.
Component	makeComponent(Object object) By default, this method will return the Component constructed using ComponentFactory.makeComponent.
void	matteBorder(int thickness, Color color) Adds a matte border with the given thickness and color.
void	matteBorder(int thickness, Icon tileicon) Adds a matte border with the given thickness and tileicon.
void	matteBorder(int vgap, int hgap, Color color) Adds a matte border with the given gaps and color.
void	matteBorder(int vgap, int hgap, Icon tileicon) Adds a matte border with the given gaps and tileicon.
void	matteBorder(int top, int left, int bottom, int right, Color color) Adds a matte border with the given parameters.
void	matteBorder(int top, int left, int bottom, int right, Icon tileicon) Adds a matte border with the given parameters.
GeneralDialog	OKCancelDialog() Place this panel in a modal OK-Cancel dialog and open the dialog; return the dialog constructed.
GeneralDialog	OKCancelDialog(String title) Place this panel in a modal OK-Cancel dialog and open the dialog; use the given title for the dialog; return the dialog constructed.
GeneralDialog	OKDialog() Place this panel in a modal OK dialog and open the dialog; return the dialog constructed.
GeneralDialog	OKDialog(String title) Place this panel in a modal OK dialog and open the dialog; use the given title for the dialog; return the dialog constructed.
void	refreshComponent() Refreshes the component by repacking the parent window.
void	remove(Component c) Removes the given component from this container.
void	remove(int index) Removes the component at the given index from this container.
void	removeAll() Removes all of the components from this container.
Border	removeBorder() Removes the current border and returns it.
void	reset() Recursively resets any Displayable objects held in the panel.
void	sandwichBorder(Border center, Border wrap) Adds a sandwich border with the given center border in the middle and the wrap border as outer and inner.
void	setCodec(String codecID) Sets the identifier for the CODEC to be used to combine multiple child view states into an encoded String.
void	setDeepBackground(Color c) Sets the background of this object to the given color; then sets the background of each component within this object to the same color using setDeepBackground recursively for each component that happens to extend DisplayPanel or JPTComponent.
void	setDeepBackground(Color c, Class type) Sets the background of all components in the hierarchy of this object that are instances of the given class.
void	setDefaultViewState(String data) Sets the default view states for the Displayable objects in the container to the data encoded in the given String.
void	setDefaultViewStates(String[] data) Sets the default view states for the Displayable objects in the container to the corresponding elements in the given array of Strings.
void	setEnabled(boolean isEnabled) Enables or disables the panel, and recursively enables or disables its contents, based on the given value.
void	setViewState(String data) Sets the view states for the Displayable objects in the container to the data encoded in the given String.
void	setViewStates(String[] data) Sets the view states for the Displayable objects in the container to the corresponding elements in the given array of Strings.
void	startAlert(AlertEvent evt) Turns on alert status for this component and its children that are also AlertListeners.
void	titleBorder(String t) Adds a title border with the given parameters.
void	titleBorder(String t, Border base) Adds a title border with the given parameters.
void	titleBorder(String t, Border base, Font font, Color fontcolor) Adds a title border with the given parameters.
void	titleBorder(String t, Font font, Color fontcolor) Adds a title border with the given parameters.
void	titleBorder(String t, int hPosition, int vPosition) Adds a title border with the given parameters.
void	titleBorder(String t, int hPosition, int vPosition, Border base) Adds a title border with the given parameters.
void	titleBorder(String t, int hPosition, int vPosition, Border base, Font font, Color fontcolor) Adds a title border with the given parameters.
void	titleBorder(String t, int hPosition, int vPosition, Font font, Color fontcolor) Adds a title border with the given parameters.
void	uniformizeHeight() Sets the preferred height for all JComponents in this panel to the same height.
void	uniformizeSize() Sets the preferred size for all JComponents in this panel to the same preferred size.
void	uniformizeWidth() Sets the preferred width for all JComponents in this panel to the same width.
GeneralDialog	YesNoCancelDialog() Place this panel in a modal Yes-No-Cancel dialog and open the dialog; return the dialog constructed.
GeneralDialog	YesNoCancelDialog(String title) Place this panel in a modal Yes-No-Cancel dialog and open the dialog; use the given title for the dialog; return the dialog constructed.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor,