TreeViewer

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - org.antlr.v4.gui.TreeViewer

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable
```
public class TreeViewer
extends JComponent
```
See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
`static class`	`TreeViewer.DefaultTreeTextProvider`
`static class`	`TreeViewer.VariableExtentProvide`

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 int`	`arcSize`
`protected Color`	`borderColor`
`protected Color`	`boxColor`
`protected Font`	`font`
`protected String`	`fontName`
`protected int`	`fontSize`
`protected int`	`fontStyle`
`protected double`	`gapBetweenLevels`
`protected double`	`gapBetweenNodes`
`protected Color`	`highlightedBoxColor`
`protected List<Tree>`	`highlightedNodes`
`static Color`	`LIGHT_RED`
`protected int`	`nodeHeightPadding`
`protected int`	`nodeWidthPadding`
`protected double`	`scale`
`protected Color`	`textColor`
`protected <any>`	`treeLayout`
`protected TreeTextProvider`	`treeTextProvider`

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
`TreeViewer(List<String> ruleNames, Tree tree)`

Method Summary

All Methods

Static Methods

Instance Methods

Concrete Methods
Modifier and Type	Method and Description
`void`	`addHighlightedNodes(Collection<Tree> nodes)` Slow for big lists of highlighted nodes
`int`	`getArcSize()`
`Color`	`getBorderColor()`
`protected Rectangle2D.Double`	`getBoundsOfNode(Tree node)`
`Color`	`getBoxColor()`
`protected Graphics`	`getComponentGraphics(Graphics g)`
`Font`	`getFont()`
`Color`	`getHighlightedBoxColor()`
`protected int`	`getHighlightedNodeIndex(Tree node)`
`double`	`getScale()`
`protected String`	`getText(Tree tree)`
`Color`	`getTextColor()`
`protected <any>`	`getTree()`
`<any>`	`getTreeLayoutAdaptor(Tree root)` Get an adaptor for root that indicates how to walk ANTLR trees.
`TreeTextProvider`	`getTreeTextProvider()`
`boolean`	`getUseCurvedEdges()`
`protected boolean`	`isHighlighted(Tree node)`
`Future<JDialog>`	`open()`
`void`	`paint(Graphics g)`
`protected void`	`paintBox(Graphics g, Tree tree)`
`protected void`	`paintEdges(Graphics g, Tree parent)`
`void`	`removeHighlightedNodes(Collection<Tree> nodes)`
`void`	`save(String fileName)`
`void`	`setArcSize(int arcSize)`
`void`	`setBorderColor(Color borderColor)`
`void`	`setBoxColor(Color boxColor)`
`void`	`setFont(Font font)`
`void`	`setFontName(String name)`
`void`	`setFontSize(int sz)`
`void`	`setHighlightedBoxColor(Color highlightedBoxColor)`
`void`	`setRuleNames(List<String> ruleNames)`
`void`	`setScale(double scale)`
`void`	`setTextColor(Color textColor)`
`void`	`setTree(Tree root)`
`void`	`setTreeTextProvider(TreeTextProvider treeTextProvider)`
`void`	`setUseCurvedEdges(boolean useCurvedEdges)`
`protected static JDialog`	`showInDialog(TreeViewer viewer)`
`void`	`text(Graphics g, String s, int x, int y)`

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, 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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, 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, 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, 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, getAccessibleContext, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, 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, setComponentOrientation, 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

LIGHT_RED
```
public static final Color LIGHT_RED
```

treeTextProvider

protected TreeTextProvider treeTextProvider

treeLayout
```
protected <any> treeLayout
```

highlightedNodes
```
protected List<Tree> highlightedNodes
```

fontName
```
protected String fontName
```

fontStyle
```
protected int fontStyle
```

fontSize
```
protected int fontSize
```

font
```
protected Font font
```

gapBetweenLevels
```
protected double gapBetweenLevels
```

gapBetweenNodes
```
protected double gapBetweenNodes
```

nodeWidthPadding
```
protected int nodeWidthPadding
```

nodeHeightPadding
```
protected int nodeHeightPadding
```

arcSize
```
protected int arcSize
```

scale
```
protected double scale
```

boxColor
```
protected Color boxColor
```

highlightedBoxColor
```
protected Color highlightedBoxColor
```

borderColor
```
protected Color borderColor
```

textColor
```
protected Color textColor
```

Constructor Detail

TreeViewer

public TreeViewer(List<String> ruleNames,
                  Tree tree)

Method Detail

getUseCurvedEdges
```
public boolean getUseCurvedEdges()
```

setUseCurvedEdges

public void setUseCurvedEdges(boolean useCurvedEdges)

paintEdges

protected void paintEdges(Graphics g,
                          Tree parent)

paintBox

protected void paintBox(Graphics g,
                        Tree tree)

text

public void text(Graphics g,
                 String s,
                 int x,
                 int y)

paint
```
public void paint(Graphics g)
```

getComponentGraphics

protected Graphics getComponentGraphics(Graphics g)

showInDialog

protected static JDialog showInDialog(TreeViewer viewer)

open
```
public Future<JDialog> open()
```

save

public void save(String fileName)
          throws IOException,
                 PrintException

Throws:: IOException; PrintException

getBoundsOfNode

protected Rectangle2D.Double getBoundsOfNode(Tree node)

getText
```
protected String getText(Tree tree)
```

getTreeTextProvider

public TreeTextProvider getTreeTextProvider()

setTreeTextProvider

public void setTreeTextProvider(TreeTextProvider treeTextProvider)

setFontSize
```
public void setFontSize(int sz)
```

setFontName
```
public void setFontName(String name)
```

addHighlightedNodes

public void addHighlightedNodes(Collection<Tree> nodes)

Slow for big lists of highlighted nodes

removeHighlightedNodes

public void removeHighlightedNodes(Collection<Tree> nodes)

isHighlighted

protected boolean isHighlighted(Tree node)

getHighlightedNodeIndex

protected int getHighlightedNodeIndex(Tree node)

getFont
```
public Font getFont()
```

setFont
```
public void setFont(Font font)
```

getArcSize
```
public int getArcSize()
```

setArcSize
```
public void setArcSize(int arcSize)
```

getBoxColor
```
public Color getBoxColor()
```

setBoxColor

public void setBoxColor(Color boxColor)

getHighlightedBoxColor
```
public Color getHighlightedBoxColor()
```

setHighlightedBoxColor

public void setHighlightedBoxColor(Color highlightedBoxColor)

getBorderColor
```
public Color getBorderColor()
```

setBorderColor

public void setBorderColor(Color borderColor)

getTextColor
```
public Color getTextColor()
```

setTextColor

public void setTextColor(Color textColor)

getTree
```
protected <any> getTree()
```

setTree
```
public void setTree(Tree root)
```

getTreeLayoutAdaptor
```
public <any> getTreeLayoutAdaptor(Tree root)
```
Get an adaptor for root that indicates how to walk ANTLR trees. Override to change the adapter from the default of TreeLayoutAdaptor

getScale
```
public double getScale()
```

setScale
```
public void setScale(double scale)
```

setRuleNames

public void setRuleNames(List<String> ruleNames)

Class TreeViewer

Nested Class Summary

Nested Classes

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

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Constructors

Method Summary

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

LIGHT_RED

treeTextProvider

treeLayout

highlightedNodes

fontName

fontStyle

fontSize

font

gapBetweenLevels

gapBetweenNodes

nodeWidthPadding

nodeHeightPadding

arcSize

scale

boxColor

highlightedBoxColor

borderColor

textColor

Constructor Detail

TreeViewer

Method Detail

getUseCurvedEdges

setUseCurvedEdges

paintEdges

paintBox

text

paint

getComponentGraphics

showInDialog

open

save

getBoundsOfNode

getText

getTreeTextProvider

setTreeTextProvider

setFontSize

setFontName

addHighlightedNodes

removeHighlightedNodes

isHighlighted

getHighlightedNodeIndex

getFont

setFont

getArcSize

setArcSize

getBoxColor

setBoxColor

getHighlightedBoxColor

setHighlightedBoxColor

getBorderColor

setBorderColor

getTextColor

setTextColor

getTree

setTree

getTreeLayoutAdaptor

getScale

setScale

setRuleNames