Package jmri.jmrit.throttle

Class ThrottleFrameManager

java.lang.Object

jmri.jmrit.throttle.ThrottleFrameManager

All Implemented Interfaces:

Iterable<ThrottleControllersUIContainer>, InstanceManagerAutoDefault, ThrottleControllersUIContainersManager

public class ThrottleFrameManager
extends Object
implements InstanceManagerAutoDefault, ThrottleControllersUIContainersManager

Interface for allocating and deallocating throttles frames. Not to be confused with ThrottleManager.

Constructor Summary

Constructors

Constructor	Description
ThrottleFrameManager()	Constructor for the ThrottleFrameManager object.

Method Summary

Modifier and Type	Method	Description
void	applyPreferences()
ThrottleControllerUI	createThrottleController()	Create a new throttle controller
ThrottleFrame	createThrottleFrame()	Tell this manager that a new ThrottleFrame was created.
ThrottleFrame	createThrottleFrame(ConnectionConfig connectionConfig)	Tell this manager that a new ThrottleFrame was created.
ThrottleWindow	createThrottleWindow()	Tell this manager that a new ThrottleWindow was created.
ThrottleWindow	createThrottleWindow(ConnectionConfig connectionConfig)	Tell this manager that a new ThrottleWindow was created.
ThrottleWindow	createThrottleWindow(org.jdom2.Element e)	Tell this manager that a new ThrottleWindow was created.
void	emergencyStopAll()	Force emergency stop of all managed throttles windows
int	generateUniqueFrameID()
ThrottleWindow	getCurrentThrottleFrame()
int	getNbThrottleControllersContainers()	Return the number of active thottle windows.
int	getNumberOfEntriesFor(DccLocoAddress la)	Get the number of usages of a particular Loco Address.
ThrottleControllersUIContainer	getThrottleControllersContainerAt(int n)	Return the thottle controller container at nth position in the list
ThrottlesListPanel	getThrottlesListPanel()
Iterator<ThrottleControllersUIContainer>	iterator()
void	requestAllThrottleWindowsDestroyed()
void	requestFocusForNextThrottleWindow()
void	requestFocusForPreviousThrottleWindow()
void	requestThrottleWindowDestruction(ThrottleWindow frame)	Request that this manager destroy a throttle frame.
void	showThrottlesList()
void	showThrottlesPreferences()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

ThrottleFrameManager

public ThrottleFrameManager()

Constructor for the ThrottleFrameManager object.

Method Details

createThrottleWindow

public ThrottleWindow createThrottleWindow()

Tell this manager that a new ThrottleWindow was created.

Returns:

The newly created ThrottleWindow

createThrottleWindow

public ThrottleWindow createThrottleWindow(ConnectionConfig connectionConfig)

Tell this manager that a new ThrottleWindow was created.

Parameters:

connectionConfig - the connection config

Returns:

The newly created ThrottleWindow

createThrottleWindow

public ThrottleWindow createThrottleWindow(org.jdom2.Element e)

Tell this manager that a new ThrottleWindow was created.

Parameters:

e - the xml element for the throttle window

Returns:

The newly created ThrottleWindow

createThrottleFrame

public ThrottleFrame createThrottleFrame()

Tell this manager that a new ThrottleFrame was created.

Returns:

The newly created ThrottleFrame

createThrottleController

public ThrottleControllerUI createThrottleController()

Description copied from interface: ThrottleControllersUIContainersManager

Create a new throttle controller

Specified by:

createThrottleController in interface ThrottleControllersUIContainersManager

Returns:

The newly created throttle controller

createThrottleFrame

public ThrottleFrame createThrottleFrame(ConnectionConfig connectionConfig)

Tell this manager that a new ThrottleFrame was created.

Parameters:

connectionConfig - the connection config

Returns:

The newly created ThrottleFrame

requestThrottleWindowDestruction

public void requestThrottleWindowDestruction(ThrottleWindow frame)

Request that this manager destroy a throttle frame.

Parameters:

frame - The to-be-destroyed ThrottleFrame

requestAllThrottleWindowsDestroyed

public void requestAllThrottleWindowsDestroyed()

generateUniqueFrameID

public int generateUniqueFrameID()

iterator

public Iterator<ThrottleControllersUIContainer> iterator()

Specified by:

iterator in interface Iterable<ThrottleControllersUIContainer>

getNbThrottleControllersContainers

public int getNbThrottleControllersContainers()

Return the number of active thottle windows.

Specified by:

getNbThrottleControllersContainers in interface ThrottleControllersUIContainersManager

Returns:

the number of active thottle window.

getThrottleControllersContainerAt

public ThrottleControllersUIContainer getThrottleControllersContainerAt(int n)

Description copied from interface: ThrottleControllersUIContainersManager

Return the thottle controller container at nth position in the list

Specified by:

getThrottleControllersContainerAt in interface ThrottleControllersUIContainersManager

Parameters:

n - position of the throttle controller container

Returns:

a thottle controller container

requestFocusForNextThrottleWindow

public void requestFocusForNextThrottleWindow()

requestFocusForPreviousThrottleWindow

public void requestFocusForPreviousThrottleWindow()

getCurrentThrottleFrame

public ThrottleWindow getCurrentThrottleFrame()

getThrottlesListPanel

public ThrottlesListPanel getThrottlesListPanel()

showThrottlesList

public void showThrottlesList()

showThrottlesPreferences

public void showThrottlesPreferences()

applyPreferences

public void applyPreferences()

emergencyStopAll

public void emergencyStopAll()

Force emergency stop of all managed throttles windows

getNumberOfEntriesFor

public int getNumberOfEntriesFor(@CheckForNull
 DccLocoAddress la)

Get the number of usages of a particular Loco Address.

Specified by:

getNumberOfEntriesFor in interface ThrottleControllersUIContainersManager

Parameters:

la - the Loco Address, can be null.

Returns:

0 if no usages, else number of AddressPanel usages.