com.billpringle.utils.wrputils
Class WrpScrollFrame

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by java.awt.Window
              extended by java.awt.Frame
                  extended by javax.swing.JFrame
                      extended by com.billpringle.utils.wrputils.WrpScrollFrame
All Implemented Interfaces:
java.awt.event.ActionListener, java.awt.event.ComponentListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class WrpScrollFrame
extends javax.swing.JFrame
implements java.awt.event.ActionListener, java.awt.event.ComponentListener

Create a scrolled window containing the specified content. This class can be used to display such things as a help messages, search results, etc. The resulting frame is independent, even if called from an JInternalFrame class.

Creative Commons License Creative Commons License Symbols Unless noted otherwise, all materials available for download from my site are copyrighted by Bill Pringle, and are licensed under a Creative Commons License.

Author:
Bill Pringle
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JFrame
javax.swing.JFrame.AccessibleJFrame
 
Nested classes/interfaces inherited from class java.awt.Frame
java.awt.Frame.AccessibleAWTFrame
 
Nested classes/interfaces inherited from class java.awt.Window
java.awt.Window.AccessibleAWTWindow
 
Nested classes/interfaces inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
protected  javax.swing.JList lst
          The list that contains the text to be displayed in the frame.
protected  javax.swing.JScrollPane scroll
          The scrolled pane.
protected  java.util.Vector<java.lang.String> scrollData
          Vector of strings for this scrolled frame.
(package private) static long serialVersionUID
          serialization identity
 
Fields inherited from class javax.swing.JFrame
accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled
 
Fields inherited from class java.awt.Frame
CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
WrpScrollFrame()
          Default constructor.
WrpScrollFrame(java.util.Vector<java.lang.String> vec)
          Constructor with list of strings to be inserted into the frame.
WrpScrollFrame(java.util.Vector<java.lang.String> vec, java.lang.String title)
          Constructor with list and frame title.
 
Method Summary
 void actionPerformed(java.awt.event.ActionEvent e)
          This method handles any action generated by the user.
 void appendScrollData(java.util.Vector<java.lang.String> vec)
          Append the specified list of strings to the end of the scrolled frame.
protected  void buildPage()
          Build a scrolled frame with an empty list.
 void componentHidden(java.awt.event.ComponentEvent e)
          This method is called when the frame is hidden.
 void componentMoved(java.awt.event.ComponentEvent e)
          This method is called when the frame is moved.
 void componentResized(java.awt.event.ComponentEvent e)
          This method is called when the frame is resized.
 void componentShown(java.awt.event.ComponentEvent e)
          This method is called when the frame is made visible.
static void main(java.lang.String[] args)
          Test driver for this frame.
protected  void resizeScroll()
          Set the size of the scrolled text to the default size if not created.
 void setScrollData(java.util.Vector<java.lang.String> vec)
          Set or modify the contents of the frame.
 void setTitle(java.lang.String title)
          Set the title of the scrolled frame.
 
Methods inherited from class javax.swing.JFrame
addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update
 
Methods inherited from class java.awt.Frame
addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setResizable, setState, setUndecorated
 
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setVisible, show, toBack, toFront
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.awt.MenuContainer
getFont, postEvent
 

Field Detail

serialVersionUID

static final long serialVersionUID
serialization identity

See Also:
Constant Field Values

scrollData

protected java.util.Vector<java.lang.String> scrollData
Vector of strings for this scrolled frame. Each entry in the list will be inserted into the scrolled frame as a separate line in the list. The entries of the list can contain embedded end of line sequences.


scroll

protected javax.swing.JScrollPane scroll
The scrolled pane. This pane will contain the information to be displayed in the frame.


lst

protected javax.swing.JList lst
The list that contains the text to be displayed in the frame.

Constructor Detail

WrpScrollFrame

public WrpScrollFrame()
Default constructor. This method will create an empty scrolled frame.


WrpScrollFrame

public WrpScrollFrame(java.util.Vector<java.lang.String> vec)
Constructor with list of strings to be inserted into the frame. This constructor will set the list data to the provided list.

Parameters:
vec - a list of the strings to be displayed in the scrolled frame

WrpScrollFrame

public WrpScrollFrame(java.util.Vector<java.lang.String> vec,
                      java.lang.String title)
Constructor with list and frame title. This method will create a scrolled frame, insert the specified list of strings, and set the title of the frame window.

Parameters:
vec - the list of data for the frame
title - the title of the frame
Method Detail

buildPage

protected void buildPage()
Build a scrolled frame with an empty list. This method is called by the default constructor to create the actual frame with an empty scrolled panel.


setScrollData

public void setScrollData(java.util.Vector<java.lang.String> vec)
Set or modify the contents of the frame. This method will set the contents of the frame to the specified list of strings. If the frame already had data, then it will be replaced by this list. Each entry in the vector will be displayed as a separate line The strings can have embedded additional newline sequences.

Parameters:
vec - the data to be displayed in the scrolled frame

appendScrollData

public void appendScrollData(java.util.Vector<java.lang.String> vec)
Append the specified list of strings to the end of the scrolled frame. This method adds the strings in the vector vec to the vector being displayed in the scrolled frame. Each entry in the vector will be displayed as a separate line The strings can have embedded additional newline sequences.

Parameters:
vec - the data to be appended to the bottom of the scrolled frame

setTitle

public void setTitle(java.lang.String title)
Set the title of the scrolled frame. This method will set the title of the frame to the specified string.

Overrides:
setTitle in class java.awt.Frame

resizeScroll

protected void resizeScroll()
Set the size of the scrolled text to the default size if not created. This method sizes the scroll to the default size if not created yet. Once the frame has been created, the size will remain unchanged unless the frame is resized manually. Adding or setting the content of the frame doesn't affect the size.


actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)
This method handles any action generated by the user. This method is not currently being used.

Specified by:
actionPerformed in interface java.awt.event.ActionListener

componentHidden

public void componentHidden(java.awt.event.ComponentEvent e)
This method is called when the frame is hidden.

Specified by:
componentHidden in interface java.awt.event.ComponentListener

componentMoved

public void componentMoved(java.awt.event.ComponentEvent e)
This method is called when the frame is moved.

Specified by:
componentMoved in interface java.awt.event.ComponentListener

componentResized

public void componentResized(java.awt.event.ComponentEvent e)
This method is called when the frame is resized. The scrolled pane will be resized to match the frame size.

Specified by:
componentResized in interface java.awt.event.ComponentListener

componentShown

public void componentShown(java.awt.event.ComponentEvent e)
This method is called when the frame is made visible.

Specified by:
componentShown in interface java.awt.event.ComponentListener

main

public static void main(java.lang.String[] args)
Test driver for this frame. This method is typically not used. It is mainly useful for testing purposes.

Parameters:
args - not used