|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjava.awt.Component
java.awt.Container
javax.swing.JComponent
com.bbn.openmap.Layer
com.bbn.openmap.layer.OMGraphicHandlerLayer
com.bbn.openmap.layer.event.EventLayer
public class EventLayer
The EventLayer contains all the TemporalOMGraphics and manages the time for the graphics and how they should be displayed. This layer works as a TimeBoundsProvider (an object that provides an active range of time, a OMEventHandler (an object that provides OMEvents to the EventPanel/EventPresenter), and a TimeEventListener (an object that changes when the cloc changes).
Sample properties:
eventLayer.class=com.bbn.openmap.layer.time.EventLayer
eventLayer.importer=com.bbn.openmap.layer.time.CSVEventImporter
eventLayer.prettyName=Test Event
... see CSVEventImporter for its properties, other importers can be specified here.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class javax.swing.JComponent |
|---|
javax.swing.JComponent.AccessibleJComponent |
| Nested classes/interfaces inherited from class java.awt.Container |
|---|
java.awt.Container.AccessibleAWTContainer |
| Nested classes/interfaces inherited from class java.awt.Component |
|---|
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy |
| Field Summary | |
|---|---|
protected boolean |
active
|
protected DataBounds |
dataBounds
|
protected java.util.LinkedList<OMEvent> |
events
|
protected java.util.LinkedList<OMEvent> |
filters
|
protected EventImporter |
importer
|
static java.lang.String |
ImporterProperty
|
static java.util.logging.Logger |
logger
|
protected java.lang.String |
mode
|
protected long |
time
|
protected TimeBounds |
timeBounds
|
protected java.util.List<TimeBoundsHandler> |
timeBoundsHandlers
|
| Fields inherited from class com.bbn.openmap.layer.OMGraphicHandlerLayer |
|---|
consumeEvents, ConsumeEventsProperty, filter, interruptable, InterruptableProperty, layerWorker, LAYERWORKER_LOCK, layerWorkerQueue, mouseEventInterpreter, mouseModeIDs, MouseModesProperty, projectionChangePolicy, ProjectionChangePolicyProperty, renderPolicy, RenderPolicyProperty, selectedList, TransparencyProperty |
| 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 com.bbn.openmap.PropertyConsumer |
|---|
EditorProperty, initPropertiesProperty, LabelEditorProperty, ScopedEditorProperty |
| Fields inherited from interface java.awt.image.ImageObserver |
|---|
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH |
| Constructor Summary | |
|---|---|
EventLayer()
|
|
| Method Summary | |
|---|---|
void |
addTimeBoundsHandler(TimeBoundsHandler tbh)
The TimeBoundsProvider keep track of the handlers it needs to notify when the bounds or activeness changes. |
void |
callForTimeBoundsReset()
|
TemporalOMGraphicList |
createData()
Read the data files and construct the TemporalOMGraphics. |
void |
findAndInit(java.lang.Object someObj)
This method is called by the findAndInit(Iterator) method, once for every object inside the iterator. |
DataBounds |
getDataBounds()
DataBoundsProvider method. |
java.util.List<OMEvent> |
getEventList()
|
java.util.List<OMEvent> |
getEventList(java.util.List filters)
This is the main call to return OMEvents based on filters set in the GUI. |
java.util.List |
getFilters()
|
java.lang.Boolean |
getFilterState(java.lang.String filterName)
Query to find out if a filter should be enabled, based on EventHandler settings and history. |
java.util.List<OMEvent> |
getMacroFilteredList(java.util.Collection eventCollection)
|
java.lang.String |
getMode()
|
java.util.Properties |
getProperties(java.util.Properties props)
PropertyConsumer method, to fill in a Properties object, reflecting the current values of the layer. |
java.util.Properties |
getPropertyInfo(java.util.Properties list)
Method to fill in a Properties object with values reflecting the properties able to be set on this PropertyConsumer. |
long |
getTime()
|
TimeBounds |
getTimeBounds()
A method called on the TimeBoundsProvider to retrieve the provider's time bounds. |
void |
handleTimeBounds(TimeBounds tb)
A method called on the TimeBoundsProvider to inform it of the overall time bounds, in case some external time bounds values are being set by another component and this provider wants to react to those bounds in some way. |
boolean |
isActive()
A query that can be made to the TimeBoundsProvider asking it if it is active, and if it's time bounds should be considered. |
OMGraphicList |
prepare()
The main method call in the EventLayer that actually modifies the OMGraphics and updates the map. |
void |
removeTimeBoundsHandler(TimeBoundsHandler tbh)
The TimeBoundsProvider keep track of the handlers it needs to notify when the bounds or activeness changes. |
void |
setActive(boolean active)
An accessor that switches the TimeBoundsProvider on/off. |
void |
setFilterState(java.lang.String filterName,
java.lang.Boolean state)
|
void |
setMode(java.lang.String mode)
|
void |
setProperties(java.lang.String prefix,
java.util.Properties properties)
The properties and prefix are managed and decoded here, for the standard uses of the EventLayer. |
protected void |
setTimeBounds(TimeBounds tb)
|
void |
setVisible(boolean setting)
Part of a layer hack to notify the component listener when the component is hidden. |
void |
updateTime(TimeEvent te)
|
| Methods inherited from class javax.swing.JComponent |
|---|
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, 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, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, 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, unregisterKeyboardAction, update, updateUI |
| Methods inherited from class java.awt.Container |
|---|
add, add, add, add, 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, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree |
| Methods inherited from class java.awt.Component |
|---|
action, add, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, 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, 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, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface com.bbn.openmap.util.DataBoundsProvider |
|---|
getName |
| Methods inherited from interface java.beans.beancontext.BeanContextChild |
|---|
addPropertyChangeListener, removePropertyChangeListener |
| Field Detail |
|---|
public static java.util.logging.Logger logger
public static final java.lang.String ImporterProperty
protected EventImporter importer
protected DataBounds dataBounds
protected TimeBounds timeBounds
protected long time
protected java.lang.String mode
protected boolean active
protected java.util.List<TimeBoundsHandler> timeBoundsHandlers
protected java.util.LinkedList<OMEvent> events
protected java.util.LinkedList<OMEvent> filters
| Constructor Detail |
|---|
public EventLayer()
| Method Detail |
|---|
public OMGraphicList prepare()
prepare in class OMGraphicHandlerLayerpublic TemporalOMGraphicList createData()
public void setProperties(java.lang.String prefix,
java.util.Properties properties)
setProperties in interface PropertyConsumersetProperties in class OMGraphicHandlerLayerprefix - string prefix used in the properties file for this layer.properties - the properties set in the properties file.public java.util.Properties getProperties(java.util.Properties props)
getProperties in interface PropertyConsumergetProperties in class OMGraphicHandlerLayerprops - a Properties object to load the PropertyConsumer properties
into.
public java.util.Properties getPropertyInfo(java.util.Properties list)
getPropertyInfo in interface PropertyConsumergetPropertyInfo in class OMGraphicHandlerLayerlist - a Properties object to load the PropertyConsumer properties
into. If getList equals null, then a new Properties object should
be created.
public java.lang.String getMode()
public void setMode(java.lang.String mode)
public DataBounds getDataBounds()
getDataBounds in interface DataBoundsProviderpublic void findAndInit(java.lang.Object someObj)
Layer
findAndInit in class Layerpublic void addTimeBoundsHandler(TimeBoundsHandler tbh)
TimeBoundsProvider
addTimeBoundsHandler in interface TimeBoundsProviderprotected void setTimeBounds(TimeBounds tb)
public TimeBounds getTimeBounds()
TimeBoundsProvider
getTimeBounds in interface TimeBoundsProviderpublic void handleTimeBounds(TimeBounds tb)
TimeBoundsProvider
handleTimeBounds in interface TimeBoundsProviderpublic boolean isActive()
TimeBoundsProvider
isActive in interface TimeBoundsProviderpublic void setActive(boolean active)
TimeBoundsProvider
setActive in interface TimeBoundsProviderpublic void removeTimeBoundsHandler(TimeBoundsHandler tbh)
TimeBoundsProvider
removeTimeBoundsHandler in interface TimeBoundsProviderpublic void updateTime(TimeEvent te)
updateTime in interface TimeEventListenerpublic long getTime()
public java.util.List<OMEvent> getEventList()
getEventList in interface OMEventHandlerpublic java.util.List<OMEvent> getEventList(java.util.List filters)
OMEventHandler
getEventList in interface OMEventHandlerfilters - A List of Strings. If your OMEventHandler provides
entries into the filterList, you should check the entries on that
list to see if they are in this provided list. If they are, you
should return the OMEvents that fall under that filter String's
jurisdiction.
public java.lang.Boolean getFilterState(java.lang.String filterName)
OMEventHandler
getFilterState in interface OMEventHandlerfilterName - the filter string.
public java.util.List getFilters()
getFilters in interface OMEventHandlerpublic java.util.List<OMEvent> getMacroFilteredList(java.util.Collection eventCollection)
getMacroFilteredList in interface OMEventHandler
public void setFilterState(java.lang.String filterName,
java.lang.Boolean state)
setFilterState in interface OMEventHandlerpublic void callForTimeBoundsReset()
public void setVisible(boolean setting)
Layer
setVisible in class Layer
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||