agentgui.simulationService.time

Class TimeModelBaseExecutionElements

java.lang.Object

agentgui.simulationService.time.TimeModelBaseExecutionElements

All Implemented Interfaces:

java.awt.event.ActionListener, java.util.EventListener

Direct Known Subclasses:

TimeModelContinuousExecutionElements, TimeModelDiscreteExecutionElements, TimeModelStrokeExecutionElements

public abstract class TimeModelBaseExecutionElements
extends java.lang.Object
implements java.awt.event.ActionListener

The Class JToolBarElements4TimeModelExecution has to be extended in order to provide a specific display for a TimeModel during the execution of an agency.

See Also:

TimeModel

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.swing.JToolBar	jToolBar4Elements This is the JToolBar to which your elements can be added !
protected int	view
protected static int	ViewCOUNTDOWN
protected static int	ViewTIMER

Constructor Summary

Constructors

Constructor and Description
TimeModelBaseExecutionElements() Instantiates a new time model base execution elements.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent ae)
void	addToolbarElements() Adds the custom toolbar elements.
void	addToolbarElements(javax.swing.JToolBar jToolBar2AddElements) Adds the custom toolbar elements.
protected java.lang.String	getIntroductionHeader() Returns the introduction header of the tools.
protected javax.swing.JButton	getJButtonTimeConfig() Gets the button for the time configuration.
protected javax.swing.JLabel	getJLabelIntro() Returns the JLabel for the introduction of the TimeModel's display.
protected javax.swing.JLabel	getJLabelTimeDisplay() Returns the time display.
protected javax.swing.JMenuItem	getJMenuItemViewCountdown() Gets the j menu item view Countdown.
protected javax.swing.JMenuItem	getJMenuItemViewTimer() Gets the j menu item view timer.
protected javax.swing.JPopupMenu	getJPopupMenuViewConfiguration() Gets the j popup menu view configuration.
protected javax.swing.JToolBar.Separator	getSeparator(int numberOfSeperator) Returns a reminded separator, so that separators can be removed later on.
protected java.lang.String	getTimeDurationFormatted(long duration, java.lang.String timeFormat) Returns a time duration formatted.
protected java.lang.String	getTimeFormatted(long time, java.lang.String timeFormat) Returns a time formatted.
abstract TimeModel	getTimeModel() Returns the TimeModel.
abstract java.lang.String	getToolBarTitle() Returns the tool bar title as for example 'Time' or 'Counter'.
protected void	removeAllSeparator() Removes all separator.
void	removeToolbarElements() Removes the custom toolbar elements.
protected void	setIntroductionHeader(java.lang.String newIntroHeader) Sets the introduction header for the tools.
abstract void	setTimeModel(TimeModel timeModel) Sets the TimeModel.

Methods inherited from class java.lang.Object

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

Field Detail

ViewTIMER

protected static final int ViewTIMER

See Also:

Constant Field Values

ViewCOUNTDOWN

protected static final int ViewCOUNTDOWN

See Also:

Constant Field Values

view

protected int view

jToolBar4Elements

protected javax.swing.JToolBar jToolBar4Elements

This is the JToolBar to which your elements can be added !

Constructor Detail

TimeModelBaseExecutionElements

public TimeModelBaseExecutionElements()

Instantiates a new time model base execution elements.

Method Detail

setTimeModel

public abstract void setTimeModel(TimeModel timeModel)

Sets the TimeModel.

Parameters:

timeModel - the new TimeModel

getTimeModel

public abstract TimeModel getTimeModel()

Returns the TimeModel.

Returns:

the TimeModell

getToolBarTitle

public abstract java.lang.String getToolBarTitle()

Returns the tool bar title as for example 'Time' or 'Counter'. Place here a name of your choice.

Returns:

the tool bar title

setIntroductionHeader

protected void setIntroductionHeader(java.lang.String newIntroHeader)

Sets the introduction header for the tools.

Parameters:

newIntroHeader - the new introduction header for the GUI representation

getIntroductionHeader

protected java.lang.String getIntroductionHeader()

Returns the introduction header of the tools.

Returns:

the introduction header

addToolbarElements

public void addToolbarElements(javax.swing.JToolBar jToolBar2AddElements)

Adds the custom toolbar elements.

Parameters:

jToolBar2AddElements -

addToolbarElements

public void addToolbarElements()

Adds the custom toolbar elements.

removeToolbarElements

public void removeToolbarElements()

Removes the custom toolbar elements.

getSeparator

protected javax.swing.JToolBar.Separator getSeparator(int numberOfSeperator)

Returns a reminded separator, so that separators can be removed later on.

Parameters:

numberOfSeperator - the number of separator

Returns:

the separator

removeAllSeparator

protected void removeAllSeparator()

Removes all separator.

getTimeFormatted

protected java.lang.String getTimeFormatted(long time,
                                            java.lang.String timeFormat)

Returns a time formatted.

Parameters:

time - the time

timeFormat - the time format

Returns:

the time formated

getTimeDurationFormatted

protected java.lang.String getTimeDurationFormatted(long duration,
                                                    java.lang.String timeFormat)

Returns a time duration formatted.

Parameters:

duration - the time difference

timeFormat - the time format

Returns:

the time formated

getJLabelIntro

protected javax.swing.JLabel getJLabelIntro()

Returns the JLabel for the introduction of the TimeModel's display.

Returns:

the JLabel for the introduction

getJLabelTimeDisplay

protected javax.swing.JLabel getJLabelTimeDisplay()

Returns the time display.

Returns:

the time display

getJButtonTimeConfig

protected javax.swing.JButton getJButtonTimeConfig()

Gets the button for the time configuration.

Returns:

the button for the time configuration

getJPopupMenuViewConfiguration

protected javax.swing.JPopupMenu getJPopupMenuViewConfiguration()

Gets the j popup menu view configuration.

Returns:

the j popup menu view configuration

getJMenuItemViewTimer

protected javax.swing.JMenuItem getJMenuItemViewTimer()

Gets the j menu item view timer.

Returns:

the j menu item view timer

getJMenuItemViewCountdown

protected javax.swing.JMenuItem getJMenuItemViewCountdown()

Gets the j menu item view Countdown.

Returns:

the j menu item view Countdown

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent ae)

Specified by:

actionPerformed in interface java.awt.event.ActionListener