edu.neu.ccs.gui
Class Display

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

All Implemented Interfaces:

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

public class Display

extends DisplayPanel

A panel containing a Displayable object, with the option of a title and an Annotation.

The title can appear at the top or bottom of the view. The object on display always appears at the center of the view and takes up all available space. The annotation can appear at any of the four main compass directions relative to the object on display.

The functionality of this container assumes use of a BorderLayout and effects are undefined if the user changes this layout.

The Display is the simplest and most versatile of the recursive container classes available in the JPT. Displays can be recursively nested to any depth, although screen real estate imposes a physical limit to the number of displays that could be contained within an actual visualization.

Since:

1.0

See Also:

Annotation, Displayable, Serialized Form

Nested Class Summary

static class

Display.Settings Data structure encapsulating the content and layout properties for a Display.

Field Summary

protected int	aAlign The alignment of the annotation relative to displayed object.
static String	ANNOTATION Bound property name for the annotation object property.
static String	ANNOTATION_ALIGNMENT Bound property name for the annotation alignment property.
static String	ANNOTATION_TEXT Bound property name for the annotation text property.
protected Annotation	caption The annotation for this display.
static int	DEFAULT_ANNOTATION_ALIGNMENT The default alignment of the annotation relative to displayed object for a display.
static String	DEFAULT_ANNOTATION_TEXT The default annotation text for a display.
static int	DEFAULT_TITLE_ALIGNMENT The default alignment of the title relative to displayed object.
static String	DEFAULT_TITLE_TEXT The default title text for a display.
static String	DISPLAY Bound property name for the displayed object property.
protected int	tAlign The alignment of the title relative to displayed object.
protected String	title The title text for this display.
static String	TITLE_ALIGNMENT Bound property name for the title alignment property.
static String	TITLE_TEXT Bound property name for the title text property.
protected Displayable	view The displayed object for this display.

Fields inherited from class edu.neu.ccs.gui.DisplayPanel

background, codec, CODEC

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

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

Display()
Constructs a display containing an empty DisplayPanel, with no annotation or title.

Display(Displayable viewObject)
Constructs a display containing the given object, with no annotation or title.

Display(Displayable viewObject, Display.Settings settings)
Constructs a display containing the given object, with the remaining settings taken from the given Settings object.

Display(Displayable viewObject, String annotationText, String titleText)
Constructs a display containing the given object, with the given annotation text and title text.

Display(Displayable viewObject, String annotationText, String titleText, int annotationAlign, int titleAlign)
Constructors a display containing the given object, with the given annotation text and title text, using the given alignments for the title and annotation.

Method Summary

Annotation	getAnnotation() Returns the annotation component, or null if this display does not have an annotation.
int	getAnnotationAlignment() Returns the value for the alignment of the annotation relative to the displayed object.
String	getAnnotationText() Returns the annotation text, or null if this display does not have an annotation.
Displayable	getDisplay() Returns the displayed object.
Display.Settings	getSettings() Returns the properties for this display as a Settings object.
int	getTitleAlignment() Returns the alignment value of the title relative to the object on display.
String	getTitleText() Returns the title text, or null if this display does not have a title.
String	getViewState() Returns the view states for objects in the container as an encoded String.
protected void	revalidateAnnotationAndAlignment() Rebuilds the annotation and its alignment based on the current annotation text and alignment.
protected void	revalidateTitleAndAlignment() Rebuilds the titled border and its alignment based on the current title text and alignment.
void	setAnnotation(Annotation annotation) Sets the annotation component to the given Annotation.
void	setAnnotationAlignment(int alignment) Sets the alignment of the annotation relative to the displayed object.
void	setAnnotationText(String text) Sets the annotation text to the given text.
void	setDefaultViewState(String data) Sets the default view states for objects in the collection to the data encoded in the given String.
void	setDisplay(Displayable viewObject) Sets the displayed object to the given Displayable object.
void	setSettings(Display.Settings s) Sets the properties for this display to the settings taken from the given Settings object.
void	setTitleAlignment(int alignment) Sets the alignment of the title relative to the displayed object.
void	setTitleText(String text) Sets the title text to the given text.
void	setViewState(String data) Sets the view states for Displayable objects in the container to the data encoded in the given String.

Methods inherited from class edu.neu.ccs.gui.DisplayPanel

add, add, add, add, add, addObject, addObject, addObject, addObject, dataMalformed, endAlert, frame, frame, frame, frame, frame, frame, generalDialog, generalDialog, generalDialog, generalDialog, getCodec, getDefaultViewState, makeComponent, OKCancelDialog, OKCancelDialog, OKDialog, OKDialog, refreshComponent, remove, remove, removeAll, reset, setCodec, setEnabled, startAlert, uniformizeHeight, uniformizeSize, uniformizeWidth, YesNoCancelDialog, YesNoCancelDialog

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, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, 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

ANNOTATION_TEXT

public static final String ANNOTATION_TEXT

Bound property name for the annotation text property.

See Also:

Constant Field Values

ANNOTATION_ALIGNMENT

public static final String ANNOTATION_ALIGNMENT

Bound property name for the annotation alignment property.

See Also:

Constant Field Values

TITLE_TEXT

public static final String TITLE_TEXT

Bound property name for the title text property.

See Also:

Constant Field Values

TITLE_ALIGNMENT

public static final String TITLE_ALIGNMENT

Bound property name for the title alignment property.

See Also:

Constant Field Values

DISPLAY

public static final String DISPLAY

Bound property name for the displayed object property.

See Also:

Constant Field Values

ANNOTATION

public static final String ANNOTATION

Bound property name for the annotation object property.

See Also:

Constant Field Values

DEFAULT_ANNOTATION_TEXT

public static final String DEFAULT_ANNOTATION_TEXT

The default annotation text for a display.

DEFAULT_TITLE_TEXT

public static final String DEFAULT_TITLE_TEXT

The default title text for a display.

DEFAULT_ANNOTATION_ALIGNMENT

public static final int DEFAULT_ANNOTATION_ALIGNMENT

The default alignment of the annotation relative to displayed object for a display.

See Also:

Constant Field Values

DEFAULT_TITLE_ALIGNMENT

public static final int DEFAULT_TITLE_ALIGNMENT

The default alignment of the title relative to displayed object.

See Also:

Constant Field Values

title

protected String title

The title text for this display.

aAlign

protected int aAlign

The alignment of the annotation relative to displayed object.

tAlign

protected int tAlign

The alignment of the title relative to displayed object.

view

protected Displayable view

The displayed object for this display. Since this object must never be null, an empty DisplayPanel will be provided on any attempt to set a null displayed object.

caption

protected Annotation caption

The annotation for this display.

Constructor Detail

Display

public Display()

Constructs a display containing an empty DisplayPanel, with no annotation or title.

See Also:

Display(Displayable), Display(Displayable, String, String), Display(Displayable, String, String, int, int)

Display

public Display(Displayable viewObject)

Constructs a display containing the given object, with no annotation or title.

Parameters:

viewObject - the object to display

See Also:

Display(), Display(Displayable, String, String), Display(Displayable, String, String, int, int)

Display

public Display(Displayable viewObject,
               String annotationText,
               String titleText)

Constructs a display containing the given object, with the given annotation text and title text.

Parameters:

viewObject - the object to display

annotationText - the annotation text

titleText - the title text

See Also:

Display(), Display(Displayable), Display(Displayable, String, String, int, int)

Display

public Display(Displayable viewObject,
               String annotationText,
               String titleText,
               int annotationAlign,
               int titleAlign)

Constructors a display containing the given object, with the given annotation text and title text, using the given alignments for the title and annotation.

Parameters:

viewObject - the object to display

annotationText - the annotation text

titleText - the title text

annotationAlign - the relative alignment of the annotation relative to the object on display

titleAlign - the relative alignment of the title relative to the object on display

See Also:

Display(), Display(Displayable), Display(Displayable, String, String)

Display

public Display(Displayable viewObject,
               Display.Settings settings)

Constructs a display containing the given object, with the remaining settings taken from the given Settings object.

Parameters:

viewObject - the object to display

settings - the object containing the desired settings

Method Detail

setViewState

public void setViewState(String data)

Description copied from class: DisplayPanel

Sets the view states for Displayable objects in the container to the data encoded in the given String.

If the given encoded data is null, the view states are not changed.

If the given encoded data is not null, the data is decoded into its component data elements and the view state for each of as many Displayable objects as possible is set to the state encapsulated in the corresponding data element. If the encoded data contains more data elements than there are Displayable objects in the panel, the extraneous data elements are ignored. If the encoded data contains fewer data elements than there are Displayable objects in the panel, the view states are not changed for objects that do not have a corresponding data element.

Specified by:

setViewState in interface Displayable

Overrides:

setViewState in class DisplayPanel

Parameters:

data - the encoded String data

See Also:

DisplayPanel.getViewState(), Displayable

getViewState

public String getViewState()

Description copied from class: DisplayPanel

Returns the view states for objects in the container as an encoded String. The encoded data is constructed by collecting an array containing the view states for each of the Displayable objects in the container and encoding it using the CODEC whose identifier is stored by this panel.

Specified by:

getViewState in interface Displayable

Overrides:

getViewState in class DisplayPanel

See Also:

DisplayPanel.setViewState(String), Displayable

setDefaultViewState

public void setDefaultViewState(String data)

Description copied from class: DisplayPanel

Sets the default view states for objects in the collection to the data encoded in the given String.

If the given encoded data is null, the default view states are not changed.

If the given encoded data is not null, the data is decoded into its component data elements and the default view state for each of as many Displayable objects as possible is set to the state encapsulated in the corresponding data element. If the encoded data contains more data elements than there are Displayable objects in the panel, the extraneous data elements are ignored. If the encoded data contains fewer data elements than there are Displayable objects in the panel, the default view states are not changed for objects that do not have a corresponding data element.

Specified by:

setDefaultViewState in interface Displayable

Overrides:

setDefaultViewState in class DisplayPanel

Parameters:

data - the desired default String data

See Also:

DisplayPanel.reset(), Displayable

setAnnotationText

public void setAnnotationText(String text)

Sets the annotation text to the given text. If the given text is null, the current annotation is removed from this display an no annotation is displayed. If the annotation text was previously null, a new Annotation object is created.

Parameters:

text - the annotation text to display

See Also:

getAnnotationText()

getAnnotationText

public String getAnnotationText()

Returns the annotation text, or null if this display does not have an annotation. If this display does not contain an annotation, this method returns null.

See Also:

setAnnotationText(String)

setAnnotationAlignment

public void setAnnotationAlignment(int alignment)

Sets the alignment of the annotation relative to the displayed object. If the given alignment value is invalid, the annotation alignment is not changed.

Parameters:

alignment - the new alignment for the annotation relative to the displayed object

See Also:

getAnnotationAlignment(), JPTConstants.ABOVE, JPTConstants.BELOW, SwingConstants.LEFT, SwingConstants.RIGHT, JPTConstants.DEFAULT

getAnnotationAlignment

public int getAnnotationAlignment()

Returns the value for the alignment of the annotation relative to the displayed object.

See Also:

setAnnotationAlignment(int), JPTConstants.ABOVE, JPTConstants.BELOW, SwingConstants.LEFT, SwingConstants.RIGHT

setTitleText

public void setTitleText(String text)

Sets the title text to the given text. If the given text is null, the current titled border is removed from this display and no title is displayed. If the title text was previously null, a new titled border is created.

Parameters:

text - the title text to display

See Also:

getTitleText()

getTitleText

public String getTitleText()

Returns the title text, or null if this display does not have a title.

See Also:

setTitleText(String)

setTitleAlignment

public void setTitleAlignment(int alignment)

Sets the alignment of the title relative to the displayed object. If the given alignment value is invalid, the title alignment is not changed.

Parameters:

alignment - the new alignment for the title relative to the displayed object

See Also:

getTitleAlignment(), JPTConstants.ABOVE, JPTConstants.BELOW, JPTConstants.DEFAULT

getTitleAlignment

public int getTitleAlignment()

Returns the alignment value of the title relative to the object on display.

See Also:

setTitleAlignment(int), JPTConstants.ABOVE, JPTConstants.BELOW

setDisplay

public void setDisplay(Displayable viewObject)

Sets the displayed object to the given Displayable object. If the given object is null, an empty DisplayPanel is created and displayed.

Parameters:

viewObject - the new object to display

See Also:

getDisplay()

getDisplay

public Displayable getDisplay()

Returns the displayed object.

See Also:

setDisplay(Displayable)

setAnnotation

public void setAnnotation(Annotation annotation)

Sets the annotation component to the given Annotation. If the given object is null, the current annotation is removed from this display and no annotation is displayed.

Parameters:

annotation - the new Annotation

See Also:

getAnnotation()

getAnnotation

public Annotation getAnnotation()

Returns the annotation component, or null if this display does not have an annotation.

See Also:

setAnnotation(Annotation)

setSettings

public void setSettings(Display.Settings s)

Sets the properties for this display to the settings taken from the given Settings object. If the given object is null, then all settings are reset to defaults.

Parameters:

s - encapsulation of the new settings for this display

getSettings

public Display.Settings getSettings()

Returns the properties for this display as a Settings object.

revalidateTitleAndAlignment

protected void revalidateTitleAndAlignment()

Rebuilds the titled border and its alignment based on the current title text and alignment.

revalidateAnnotationAndAlignment

protected void revalidateAnnotationAndAlignment()

Rebuilds the annotation and its alignment based on the current annotation text and alignment.