DiffView (ImageJ2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JScrollPane
      - net.imagej.ui.swing.updater.DiffView

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, ScrollPaneConstants
```
public class DiffView
extends JScrollPane
```
A scroll pane that colorizes diff output. It offers a PrintStream for use with ProcessUtils.exec(java.io.File, PrintStream, PrintStream, String...). It can also show links that might update the view by calling an ActionListener. Otherwise, this class is pretty dumb.

Author:

Johannes Schindelin

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class javax.swing.JScrollPane
  JScrollPane.AccessibleJScrollPane, JScrollPane.ScrollBar
- Nested classes/interfaces inherited from class javax.swing.JComponent
  JComponent.AccessibleJComponent
- Nested classes/interfaces inherited from class java.awt.Container
  Container.AccessibleAWTContainer
- Nested classes/interfaces inherited from class java.awt.Component
  Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`ACTION_ATTRIBUTE`
`protected int`	`adds`
`protected static int`	`BIG_FONT_SIZE`
`protected SimpleAttributeSet`	`bigBold`
`protected SimpleAttributeSet`	`bold`
`protected StyledDocument`	`document`
`protected static String`	`FONT`
`protected static int`	`FONT_SIZE`
`protected SimpleAttributeSet`	`green`
`protected Cursor`	`handCursor`
`protected boolean`	`inHeader`
`protected SimpleAttributeSet`	`italic`
`protected SimpleAttributeSet`	`normal`
`protected Cursor`	`normalCursor`
`protected JPanel`	`panel`
`protected SimpleAttributeSet`	`red`
`protected int`	`removes`
`protected JTextPane`	`textPane`

Fields inherited from class javax.swing.JScrollPane
columnHeader, horizontalScrollBar, horizontalScrollBarPolicy, lowerLeft, lowerRight, rowHeader, upperLeft, upperRight, verticalScrollBar, verticalScrollBarPolicy, viewport

Fields inherited from class javax.swing.JComponent
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
accessibleContext, 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

Constructors
Constructor and Description

DiffView()
Create a colorized diff view.

Constructors
Constructor and Description
`DiffView()` Create a colorized diff view.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SimpleAttributeSet`	`getActionStyle(ActionListener action)` Generate an attribute set for links.
`int`	`getAdds()` Get the number of added lines.
`int`	`getChanges()` Get the number of added or removed lines.
`protected Document`	`getDocument()` Access the underlying document.
`PrintStream`	`getPrintStream()` Construct a `PrintStream` adapter to this view.
`int`	`getRemoves()` Get the number of removed lines.
`static SimpleAttributeSet`	`getStyle(Color color, boolean italic, boolean bold, String fontName, int fontSize)` Create an attribute set for stylish text.
`void`	`green(int position, String text)` Insert some green text.
`void`	`green(String text)` Add some green text.
`void`	`link(String text, ActionListener action)` Add a link.
`static void`	`main(String[] args)` A main method for testing.
`void`	`normal(String text)` Add some plain text.
`void`	`println(String line)` Colorize one line of output.
`void`	`red(int position, String text)` Insert some red text.
`void`	`red(String text)` Add some red text.
`void`	`styled(int position, String text, AttributeSet set)` Insert some stylish text.
`void`	`styled(String text, AttributeSet set)` Add stylish text.
`void`	`warn(String warning)` Add some warnings.

Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, 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, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, 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

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, 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, 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, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ACTION_ATTRIBUTE

protected static final String ACTION_ATTRIBUTE

See Also:: Constant Field Values

FONT
```
protected static final String FONT
```
See Also:

Constant Field Values

FONT_SIZE
```
protected static final int FONT_SIZE
```
See Also:

Constant Field Values

BIG_FONT_SIZE
```
protected static final int BIG_FONT_SIZE
```
See Also:

Constant Field Values

panel
```
protected JPanel panel
```

textPane
```
protected JTextPane textPane
```

normalCursor
```
protected Cursor normalCursor
```

handCursor
```
protected Cursor handCursor
```

normal
```
protected SimpleAttributeSet normal
```

bigBold
```
protected SimpleAttributeSet bigBold
```

bold
```
protected SimpleAttributeSet bold
```

italic
```
protected SimpleAttributeSet italic
```

red
```
protected SimpleAttributeSet red
```

green
```
protected SimpleAttributeSet green
```

document
```
protected StyledDocument document
```

adds
```
protected int adds
```

removes
```
protected int removes
```

inHeader
```
protected boolean inHeader
```

Constructor Detail
- DiffView
```
public DiffView()
```
  Create a colorized diff view.

Method Detail
- getStyle
```
public static SimpleAttributeSet getStyle(Color color,
                                          boolean italic,
                                          boolean bold,
                                          String fontName,
                                          int fontSize)
```
  Create an attribute set for stylish text.
  
  Parameters:
  
  color - the color
  
  italic - whether the text should be slanted
  
  bold - whether the text should be bold
  
  fontName - the name of the font to use
  
  fontSize - the font size to use
  
  Returns:
  
  the attribute set
- styled
```
public void styled(String text,
                   AttributeSet set)
```
  Add stylish text.
  
  Parameters:
  
  text - the text to add
  
  set - the formatting attributes
- styled
```
public void styled(int position,
                   String text,
                   AttributeSet set)
```
  Insert some stylish text.
  
  Parameters:
  
  position - the position where to insert the text
  
  text - the text to insert
  
  set - the formatting attributes
- normal
```
public void normal(String text)
```
  Add some plain text.
  
  Parameters:
  
  text - the text to add
- warn
```
public void warn(String warning)
```
  Add some warnings.
  
  Parameters:
  
  warning - the text to add
- red
```
public void red(String text)
```
  Add some red text.
  
  Parameters:
  
  text - the text to add
- green
```
public void green(String text)
```
  Add some green text.
  
  Parameters:
  
  text - the text to add
- red
```
public void red(int position,
                String text)
```
  Insert some red text.
  
  Parameters:
  
  text - the text to insert
- green
```
public void green(int position,
                  String text)
```
  Insert some green text.
  
  Parameters:
  
  text - the text to insert
- getActionStyle
```
public static SimpleAttributeSet getActionStyle(ActionListener action)
```
  Generate an attribute set for links.
  
  Parameters:
  
  action - the action to perform
  
  Returns:
  
  the attribute set
- link
```
public void link(String text,
                 ActionListener action)
```
  Add a link.
  
  Parameters:
  
  text - the label of the link
  
  action - the action to perform when the link is clicked
- getAdds
```
public int getAdds()
```
  Get the number of added lines.
  
  Returns:
  
  how many lines were added in total
- getRemoves
```
public int getRemoves()
```
  Get the number of removed lines.
  
  Returns:
  
  how many lines were removed in total
- getChanges
```
public int getChanges()
```
  Get the number of added or removed lines.
  
  Returns:
  
  how many lines were added or removed in total
- println
```
public void println(String line)
```
  Colorize one line of output.
  
  Parameters:
  
  line - the line
- getPrintStream
```
public PrintStream getPrintStream()
```
  Construct a PrintStream adapter to this view.
  
  Returns:
  
  the print stream
- getDocument
```
protected Document getDocument()
```
  Access the underlying document.
  
  Returns:
  
  the document
- main
```
public static void main(String[] args)
```
  A main method for testing.
  
  Parameters:
  
  args - the command line

Class DiffView

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JScrollPane

Nested classes/interfaces inherited from class javax.swing.JComponent

Nested classes/interfaces inherited from class java.awt.Container

Nested classes/interfaces inherited from class java.awt.Component

Field Summary

Fields inherited from class javax.swing.JScrollPane

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface javax.swing.ScrollPaneConstants

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JScrollPane

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Detail

ACTION_ATTRIBUTE

FONT

FONT_SIZE

BIG_FONT_SIZE

panel

textPane

normalCursor

handCursor

normal

bigBold

bold

italic

red

green

document

adds

removes

inHeader

Constructor Detail

DiffView

Method Detail

getStyle

styled

styled

normal

warn

red

green

red

green

getActionStyle

link

getAdds

getRemoves

getChanges

println

getPrintStream

getDocument

main