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, BufferedPanel, BufferedPanel.Painter, ColorView, ComponentWrapper, Display, DisplayCollection, FileView, Halo, ImageViewerBase, RequestImageViewer, RequestWebImageViewer, TablePanel, VisualColorList, ZooContainer

public class DisplayPanel
extends JPanel
implements Displayable, MalformedDataListener, JPTConstants

A Displayable 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.

Since:
1.0
See Also:
Displayable, Serialized Form

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.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
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.
 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 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 endAlert(AlertEvent evt)
          Turns off alert status for this component and its children that are also AlertListeners.
 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 default view states for objects in the collection as an encoded String.
 String getViewState()
          Returns the view states for objects in the container as an encoded String.
 Component makeComponent(Object o)
          By default, this method will return the Component constructed using ComponentFactory.makeComponent.
 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.
 void reset()
          Recursively resets any Displayable objects held in the panel.
 void setCodec(String codecID)
          Sets the identifier for the CODEC to be used to combine multiple child view states into an encoded String.
 void setDefaultViewState(String data)
          Sets the default view states for objects in the collection to the data encoded in the given String.
 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 Displayable objects in the container to the data encoded in the given String.
 void startAlert(AlertEvent evt)
          Turns on alert status for this component and its children that are also AlertListeners.
 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, 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

CODEC

public static final String CODEC
Bound property name for the codec property.

See Also:
Constant Field Values

background

protected Color background
Background color before alert status was entered.


codec

protected String codec
Identifier for codec used by this panel.

Constructor Detail

DisplayPanel

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


DisplayPanel

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

Parameters:
isDoubleBuffered - whether or not the panel makes use of double-buffering

DisplayPanel

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

Parameters:
layout - the desired layout manager

DisplayPanel

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

Parameters:
layout - the desired layout manager
isDoubleBuffered - whether or not the panel makes use of double-buffering
Method Detail

setViewState

public void setViewState(String data)

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
Parameters:
data - the encoded String data
See Also:
getViewState(), Displayable

getViewState

public String getViewState()
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
Returns:
the view state as a String
See Also:
setViewState(String), Displayable

setDefaultViewState

public void setDefaultViewState(String data)
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
Parameters:
data - the desired default String data
See Also:
reset(), Displayable

getDefaultViewState

public String getDefaultViewState()
Returns the default view states for objects in the collection as an encoded String. The encoded data is constructed by collecting an array containing the default 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:
getDefaultViewState in interface Displayable
Returns:
the default view state as a String
See Also:
setDefaultViewState(String), reset()

setEnabled

public void setEnabled(boolean isEnabled)
Enables or disables the panel, and recursively enables or disables its contents, based on the given value.

Specified by:
setEnabled in interface Displayable
Overrides:
setEnabled in class JComponent
Parameters:
isEnabled - whether or not this panel is to be enabled
See Also:
Displayable

reset

public void reset()
Recursively resets any Displayable objects held in the panel.

Specified by:
reset in interface Displayable
See Also:
setDefaultViewState(String), Displayable

dataMalformed

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

Specified by:
dataMalformed in interface MalformedDataListener
Parameters:
evt - the malformed data event
See Also:
MalformedDataListener

startAlert

public void startAlert(AlertEvent evt)
Turns on alert status for this component and its children that are also AlertListeners.

Specified by:
startAlert in interface AlertListener
Parameters:
evt - the alert event
See Also:
AlertListener

endAlert

public void endAlert(AlertEvent evt)
Turns off alert status for this component and its children that are also AlertListeners.

Specified by:
endAlert in interface AlertListener
Parameters:
evt - the alert event
See Also:
AlertListener

add

public Component add(Component c)
Adds the specified component to the end of this container.

Overrides:
add in class Container
Parameters:
c - the component to be added
Returns:
the component argument
See Also:
add(Component, int), add(Component, Object), add(Component, Object, int), add(String, Component), remove(Component), remove(int), removeAll()

add

public Component add(Component c,
                     int index)
Adds the specified component to this container at the given position.

Overrides:
add in class Container
Parameters:
c - the component to be added
index - the position at which to insert the component, or -1 to insert the component at the end.
Returns:
the component argument
See Also:
add(Component), add(Component, Object), add(Component, Object, int), add(String, Component), remove(Component), remove(int), removeAll()

add

public void add(Component c,
                Object constraints)
Adds the specified component to the end of this container. Also notifies the layout manager to add the component to this container's layout using the given constraints object.

Overrides:
add in class Container
Parameters:
c - the component to be added
constraints - an object expressing layout constraints for this component
See Also:
add(Component), add(Component, int), add(Component, Object, int), add(String, Component), remove(Component), remove(int), removeAll()

add

public void add(Component c,
                Object constraints,
                int index)
Adds the specified component at the given position. Also notifies the layout manager to add the component to this container's layout using the specified constraints object.

Overrides:
add in class Container
Parameters:
c - the component to be added
constraints - an object expressing layout constraints for this component
index - the position at which to insert the component, or -1 to insert the component at the end.
See Also:
add(Component), add(Component, int), add(Component, Object), add(String, Component), remove(Component), remove(int), removeAll()

add

public Component add(String name,
                     Component c)
Adds the given component to this container. It is strongly advised to use the 1.1 method, add(Component, Object), in place of this method.

Overrides:
add in class Container
Parameters:
name - the name of the component to be added
c - the component to be added
Returns:
the component argument
See Also:
add(Component), add(Component, int), add(Component, Object), add(Component, Object, int), remove(Component), remove(int), removeAll()

addObject

public Component addObject(Object object)
Add the given object to this DisplayPanel at the next available position after applying the transformation of the method makeComponent.

Parameters:
object - the object to be transformed and added to the panel
Returns:
the component obtained by transforming the object
Since:
2.2
See Also:
addObject(Object, int), addObject(Object, Object), addObject(Object, Object, int), makeComponent(Object)

addObject

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

Parameters:
object - the object to be transformed and added to the panel
index - the position at which to add the component
Returns:
the component obtained by transforming the object
Since:
2.2
See Also:
addObject(Object), addObject(Object, Object), addObject(Object, Object, int), makeComponent(Object)

addObject

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

Parameters:
object - the object to be transformed and added to the panel
constraints - an object expressing layout constraints for the component
Returns:
the component obtained by transforming the object
Since:
2.2
See Also:
addObject(Object), addObject(Object, int), addObject(Object, Object, int), makeComponent(Object)

addObject

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

Parameters:
object - the object to be transformed and added to the panel
constraints - an object expressing layout constraints for the component
index - the position at which to add the component
Returns:
the component obtained by transforming the object
Since:
2.2
See Also:
addObject(Object), addObject(Object, int), addObject(Object, Object), makeComponent(Object)

makeComponent

public Component makeComponent(Object o)
By default, this method will return the Component constructed using ComponentFactory.makeComponent.

Returns:
the component obtained by transforming the object
Since:
2.2
See Also:
ComponentFactory.makeComponent(Object)

remove

public void remove(Component c)
Removes the given component from this container.

Overrides:
remove in class Container
Parameters:
c - the component to be removed
See Also:
add(Component), add(Component, int), add(Component, Object), add(Component, Object, int), add(String, Component), remove(int), removeAll()

remove

public void remove(int index)
Removes the component at the given index from this container.

Overrides:
remove in class Container
Parameters:
index - the index of the component to be removed
See Also:
add(Component), add(Component, int), add(Component, Object), add(Component, Object, int), add(String, Component), remove(Component), removeAll()

removeAll

public void removeAll()
Removes all of the components from this container.

Overrides:
removeAll in class Container
See Also:
add(Component), add(Component, int), add(Component, Object), add(Component, Object, int), add(String, Component), remove(Component), remove(int)

uniformizeSize

public void uniformizeSize()

Sets the preferred size for all JComponents in this panel to the same preferred size.

The preferred size that is used is created from the widest preferred width and tallest preferred height among the contained components.

Since:
2.0

uniformizeWidth

public void uniformizeWidth()

Sets the preferred width for all JComponents in this panel to the same width.

The preferred width that is used is created from the widest preferred width among the contained components.

Since:
2.3

uniformizeHeight

public void uniformizeHeight()

Sets the preferred height for all JComponents in this panel to the same height.

The preferred height that is used is created from the tallest preferred height among the contained components.

Since:
2.3

setCodec

public void setCodec(String codecID)
Sets the identifier for the CODEC to be used to combine multiple child view states into an encoded String. If the given identifier is null, the CODEC is not changed.

Parameters:
codecID - identifier of the codec to be used
See Also:
getCodec()

getCodec

public String getCodec()
Returns the identifier for the current CODEC to be used to combine multiple child view states into an encoded String.

See Also:
setCodec(String)

frame

public JPTFrame frame()

Frame this panel in a JPTFrame and open the frame; return the frame constructed.

Returns:
the frame constructed
Since:
2.3.3

frame

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

Parameters:
location - the constant representing the frame location
Returns:
the frame constructed
Since:
2.3.3

frame

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

Parameters:
title - the title for the frame
Returns:
the frame constructed
Since:
2.3.3

frame

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

Parameters:
title - the title for the frame
location - the constant representing the frame location
Returns:
the frame constructed
Since:
2.3.3

frame

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

Parameters:
title - the title for the frame
insets - the screen insets to use to adjust the location
Returns:
the frame constructed
Since:
2.3.4

frame

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

Parameters:
title - the title for the frame
location - the constant representing the frame location
insets - the screen insets to use to adjust the location
Returns:
the frame constructed
Since:
2.3.3

OKDialog

public GeneralDialog OKDialog()

Place this panel in a modal OK dialog and open the dialog; return the dialog constructed.

Returns:
the dialog constructed
Since:
2.3.3

OKDialog

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

Parameters:
title - the title for the dialog
Returns:
the dialog constructed
Since:
2.3.3

OKCancelDialog

public GeneralDialog OKCancelDialog()

Place this panel in a modal OK-Cancel dialog and open the dialog; return the dialog constructed.

Returns:
the dialog constructed
Since:
2.3.3

OKCancelDialog

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

Parameters:
title - the title for the dialog
Returns:
the dialog constructed
Since:
2.3.3

YesNoCancelDialog

public GeneralDialog YesNoCancelDialog()

Place this panel in a modal Yes-No-Cancel dialog and open the dialog; return the dialog constructed.

Returns:
the dialog constructed
Since:
2.3.3

YesNoCancelDialog

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

Parameters:
title - the title for the dialog
Returns:
the dialog constructed
Since:
2.3.3

generalDialog

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

The parameter actionData is an Object[][] array that specifies each dialog Action in one of the following ways:

If the option parameter is specified, it must be one of the following values that will determine what is done to the dialog when the action is finished:

If the option parameter is not specified, it is taken to be DialogAction.AUTO_CLOSE.

Parameters:
actionData - the action data
Returns:
the dialog constructed
Since:
2.3.3

generalDialog

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

The parameter actionData is an Object[][] array that specifies each dialog Action in one of the following ways:

If the option parameter is specified, it must be one of the following values that will determine what is done to the dialog when the action is finished:

If the option parameter is not specified, it is taken to be DialogAction.AUTO_CLOSE.

The Object supplied for the default action must either be an Action or a name that is supplied in the action data. If the parameter is null, no default action is set.

Parameters:
actionData - the action data
defaultAction - the default action
Returns:
the dialog constructed
Since:
2.3.3

generalDialog

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

The parameter actionData is an Object[][] array that specifies each dialog Action in one of the following ways:

If the option parameter is specified, it must be one of the following values that will determine what is done to the dialog when the action is finished:

If the option parameter is not specified, it is taken to be DialogAction.AUTO_CLOSE.

Parameters:
title - the title for the dialog
actionData - the action data
Returns:
the dialog constructed
Since:
2.3.3

generalDialog

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

The parameter actionData is an Object[][] array that specifies each dialog Action in one of the following ways:

If the option parameter is specified, it must be one of the following values that will determine what is done to the dialog when the action is finished:

If the option parameter is not specified, it is taken to be DialogAction.AUTO_CLOSE.

The Object supplied for the default action must either be an Action or a name that is supplied in the action data. If the parameter is null, no default action is set.

Parameters:
title - the title for the dialog
actionData - the action data
defaultAction - the default action
Returns:
the dialog constructed
Since:
2.3.3

refreshComponent

public void refreshComponent()
Refreshes the component by repacking the parent window.