jas.plot
Class TextBlock

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--jas.plot.PlotComponent
                          |
                          +--jas.plot.MovableObject
                                |
                                +--jas.plot.TextBlock
All Implemented Interfaces:
HasPopupItems, java.awt.image.ImageObserver, JASPlotMouseListener, java.awt.MenuContainer, java.io.Serializable
Direct Known Subclasses:
StatisticsBlock

public abstract class TextBlock
extends MovableObject

TextBlock is the base class for creating moveable text boxes in the jas display.

See Also:
Serialized Form

Inner classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Inner classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Inner classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent
 
Field Summary
protected  java.awt.FontMetrics fm
           
 
Fields inherited from class jas.plot.MovableObject
bgcolors, bgnames
 
Fields inherited from class jas.plot.PlotComponent
BEVEL_IN, BEVEL_OUT, ETCHED, LINE, NONE, OTHER, SHADOW
 
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 java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
TextBlock(java.lang.String prefix)
           
 
Method Summary
protected  void allocateSize()
          Base method for determining the width (blockwidth) of the text block according to the max length of text lines to be drawn in the block, and the height according to the number of lines to be displayed.
abstract  java.lang.String getLine(int n)
          When implemented, getLine(int n) should return a String corresponding to the nth text line to be displayed in the text block.
abstract  int getNLines()
          When implemented, getNLines() should return an integer count of the number of lines of text to be displayed in the text block.
 java.awt.Dimension getPreferredSize()
          Sets the horizontal and vertical dimensions of the text block.
abstract  int getSplitStringAlign()
          When implemented, getSplitStringAlignment() should return an integer between 1 and 3 corresponding to the chosen alignment for the second half of strings split by '\t'.
 void modifyPopupMenu(javax.swing.JPopupMenu menu, java.awt.Component source)
          Modify the given menu object.
 void paintComponent(java.awt.Graphics g)
          Draws each line of text in the text block.
 void setFont(java.awt.Font p1)
           
 
Methods inherited from class jas.plot.MovableObject
getBorderType, getInsideBorder, getPrefix, hasDefaultPosition, mouseEventNotify, print, setBorder, setMovableObjectBounds, setMovableObjectBounds
 
Methods inherited from class jas.plot.PlotComponent
isPaintingBackground, setBackground, setBorderType
 
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, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getUIClassID, getVerifyInputWhenFocusTarget, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, hide, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processFocusEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setLayout, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

fm

protected java.awt.FontMetrics fm
Constructor Detail

TextBlock

public TextBlock(java.lang.String prefix)
Method Detail

getNLines

public abstract int getNLines()
When implemented, getNLines() should return an integer count of the number of lines of text to be displayed in the text block.

getLine

public abstract java.lang.String getLine(int n)
When implemented, getLine(int n) should return a String corresponding to the nth text line to be displayed in the text block.

getSplitStringAlign

public abstract int getSplitStringAlign()
When implemented, getSplitStringAlignment() should return an integer between 1 and 3 corresponding to the chosen alignment for the second half of strings split by '\t'. For leftalignment: return 1. For rightaignment: return 2. For noalignment: return 3.

getPreferredSize

public java.awt.Dimension getPreferredSize()
Sets the horizontal and vertical dimensions of the text block.
Overrides:
getPreferredSize in class javax.swing.JComponent

paintComponent

public void paintComponent(java.awt.Graphics g)
Draws each line of text in the text block. If "\n" is returned by getLine() a seperator line will be drawn in the block. All other strings are formatted by formatLine() before being drawn.
Overrides:
paintComponent in class PlotComponent

modifyPopupMenu

public void modifyPopupMenu(javax.swing.JPopupMenu menu,
                            java.awt.Component source)
Description copied from interface: HasPopupItems
Modify the given menu object.
Overrides:
modifyPopupMenu in class MovableObject

allocateSize

protected void allocateSize()
Base method for determining the width (blockwidth) of the text block according to the max length of text lines to be drawn in the block, and the height according to the number of lines to be displayed.

setFont

public void setFont(java.awt.Font p1)
Overrides:
setFont in class javax.swing.JComponent