edu.sc.seis.fissuresUtil.display.borders
Class Border

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by edu.sc.seis.fissuresUtil.display.borders.Border
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable
Direct Known Subclasses:
AbstractUnitRangeBorder, NoTickBorder, TimeBorder

public abstract class Border
extends javax.swing.JComponent

See Also:
Serialized Form

Nested Class Summary
 class Border.BorderFormat
           
 
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
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
static int ASCENDING
          To be used with the order argument of the constructor to indicate if the border is going from low to high or high to low
protected  java.util.List borderFormats
           
static int BOTTOM
          To be used with the side argument of the constructor to indicate which side of a component this will be bordering
protected  java.awt.Color color
           
static int DESCENDING
          To be used with the order argument of the constructor to indicate if the border is going from low to high or high to low
protected  int direction
           
protected static int HORIZONTAL
           
protected  int labelTickHeight
           
protected  int labelTickLength
           
protected  int labelTickWidth
           
static int LEFT
          To be used with the side argument of the constructor to indicate which side of a component this will be bordering
protected  double maxTickValue
           
protected  double minTickValue
           
protected  int order
           
static int RIGHT
          To be used with the side argument of the constructor to indicate which side of a component this will be bordering
protected  int side
           
protected  int tickHeight
           
protected  int tickLength
           
protected  int tickPad
           
protected  int tickWidth
           
protected  boolean titleCentered
           
static int TOP
          To be used with the side argument of the constructor to indicate which side of a component this will be bordering
protected  int type
           
protected static int VERTICAL
           
 
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
Border(int side, int order)
           
 
Method Summary
 void add(TitleProvider tp)
          Adds a title to this border.
protected abstract  java.util.List createFormats()
           
protected  void fixSize()
           
 Border.BorderFormat getFormat(java.awt.Graphics2D g2d)
           
abstract  java.lang.String getMaxLengthFormattedString()
           
protected abstract  edu.iris.Fissures.model.UnitRangeImpl getRange()
           
 void paint(java.awt.Graphics g)
           
protected  void paintBorder(java.awt.Graphics2D g2d)
           
 void removeTitle(TitleProvider toBeRemoved)
           
 void setClipTicks(double minTickVal, double maxTickVal)
           
 void setOrder(int o)
           
 void setSide(int s)
           
 void setTitleAndTickColor(java.awt.Color c)
           
 void setTitleCentered(boolean centered)
           
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, 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, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, 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

borderFormats

protected java.util.List borderFormats

side

protected int side

direction

protected int direction

order

protected int order

labelTickHeight

protected int labelTickHeight

labelTickWidth

protected int labelTickWidth

tickHeight

protected int tickHeight

tickWidth

protected int tickWidth

type

protected int type

minTickValue

protected double minTickValue

maxTickValue

protected double maxTickValue

LEFT

public static final int LEFT
To be used with the side argument of the constructor to indicate which side of a component this will be bordering

See Also:
Constant Field Values

RIGHT

public static final int RIGHT
To be used with the side argument of the constructor to indicate which side of a component this will be bordering

See Also:
Constant Field Values

TOP

public static final int TOP
To be used with the side argument of the constructor to indicate which side of a component this will be bordering

See Also:
Constant Field Values

BOTTOM

public static final int BOTTOM
To be used with the side argument of the constructor to indicate which side of a component this will be bordering

See Also:
Constant Field Values

ASCENDING

public static final int ASCENDING
To be used with the order argument of the constructor to indicate if the border is going from low to high or high to low

See Also:
Constant Field Values

DESCENDING

public static final int DESCENDING
To be used with the order argument of the constructor to indicate if the border is going from low to high or high to low

See Also:
Constant Field Values

VERTICAL

protected static final int VERTICAL
See Also:
Constant Field Values

HORIZONTAL

protected static final int HORIZONTAL
See Also:
Constant Field Values

tickPad

protected int tickPad

labelTickLength

protected int labelTickLength

tickLength

protected int tickLength

color

protected java.awt.Color color

titleCentered

protected boolean titleCentered
Constructor Detail

Border

public Border(int side,
              int order)
Method Detail

setTitleAndTickColor

public void setTitleAndTickColor(java.awt.Color c)

setOrder

public void setOrder(int o)

setSide

public void setSide(int s)

setClipTicks

public void setClipTicks(double minTickVal,
                         double maxTickVal)

getMaxLengthFormattedString

public abstract java.lang.String getMaxLengthFormattedString()

paint

public void paint(java.awt.Graphics g)
Overrides:
paint in class javax.swing.JComponent

paintBorder

protected void paintBorder(java.awt.Graphics2D g2d)

getFormat

public Border.BorderFormat getFormat(java.awt.Graphics2D g2d)

add

public void add(TitleProvider tp)
Adds a title to this border. If you just want to title a border with an unchanging string, pass a UnchangingTitleProvider to this method


removeTitle

public void removeTitle(TitleProvider toBeRemoved)

fixSize

protected void fixSize()

setTitleCentered

public void setTitleCentered(boolean centered)

createFormats

protected abstract java.util.List createFormats()

getRange

protected abstract edu.iris.Fissures.model.UnitRangeImpl getRange()