ViewManager (JMap 7.0 Kathmandu API Documentation)

java.lang.Object
- com.kheops.jmap.client.views.ViewManager

All Implemented Interfaces:

JMapEventDispatcher, ViewEventListener, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.util.EventListener
```
public class ViewManager
extends java.lang.Object
implements JMapEventDispatcher, ViewEventListener, java.awt.event.MouseListener, java.awt.event.MouseMotionListener
```
The ViewManager class is responsible for managing View objects by keeping the list of views, by broadcasting the events to the views and by providing general services about the views such as determining which view is the currently active view. In an application, there is generally only one ViewManager instance.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Tool`	`currentTool`
`protected View`	`currentView`
`protected LayerRefreshManager`	`layerRefreshManager`
`protected java.util.Vector<java.awt.event.MouseListener>`	`mouseListeners`
`protected java.util.Vector<java.awt.event.MouseMotionListener>`	`mouseMotionListeners`
`protected ViewManagerEventDispatcher`	`viewEventDispatcher`
`protected java.util.Vector<View>`	`views`

Constructor Summary

Constructors
Constructor and Description

ViewManager()
Constructs a new ViewManager object

Constructors
Constructor and Description
`ViewManager()` Constructs a new ViewManager object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addMouseListener(java.awt.event.MouseListener listener)` Adds a new listener for mouse events.
`void`	`addMouseMotionListener(java.awt.event.MouseMotionListener listener)` Adds a new listener for mouse motion events.
`void`	`addView(View view)` Adds a new view to the list of views managed by this ViewManager object.
`void`	`addViewEventListener(ViewEventListener listener)` Adds a new listener for view events.
`void`	`addViewManagerEventListener(ViewManagerEventListener viewManagerEventListener)` Adds a new ViewManager listener.
`void`	`close()` Closes all views managed by this ViewManager object.
`void`	`dispatchEvent(JMapEvent event)` The `dispatchEvent` method is used to dispatch synchronously JMap events to all registered listeners.
`void`	`fireViewActivated(View view)` Fires a new viewActivated event using this ViewManager as the source of the event
`void`	`fireViewActivated(View view, java.lang.Object src)` Fires a new viewActivated event
`void`	`fireViewDeactivated(View view)`
`View`	`getActiveView()` Returns the current active view.
`LayerManager`	`getLayerManager()` Returns the layer manager of the active view.
`View`	`getView(java.lang.String viewName)`
`int`	`getViewCount()` Returns the number of views managed by the view manager.
`View[]`	`getViews()` Returns an array of views managed by this ViewManager object.
`void`	`mouseClicked(java.awt.event.MouseEvent e)`
`void`	`mouseDragged(java.awt.event.MouseEvent e)`
`void`	`mouseEntered(java.awt.event.MouseEvent e)`
`void`	`mouseExited(java.awt.event.MouseEvent e)`
`void`	`mouseMoved(java.awt.event.MouseEvent e)`
`void`	`mousePressed(java.awt.event.MouseEvent e)`
`void`	`mouseReleased(java.awt.event.MouseEvent e)`
`void`	`redraw(OrientedRectangle wcRegion, int drawOptions)` Redraws all views.
`void`	`refresh()` Refreshes all views managed by this ViewManager object.
`void`	`removeAllViews()` Removes all views managed by this ViewManager object.
`void`	`removeMouseListener(java.awt.event.MouseListener listener)` Removes a listener for mouse events.
`void`	`removeMouseMotionListener(java.awt.event.MouseMotionListener listener)` Removes a listener for mouse motion events.
`void`	`removeView(View view)` Removes the specified view of the list managed by this ViewManager object.
`void`	`removeViewEventListener(ViewEventListener listener)` Removes a listener for view events.
`void`	`removeViewManagerEventListener(ViewManagerEventListener viewManagerEventListener)` Removes a ViewManager listener.
`void`	`setCurrentTool(Tool currentTool)` Sets the current tool to be used by all registered View objects.
`void`	`viewChangedOccurred(ViewChangedEvent event)` This method handles ViewChangedEvent
`void`	`viewPopupMenuShowing(ViewPopupMenuShowingEvent event)` This method handles ViewPopupMenuShowing
`void`	`viewReadyOccurred(ViewReadyEvent event)` This method handles ViewReadyOccurred
`void`	`viewRedrawOccurred(ViewRedrawEvent event)` This method handles viewRedrawOccurred
`void`	`viewRepaintOccurred(ViewRepaintEvent event)` This method handles viewRepaintOccurred
`void`	`viewStaticElementChanged(ViewStaticElementEvent event)` This method handles viewStaticElementChanged
`void`	`viewToolChangedOccurred(ViewToolChangedEvent event)` This method handles ViewToolChangedEvent

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - currentTool
```
protected Tool currentTool
```
  - viewEventDispatcher
```
protected final ViewManagerEventDispatcher viewEventDispatcher
```
  - mouseListeners
```
protected final java.util.Vector<java.awt.event.MouseListener> mouseListeners
```
  - mouseMotionListeners
```
protected final java.util.Vector<java.awt.event.MouseMotionListener> mouseMotionListeners
```
  - views
```
protected java.util.Vector<View> views
```
  - currentView
```
protected View currentView
```
  - layerRefreshManager
```
protected LayerRefreshManager layerRefreshManager
```
- Constructor Detail
  - ViewManager
```
public ViewManager()
```
    Constructs a new ViewManager object
- Method Detail
  - dispatchEvent
```
public void dispatchEvent(JMapEvent event)
```
    The dispatchEvent method is used to dispatch synchronously JMap events to all registered listeners. The main use of the JMapEventDispatcher interface is to dispatch events that were previously added to the JMap event queue.
    Note: only ViewEvent and ViewManagerEvent will be accepted by this method. Any other JMap event types will cause the view manager to throw an exception.
    
    Specified by:
    
    dispatchEvent in interface JMapEventDispatcher
    
    Parameters:
    
    event - the event to be dispatched.
    
    Throws:
    
    java.lang.IllegalArgumentException - will be thrown if the JMapEvent instance is no an instance of the ViewEvent class.
    
    See Also:
    
    JMapEventQueue.push(JMapEvent, JMapEventDispatcher)
  - addView
```
public void addView(View view)
```
    Adds a new view to the list of views managed by this ViewManager object.
    
    Parameters:
    
    view - the view to be added
  - getView
```
public View getView(java.lang.String viewName)
```
  - removeView
```
public void removeView(View view)
```
    Removes the specified view of the list managed by this ViewManager object.
    
    Parameters:
    
    view - the View object to remove from the list.
  - removeAllViews
```
public void removeAllViews()
```
    Removes all views managed by this ViewManager object.
  - addViewEventListener
```
public void addViewEventListener(ViewEventListener listener)
```
    Adds a new listener for view events.
    
    Parameters:
    
    listener - the corresponding ViewEventListener
  - removeViewEventListener
```
public void removeViewEventListener(ViewEventListener listener)
```
    Removes a listener for view events.
    
    Parameters:
    
    listener - the corresponding ViewEventListener
  - addMouseListener
```
public void addMouseListener(java.awt.event.MouseListener listener)
```
    Adds a new listener for mouse events.
    
    Parameters:
    
    listener - the corresponding MouseListener
  - removeMouseListener
```
public void removeMouseListener(java.awt.event.MouseListener listener)
```
    Removes a listener for mouse events.
    
    Parameters:
    
    listener - the corresponding MouseListener
  - addMouseMotionListener
```
public void addMouseMotionListener(java.awt.event.MouseMotionListener listener)
```
    Adds a new listener for mouse motion events.
    
    Parameters:
    
    listener - the corresponding MouseMotionListener
  - removeMouseMotionListener
```
public void removeMouseMotionListener(java.awt.event.MouseMotionListener listener)
```
    Removes a listener for mouse motion events.
    
    Parameters:
    
    listener - the corresponding MouseMotionListener
  - getViewCount
```
public int getViewCount()
```
    Returns the number of views managed by the view manager.
    
    Returns:
    
    the number of views managed by the view manager.
  - getViews
```
public View[] getViews()
```
    Returns an array of views managed by this ViewManager object.
    
    Returns:
    
    an array of views
  - getActiveView
```
public View getActiveView()
```
    Returns the current active view. May return null if there's no views in this view manager.
    
    Returns:
    
    the active view
  - refresh
```
public void refresh()
```
    Refreshes all views managed by this ViewManager object.
  - redraw
```
public void redraw(OrientedRectangle wcRegion,
                   int drawOptions)
```
    Redraws all views. If clear is true, the view is erased first. Layers are drawn from lower position to higher position starting from fromLayer. WCRegion specifies the region to draw in WC coordinates. If drawing is already occurring, it will be stopped first.
    
    Parameters:
    
    drawOptions - a bit field value that specified parts to be drawn.
    
    wcRegion - the region to redraw.
  - close
```
public void close()
```
    Closes all views managed by this ViewManager object.
  - setCurrentTool
```
public void setCurrentTool(Tool currentTool)
```
    Sets the current tool to be used by all registered View objects.
    
    Parameters:
    
    currentTool - the tool to be used.
  - viewChangedOccurred
```
public void viewChangedOccurred(ViewChangedEvent event)
```
    Description copied from interface: ViewEventListener
    
    This method handles ViewChangedEvent
    
    Specified by:
    
    viewChangedOccurred in interface ViewEventListener
    
    Parameters:
    
    event - the corresponding ViewChangedEvent object
  - viewToolChangedOccurred
```
public void viewToolChangedOccurred(ViewToolChangedEvent event)
```
    Description copied from interface: ViewEventListener
    
    This method handles ViewToolChangedEvent
    
    Specified by:
    
    viewToolChangedOccurred in interface ViewEventListener
    
    Parameters:
    
    event - the corresponding ViewToolChangedEvent object
  - viewPopupMenuShowing
```
public void viewPopupMenuShowing(ViewPopupMenuShowingEvent event)
```
    Description copied from interface: ViewEventListener
    
    This method handles ViewPopupMenuShowing
    
    Specified by:
    
    viewPopupMenuShowing in interface ViewEventListener
    
    Parameters:
    
    event - the corresponding ViewPopupMenuShowingEvent object
  - viewRedrawOccurred
```
public void viewRedrawOccurred(ViewRedrawEvent event)
```
    Description copied from interface: ViewEventListener
    
    This method handles viewRedrawOccurred
    
    Specified by:
    
    viewRedrawOccurred in interface ViewEventListener
    
    Parameters:
    
    event - the corresponding ViewRedrawEvent object
  - viewRepaintOccurred
```
public void viewRepaintOccurred(ViewRepaintEvent event)
```
    Description copied from interface: ViewEventListener
    
    This method handles viewRepaintOccurred
    
    Specified by:
    
    viewRepaintOccurred in interface ViewEventListener
    
    Parameters:
    
    event - the corresponding ViewRepaintEvent object
  - viewStaticElementChanged
```
public void viewStaticElementChanged(ViewStaticElementEvent event)
```
    Description copied from interface: ViewEventListener
    
    This method handles viewStaticElementChanged
    
    Specified by:
    
    viewStaticElementChanged in interface ViewEventListener
    
    Parameters:
    
    event - the corresponding ViewStaticElementEvent object
  - viewReadyOccurred
```
public void viewReadyOccurred(ViewReadyEvent event)
```
    Description copied from interface: ViewEventListener
    
    This method handles ViewReadyOccurred
    
    Specified by:
    
    viewReadyOccurred in interface ViewEventListener
    
    Parameters:
    
    event - the corresponding ViewReadyEvent object
  - mouseClicked
```
public void mouseClicked(java.awt.event.MouseEvent e)
```
    Specified by:
    
    mouseClicked in interface java.awt.event.MouseListener
  - mouseEntered
```
public void mouseEntered(java.awt.event.MouseEvent e)
```
    Specified by:
    
    mouseEntered in interface java.awt.event.MouseListener
  - mouseExited
```
public void mouseExited(java.awt.event.MouseEvent e)
```
    Specified by:
    
    mouseExited in interface java.awt.event.MouseListener
  - mousePressed
```
public void mousePressed(java.awt.event.MouseEvent e)
```
    Specified by:
    
    mousePressed in interface java.awt.event.MouseListener
  - mouseReleased
```
public void mouseReleased(java.awt.event.MouseEvent e)
```
    Specified by:
    
    mouseReleased in interface java.awt.event.MouseListener
  - mouseDragged
```
public void mouseDragged(java.awt.event.MouseEvent e)
```
    Specified by:
    
    mouseDragged in interface java.awt.event.MouseMotionListener
  - mouseMoved
```
public void mouseMoved(java.awt.event.MouseEvent e)
```
    Specified by:
    
    mouseMoved in interface java.awt.event.MouseMotionListener
  - getLayerManager
```
public LayerManager getLayerManager()
```
    Returns the layer manager of the active view. May return null if there's no view in this view manager.
    
    Returns:
    
    layerMgr
  - addViewManagerEventListener
```
public void addViewManagerEventListener(ViewManagerEventListener viewManagerEventListener)
```
    Adds a new ViewManager listener.
    
    Parameters:
    
    viewManagerEventListener - the view manager listener to add
    
    See Also:
    
    ViewManagerEventListener
  - removeViewManagerEventListener
```
public void removeViewManagerEventListener(ViewManagerEventListener viewManagerEventListener)
```
    Removes a ViewManager listener.
    
    Parameters:
    
    viewManagerEventListener -
    
    See Also:
    
    the view manager listener to remove
  - fireViewActivated
```
public void fireViewActivated(View view)
```
    Fires a new viewActivated event using this ViewManager as the source of the event
    
    Parameters:
    
    view - activated view
  - fireViewActivated
```
public void fireViewActivated(View view,
                              java.lang.Object src)
```
    Fires a new viewActivated event
    
    Parameters:
    
    view - activated view
    
    src - the source of the event
  - fireViewDeactivated
```
public void fireViewDeactivated(View view)
```

Class ViewManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

currentTool

viewEventDispatcher

mouseListeners

mouseMotionListeners

views

currentView

layerRefreshManager

Constructor Detail

ViewManager

Method Detail

dispatchEvent

addView

getView

removeView

removeAllViews

addViewEventListener

removeViewEventListener

addMouseListener

removeMouseListener

addMouseMotionListener

removeMouseMotionListener

getViewCount

getViews

getActiveView

refresh

redraw

close

setCurrentTool

viewChangedOccurred

viewToolChangedOccurred

viewPopupMenuShowing

viewRedrawOccurred

viewRepaintOccurred

viewStaticElementChanged

viewReadyOccurred

mouseClicked

mouseEntered

mouseExited

mousePressed

mouseReleased

mouseDragged

mouseMoved

getLayerManager

addViewManagerEventListener

removeViewManagerEventListener

fireViewActivated

fireViewActivated

fireViewDeactivated