com.sentidolabs.ttk

Class Stencil

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.sentidolabs.ttk.Stencil

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class Stencil
extends JPanel

Semi-transparent overlay with holes and call-outs for certain UI components.

The underlaying application is only accessible through the holes in the Stencil made with addHoleFor(JComponent)

Call-outs (notes with the feedback) are placed on the stencil with add(Component)

When making holes or adding covers in the stencil, a layer name can be specified. Otherwise those operations are done in the default layer.

See Also:

Serialized Form

Nested Class Summary

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

Constructor and Description
Stencil(JFrame window) Constructs a new stencil overlaid on the given window.
Stencil(JFrame window, boolean defaultCovered) Constructs a new stencil overlaid on the given window.

Method Summary

Methods

Modifier and Type	Method and Description
Component	add(Component component) Add a CallOut component to the stencil.
Component	add(Component component, int index) This is the same as add(Component)
void	add(Component component, Object constraints) This is the same as add(Component)
Component	add(String name, Component component) This is the same as add(Component)
void	addCoverFor(JComponent target) Add a cover for the given target.
void	addCoverFor(JComponent target, String layerName) Add a cover for the given target in the named layer.
void	addHoleFor(JComponent target) Punch a hole in the stencil for the given GUI component.
void	addHoleFor(JComponent target, String layerName) Punch a hole in the stencil for the given GUI component in the named layer.
boolean	contains(int x, int y)
void	detach() Detach the stencil from its window, restoring the window's original glass pane, focus traversal policy, etc.
static Rectangle	getBoundsAbsolute(Container container, JComponent component) Compute the bounds of a component with respect to a container.
boolean	isOptimizedDrawingEnabled()
void	paintComponent(Graphics g)
void	removeAll() Remove all call-outs from the stencil.
void	reset() Remove all holes and covers from the stencil.
void	reset(String layerName) Remove all holes and covers from the stencil in the named layer.
void	setColour(int red, int green, int blue) Set the colour for the stencil overlay.
void	setColour(Paint paint) Set the paint for the stencil overlay.
void	setOpacity(int opacity) Set the opacity of the stencil overlay.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, 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, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, 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, 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, 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, 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

Constructor Detail

Stencil

public Stencil(JFrame window)

Constructs a new stencil overlaid on the given window.

Parameters:

window - the frame whose glass pane will be replaced by the stencil. The original glass pane is restored when calling detach()

Stencil

public Stencil(JFrame window,
       boolean defaultCovered)

Constructs a new stencil overlaid on the given window. If it is set to not cover the whole window by default, only those components for which addCoverFor(JComponent) is called will be covered.

Parameters:

window - the frame whose glass pane will be replaced by the stencil.

defaultCovered - whether the stencil will cover the whole window by default or not

Method Detail

setColour

public void setColour(int red,
             int green,
             int blue)

Set the colour for the stencil overlay.

Parameters:

red - from 0 to 255

green - from 0 to 255

blue - from 0 to 255

setColour

public void setColour(Paint paint)

Set the paint for the stencil overlay. This allows painting the stencil with gradients, textures and other effects instead of just a flat colour. The paint object must already contain any opacity information: calling setOpacity(int) does not have any effect in this case unless paint is an instance of Color.

Parameters:

paint - generic paint object that can be a colour, a gradient, etc.

See Also:

Color, SystemColor, LinearGradientPaint, MultipleGradientPaint, RadialGradientPaint, TexturePaint

setOpacity

public void setOpacity(int opacity)

Set the opacity of the stencil overlay. This call has no effect if the stencil colour is set with setColour(Paint) and the given paint is not an instance of Color.

Parameters:

opacity - from 0 (fully transparent) to 255 (fully opaque)

detach

public void detach()

Detach the stencil from its window, restoring the window's original glass pane, focus traversal policy, etc.

addHoleFor

public void addHoleFor(JComponent target)

Punch a hole in the stencil for the given GUI component. The is no limit for the number of holes in a given stencil.

Parameters:

target - component that will be accesible through the hole

addHoleFor

public void addHoleFor(JComponent target,
              String layerName)

Punch a hole in the stencil for the given GUI component in the named layer. The is no limit for the number of holes or layers in a given stencil.

Parameters:

target - component that will be accesible through the hole

layerName - name of the stencil layer

addCoverFor

public void addCoverFor(JComponent target)

Add a cover for the given target. A cover is the inverse of a hole. The is no limit for the number of covers in a given stencil.

Parameters:

target - component to be covered by the stencil

addCoverFor

public void addCoverFor(JComponent target,
               String layerName)

Add a cover for the given target in the named layer. A cover is the inverse of a hole. The is no limit for the number of covers or layers in a given stencil.

Parameters:

target - component to be covered by the stencil

layerName - name of the stencil layer

removeAll

public void removeAll()

Remove all call-outs from the stencil.

Overrides:

removeAll in class Container

reset

public void reset()

Remove all holes and covers from the stencil.

reset

public void reset(String layerName)

Remove all holes and covers from the stencil in the named layer.

add

public Component add(Component component)

Add a CallOut component to the stencil.

Overrides:

add in class Container

Parameters:

component - component to add, ignored if it is not a call-out

Returns:

component added

add

public Component add(String name,
            Component component)

This is the same as add(Component)

Overrides:

add in class Container

Parameters:

name - component's name, ignored

component - component to add, ignored if it is not a call-out

Returns:

component added

add

public Component add(Component component,
            int index)

This is the same as add(Component)

Overrides:

add in class Container

Parameters:

component - component to add, ignored if it is not a call-out

index - component's index, ignored

Returns:

component added

add

public void add(Component component,
       Object constraints)

This is the same as add(Component)

Overrides:

add in class Container

Parameters:

component - component to add, ignored if it is not a call-out

constraints - layout constraints, ignored

getBoundsAbsolute

public static Rectangle getBoundsAbsolute(Container container,
                          JComponent component)

Compute the bounds of a component with respect to a container.

Parameters:

container - the reference container

component - the element whose bounds we want to compute

Returns:

bounding rectangle in coordinates relative to the container

paintComponent

public void paintComponent(Graphics g)

Overrides:

paintComponent in class JComponent

contains

public boolean contains(int x,
               int y)

Overrides:

contains in class JComponent

isOptimizedDrawingEnabled

public boolean isOptimizedDrawingEnabled()

Overrides:

isOptimizedDrawingEnabled in class JComponent