org.sikuli.guide

Class Guide

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

org.sikuli.util.OverlayTransparentWindow

org.sikuli.guide.Guide

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants, EventObserver, EventSubject

public class Guide
extends OverlayTransparentWindow
implements EventObserver

See Also:

Serialized Form

Nested Class Summary

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

JFrame.AccessibleJFrame

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

Frame.AccessibleAWTFrame

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

Window.AccessibleAWTWindow, Window.Type

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
static int	FIRST
static int	LAST
static int	MIDDLE
static int	SIMPLE

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
Guide() create a new guide overlay on whole primary screen
Guide(Region region) create a new guide overlay on given region

Method Summary

Modifier and Type	Method and Description
Visual	addBeam(Region r)
void	addComponent(JComponent comp)
void	addComponent(Visual comp, int index)
void	addToFront(JComponent comp)
void	addToFront(Visual comp)
void	addTracker(Pattern pattern, Region r, ArrayList<Visual> components)
void	addTracker(Pattern pattern, Region r, Visual c)
void	addTracker(Pattern pattern, SxAnchor anchor)
void	addTransition(Transition t)
Visual	arrow(Object from, Object to)
Visual	bracket()
Visual	button(String name)
Visual	callout(String text)
Visual	circle()
void	clear()
Visual	flag(String text)
void	focusBelow()
Region	getRegion()
Transition	getTransition()
Visual	image(Object img)
Visual	rectangle() create a rectangle in this guide plane and add to front
void	removeComponent(Component comp)
void	removeSpotlights()
void	setDarken(boolean darken)
void	setDefaultTimeout(float timeout_in_seconds)
void	setDialog(String message)
void	setDialog(TransitionDialog dialog_)
String	showNow()
String	showNow(float secs)
void	startAnimation()
void	startTracking()
void	stopAnimation()
void	stopTracking()
Visual	text(String text)
void	toFront()
void	update(EventSubject es)
void	updateSpotlights(ArrayList<Region> regions)

Methods inherited from class org.sikuli.util.OverlayTransparentWindow

addObserver, close, getJPanel, getJPanelGraphics, notifyObserver, setOpacity

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

FIRST

public static final int FIRST

See Also:

Constant Field Values

MIDDLE

public static final int MIDDLE

See Also:

Constant Field Values

LAST

public static final int LAST

See Also:

Constant Field Values

SIMPLE

public static final int SIMPLE

See Also:

Constant Field Values

Constructor Detail

Guide

public Guide()

create a new guide overlay on whole primary screen

Guide

public Guide(Region region)

create a new guide overlay on given region

Method Detail

focusBelow

public void focusBelow()

toFront

public void toFront()

Overrides:

toFront in class Window

update

public void update(EventSubject es)

Specified by:

update in interface EventObserver

showNow

public String showNow(float secs)

showNow

public String showNow()

addToFront

public void addToFront(JComponent comp)

addComponent

public void addComponent(JComponent comp)

addToFront

public void addToFront(Visual comp)

addComponent

public void addComponent(Visual comp,
                         int index)

removeComponent

public void removeComponent(Component comp)

clear

public void clear()

setDefaultTimeout

public void setDefaultTimeout(float timeout_in_seconds)

getRegion

public Region getRegion()

updateSpotlights

public void updateSpotlights(ArrayList<Region> regions)

removeSpotlights

public void removeSpotlights()

setDarken

public void setDarken(boolean darken)

addBeam

public Visual addBeam(Region r)

setDialog

public void setDialog(String message)

setDialog

public void setDialog(TransitionDialog dialog_)

stopAnimation

public void stopAnimation()

startAnimation

public void startAnimation()

addTransition

public void addTransition(Transition t)

getTransition

public Transition getTransition()

startTracking

public void startTracking()

stopTracking

public void stopTracking()

addTracker

public void addTracker(Pattern pattern,
                       SxAnchor anchor)

addTracker

public void addTracker(Pattern pattern,
                       Region r,
                       Visual c)

addTracker

public void addTracker(Pattern pattern,
                       Region r,
                       ArrayList<Visual> components)

rectangle

public Visual rectangle()

create a rectangle in this guide plane and add to front

Returns:

the rectangle

circle

public Visual circle()

text

public Visual text(String text)

flag

public Visual flag(String text)

callout

public Visual callout(String text)

image

public Visual image(Object img)

bracket

public Visual bracket()

arrow

public Visual arrow(Object from,
                    Object to)

button

public Visual button(String name)