no.gar.glink.api
Class GlinkScreenArea

java.lang.Object
  no.gar.glink.api.GlinkScreenArea

All Implemented Interfaces:

java.io.Serializable

public class GlinkScreenArea
extends java.lang.Object
implements java.io.Serializable

Use GlinkScreenArea objects to facilitate screen/form identification. Often a given text string at a specific location is enough to identify the current screen. Use the GlinkApi.getScreenArea to get an object for a given screen area and use the GlinkApi.notifyScreenArea for later be notified when the current screen matches this object. You may also use the GlinkApi.isScreenAreaMatch method to check if the object matches the current screen.

Two types of screen area are supported: rectangle and standard area. The latter goes from the starting point and continues on a line-by-line basis to the end point.

See Also:

GlinkApi.getScreenArea(java.awt.Point, java.awt.Point, boolean), GlinkApi.getMarkedScreenArea(), GlinkApi.notifyScreenArea, GlinkApi.isScreenAreaMatch(no.gar.glink.api.GlinkScreenArea), Serialized Form

Constructor Summary

GlinkScreenArea(java.awt.Point start, java.awt.Point end, boolean rectangle, java.lang.String string)

Method Summary

java.awt.Point	getEnd() Returns the end posistion for screen area.
java.awt.Point	getStart() Returns the start posistion for the screen area.
java.lang.String	getString() Returns the text string for the given screen area.
boolean	isRectangle() Returns true if the object is for a rectangle area.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GlinkScreenArea

public GlinkScreenArea(java.awt.Point start,
                       java.awt.Point end,
                       boolean rectangle,
                       java.lang.String string)

Method Detail

getEnd

public java.awt.Point getEnd()

Returns the end posistion for screen area.

getStart

public java.awt.Point getStart()

Returns the start posistion for the screen area.

getString

public java.lang.String getString()

Returns the text string for the given screen area. If the area is a rectangle, then all the text strings within the rectangle is concatenated into one string without any line separators.

isRectangle

public boolean isRectangle()

Returns true if the object is for a rectangle area.