desmoj.extensions.experimentation.ui

Class GraphicalObserver

java.lang.Object

desmoj.extensions.experimentation.ui.GraphicalObserver

All Implemented Interfaces:

SimRunListener, IGraphicalObserver, java.util.EventListener

Direct Known Subclasses:

HistogramPlotter, TimeSeriesPlotter

public abstract class GraphicalObserver
extends java.lang.Object
implements SimRunListener, IGraphicalObserver

Base class for graphical observers in the experiment launcher. A graphical observer can display itself inside a graphical observer context (e.g. a JDesktop component).

Version:

DESMO-J, Ver. 2.5.1c copyright (c) 2015

Author:

Nicolas Knaak Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Constructor Summary

Constructors

Constructor and Description
GraphicalObserver(java.lang.String name, GraphicalObserverContext c) Creates a new graphical observer.

Method Summary

Modifier and Type	Method and Description
void	deregister() Deregisters the observer from the context
GraphicalObserverContext	getContext() Returns the context this observer is displayed in
abstract java.awt.Component	getGUI() Should return the graphical observer's main GUI component
java.lang.String	getName() Returns the observer's name
void	register() Registers the observer with the context
void	setLocation(int x, int y) Sets the position of the observer's main window's upper left edge.
void	setSize(int width, int height) Sets the observer's main window's size.
void	setVisible(boolean visible) Sets the observer visible withing the context
void	update() Requests an update of the observer's display from the context.

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphicalObserver

public GraphicalObserver(java.lang.String name,
                         GraphicalObserverContext c)

Creates a new graphical observer.

Parameters:

name - Name of the graphical observer

c - the context this graphical observer is displayed in

Method Detail

getContext

public GraphicalObserverContext getContext()

Description copied from interface: IGraphicalObserver

Returns the context this observer is displayed in

Specified by:

getContext in interface IGraphicalObserver

Returns:

The context (e.g. a JDesktop component).

getGUI

public abstract java.awt.Component getGUI()

Description copied from interface: IGraphicalObserver

Should return the graphical observer's main GUI component

Specified by:

getGUI in interface IGraphicalObserver

Returns:

an AWT or Swing component.

register

public void register()

Description copied from interface: IGraphicalObserver

Registers the observer with the context

Specified by:

register in interface IGraphicalObserver

deregister

public void deregister()

Description copied from interface: IGraphicalObserver

Deregisters the observer from the context

Specified by:

deregister in interface IGraphicalObserver

setVisible

public void setVisible(boolean visible)

Description copied from interface: IGraphicalObserver

Sets the observer visible withing the context

Specified by:

setVisible in interface IGraphicalObserver

setSize

public void setSize(int width,
                    int height)

Description copied from interface: IGraphicalObserver

Sets the observer's main window's size.

Specified by:

setSize in interface IGraphicalObserver

Parameters:

width - window width

height - window height

setLocation

public void setLocation(int x,
                        int y)

Description copied from interface: IGraphicalObserver

Sets the position of the observer's main window's upper left edge.

Specified by:

setLocation in interface IGraphicalObserver

Parameters:

x - horizontal position

y - vertical position

getName

public java.lang.String getName()

Description copied from interface: IGraphicalObserver

Returns the observer's name

Specified by:

getName in interface IGraphicalObserver

Returns:

name

update

public void update()

Description copied from interface: IGraphicalObserver

Requests an update of the observer's display from the context.

Specified by:

update in interface IGraphicalObserver