com.sentidolabs.ttk

Class CallOut

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.sentidolabs.ttk.CallOut

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

PaperNoteCallOut, ThoughtBubbleCallOut

public abstract class CallOut
extends JPanel

A call-out is a note that might be attached to one or more GUI components in the underlaying application, and is placed on a Stencil applied to the application's window.

This class provides the basic functionality but is not meant to be instantiated, only used as base for the actual classes that customize the appearance of the call-out by overriding paintComponent(Graphics)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	CallOut.Content
protected class	CallOut.Target

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

JPanel.AccessibleJPanel

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 Paint	background
protected Vector<Line2D>	connectors
protected CallOut.Content	content
protected Point	contentLocation
protected String	fontFamily
protected int	fontSize
protected Highlight	highlight
protected Vector<CallOut.Target>	highlightTargets
protected Stroke	stroke
protected Paint	strokePaint
protected Vector<CallOut.Target>	targets
protected boolean	targetsChanged

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

Constructors

Modifier	Constructor and Description
protected	CallOut()

Method Summary

Methods

Modifier and Type	Method and Description
Component	add(Component component)
Component	add(Component component, int index)
void	add(Component component, Object constraints)
Component	add(String name, Component component)
void	addHighlightTarget(JComponent target) Add a highlight target.
void	addTarget(JComponent target) Add a target for the call-out.
protected void	checkTargetChanges()
protected Line2D	computeConnector(JComponent targetComponent)
protected Line2D	computeConnector(Rectangle target)
void	doLayout()
protected Point	findPlaceFor(Dimension size) Find a place for the given source that does not conflict with the targets.
Rectangle	getContentBounds() Get the bounding box of the call-out's content.
void	paint(Graphics g)
abstract void	paintComponent(Graphics g) Paint the call-out.
void	setBackground(Color colour)
void	setBackground(Paint paint) Set the background paint.
Component	setContent(String innerHTML) Set the content of the call-out to the given HTML text.
void	setHighlight(Highlight highlight) Set the highlight to be used for hightlight targets.
void	setStroke(Paint paint, float thickness) Set the stroke for border drawing.

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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, 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, 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, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, 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, 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, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

strokePaint

protected Paint strokePaint

stroke

protected Stroke stroke

background

protected Paint background

highlight

protected Highlight highlight

fontSize

protected int fontSize

fontFamily

protected String fontFamily

content

protected CallOut.Content content

contentLocation

protected Point contentLocation

targets

protected Vector<CallOut.Target> targets

highlightTargets

protected Vector<CallOut.Target> highlightTargets

connectors

protected Vector<Line2D> connectors

targetsChanged

protected boolean targetsChanged

Constructor Detail

CallOut

protected CallOut()

Method Detail

setStroke

public void setStroke(Paint paint,
             float thickness)

Set the stroke for border drawing.

Parameters:

paint - colour, texture, etc.

thickness - floating-point number in pixels, e.g. 2.0f

setBackground

public void setBackground(Paint paint)

Set the background paint.

Parameters:

paint - colour, texture, etc.

setBackground

public void setBackground(Color colour)

Overrides:

setBackground in class JComponent

setHighlight

public void setHighlight(Highlight highlight)

Set the highlight to be used for hightlight targets.

Parameters:

highlight - the highlight style to be used

addTarget

public void addTarget(JComponent target)

Add a target for the call-out.

Parameters:

target - component that gets this call-out assigned to it

addHighlightTarget

public void addHighlightTarget(JComponent target)

Add a highlight target.

Parameters:

target - component that gets this highlight assigned to it

setContent

public Component setContent(String innerHTML)

Set the content of the call-out to the given HTML text.

Parameters:

innerHTML - new content as HTML

Returns:

a new JTextPane with the given content

getContentBounds

public Rectangle getContentBounds()

Get the bounding box of the call-out's content.

Returns:

bounding rectangle

add

public Component add(Component component)

Overrides:

add in class Container

add

public Component add(String name,
            Component component)

Overrides:

add in class Container

add

public Component add(Component component,
            int index)

Overrides:

add in class Container

add

public void add(Component component,
       Object constraints)

Overrides:

add in class Container

paintComponent

public abstract void paintComponent(Graphics g)

Paint the call-out. This is the method that must be overriden in subclasses for painting the call-out. Do not override paint(Graphics) When this function is called, the variable targetsChanged is true if there have been changes in the position or size of the targets, so that any cached computations can be updated.

Overrides:

paintComponent in class JComponent

Parameters:

g - graphics context where the call-out will be painted

paint

public void paint(Graphics g)

Overrides:

paint in class JComponent

doLayout

public void doLayout()

Overrides:

doLayout in class Container

computeConnector

protected Line2D computeConnector(JComponent targetComponent)

computeConnector

protected Line2D computeConnector(Rectangle target)

checkTargetChanges

protected void checkTargetChanges()

findPlaceFor

protected Point findPlaceFor(Dimension size)

Find a place for the given source that does not conflict with the targets.

Parameters:

size - dimensions of the source

Returns:

new location for the source