grammarscope.editor.component

Class BalloonTip

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

grammarscope.editor.component.BalloonTip

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class BalloonTip
extends javax.swing.JPanel

A balloon tip which can be displayed

• left-aligned above
• left-aligned below
• right-aligned above
• right-aligned below

the attached component. See enumeration BalloonTip.Alignment. The balloon tip uses a JTextPane to render its contents which allows use of HTML code. Create a balloon tip by using the static create methods. You can choose between two looks.

Author:

Bernhard Pauler, Bernard Bou

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BalloonTip.Alignment Alignment enumeration

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

javax.swing.JPanel.AccessibleJPanel

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

Fields

Modifier and Type	Field and Description
private BalloonTip.Alignment	alignment Balloon's alignment
private java.awt.Component	attachedComponent Balloon's external attached component
private static java.awt.Color	backcolor Back color
private javax.swing.JComponent	component Balloon's internal main component
private static javax.swing.Icon	defaultCloseIcon Close icon
private static javax.swing.border.Border	editingBorder Border
private static int	H_SHRINK
private int	horizontalOffset Horizontal position offset
private java.lang.String	label Label
private javax.swing.Popup	popup Popup window
private static javax.swing.Icon	pressedCloseIcon Pressed close icon
private static javax.swing.Icon	rolloverCloseIcon Rollover close icon
private static long	serialVersionUID
private javax.swing.text.JTextComponent	textComponent Balloon's internal text component
private static int	V_EXPAND
private int	verticalOffset Vertical position offset

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
BalloonTip(javax.swing.JTextPane textComponent, java.awt.Component attachedComponent, BalloonTip.Alignment alignment, int horizontalOffset, int verticalOffset, java.lang.String label, boolean useCloseButton) Constructor

Method Summary

Modifier and Type	Method and Description
private java.awt.Dimension	calcPreferredSize() Calculate preferred size
private java.awt.Point	calcWhere() Compute location
void	setText(java.lang.String text) Set text
void	setVisible(boolean show)

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

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, isValidateRoot, 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, 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, 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, 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, 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

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

backcolor

private static final java.awt.Color backcolor

Back color

editingBorder

private static final javax.swing.border.Border editingBorder

Border

popup

private javax.swing.Popup popup

Popup window

attachedComponent

private final java.awt.Component attachedComponent

Balloon's external attached component

textComponent

private final javax.swing.text.JTextComponent textComponent

Balloon's internal text component

component

private final javax.swing.JComponent component

Balloon's internal main component

alignment

private final BalloonTip.Alignment alignment

Balloon's alignment

horizontalOffset

private final int horizontalOffset

Horizontal position offset

verticalOffset

private final int verticalOffset

Vertical position offset

label

private final java.lang.String label

Label

defaultCloseIcon

private static final javax.swing.Icon defaultCloseIcon

Close icon

rolloverCloseIcon

private static final javax.swing.Icon rolloverCloseIcon

Rollover close icon

pressedCloseIcon

private static final javax.swing.Icon pressedCloseIcon

Pressed close icon

H_SHRINK

private static final int H_SHRINK

See Also:

Constant Field Values

V_EXPAND

private static final int V_EXPAND

See Also:

Constant Field Values

Constructor Detail

BalloonTip

public BalloonTip(javax.swing.JTextPane textComponent,
                  java.awt.Component attachedComponent,
                  BalloonTip.Alignment alignment,
                  int horizontalOffset,
                  int verticalOffset,
                  java.lang.String label,
                  boolean useCloseButton)

Constructor

Parameters:

textComponent - internal text component

attachedComponent - external attached component

alignment - alignment

horizontalOffset - horizontal offset

verticalOffset - vertical offset

label - label

useCloseButton - whether to use close button

Method Detail

calcWhere

private java.awt.Point calcWhere()

Compute location

Returns:

location to place balloon

calcPreferredSize

private java.awt.Dimension calcPreferredSize()

Calculate preferred size

Returns:

text component's preferred size

setText

public void setText(java.lang.String text)

Set text

Parameters:

text - text

setVisible

public void setVisible(boolean show)

Overrides:

setVisible in class javax.swing.JComponent