|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface OMGraphicHandler
This interface describes an object that manages OMGraphics. It provides a mechanism to filter what OMGraphics are displayed based on some criteria, and can also return graphics based on those criteria. It's assumed that when a filter is applied to an OMGraphicHandler, that it stays in place until resetFiltering() is called. Calling multiple filters sets a chain.
Method Summary | |
---|---|
boolean |
canSetList()
Indicates if the OMGraphicHandler can have its OMGraphicList set. |
boolean |
doAction(OMGraphic graphic,
OMAction action)
Allows the OMGraphicHandler to receive graphics or take some action on one. |
OMGraphicList |
filter(java.awt.Shape withinThisShape)
Filters the OMGraphicHandler graphic list so that graphics within the given shape will be visible. |
OMGraphicList |
filter(java.awt.Shape shapeBoundary,
boolean getInsideBoundary)
Filters the OMGraphicHandler graphic list so that graphics inside or outside the given shape will be visible. |
OMGraphicList |
filter(java.lang.String SQLQuery)
Filters the OMGraphicHandler graphic list so that graphics meeting the SQL query statement will be visible. |
OMGraphicList |
getList()
Return the graphic list currently being used by the OMGraphicHandler. |
void |
resetFiltering()
Remove all filters, and reset all graphics to be visible. |
void |
setList(OMGraphicList omgl)
Set the OMGraphicList within this OMGraphicHandler. |
boolean |
supportsSQL()
Returns true if the OMGraphicHandler can handle SQL statements for filtering. |
Method Detail |
---|
OMGraphicList filter(java.awt.Shape withinThisShape)
withinThisShape
- java.awt.Shape object defining a
boundary.
OMGraphicList filter(java.awt.Shape shapeBoundary, boolean getInsideBoundary)
shapeBoundary
- java.awt.Shape object defining a boundary.getInsideBoundary
- if true, the filter will look for
shapes inside and contacting the boundary. If false, the
filter will look for shapes outside the boundary.
boolean supportsSQL()
OMGraphicList filter(java.lang.String SQLQuery)
SQLQuery
- a SELECT SQL statement
boolean doAction(OMGraphic graphic, OMAction action)
graphic
- the OMGraphic to do the action on.action
- the OMAction describing what to do to the
graphic.
OMGraphicList getList()
OMGeometry.isVisible()
boolean canSetList()
void setList(OMGraphicList omgl)
void resetFiltering()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |