Package jmri.jmrit.throttle.implementation

Class ThrottleUICore

java.lang.Object

jmri.jmrit.throttle.implementation.ThrottleUICore

All Implemented Interfaces:

EventListener, AddressListener

public class ThrottleUICore
extends Object
implements AddressListener

Inner class of a throttle UI holding most of the logic. Used by classes actually implementing a throttle view (ThrottleFrame, SimpleThrottlePanel, ConsistFunctionPanel) This file is part of JMRI.

JMRI is free software; you can redistribute it and/or modify it under the terms of version 2 of the GNU General Public License as published by the Free Software Foundation. See the "COPYING" file for a copy of this license.

JMRI is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Constructor Summary

Constructors

Constructor	Description
ThrottleUICore(ThrottleManager tm, ThrottleControllerUI tc)
ThrottleUICore(ThrottleManager tm, ThrottleControllerUI tc, boolean withPopupMenu)

Method Summary

Modifier and Type	Method	Description
void	dispose()	Handle my own destruction.
void	eStop()
DccLocoAddress	getAddress()
AddressPanel	getAddressPanel()
BackgroundPanel	getBackgroundPanel()
ConsistFunctionPanel	getConsistFunctionsPanel()
ControlPanel	getControlPanel()
static String	getDefaultThrottleFilename()
static String	getDefaultThrottleFolder()
FunctionPanel	getFunctionPanel()
RosterEntry	getFunctionRosterEntry()
DccThrottle	getFunctionThrottle()
String	getLastUsedSaveFile()
LocoIconPanel	getLocoIconPanel()
RosterEntry	getRosterEntry()
SpeedPanel	getSpeedPanel()
DccThrottle	getThrottle()
void	getXml(ArrayList<org.jdom2.Element> children)	Collect the prefs of this object into the given XML Element array
boolean	hasActiveFunction()
void	loadDefaultThrottle()
org.jdom2.Element	loadThrottle(String sfile)
void	notifyAddressChosen(LocoAddress l)	Receive notification that a new address has been selected and validated.
void	notifyAddressReleased(LocoAddress la)	Receive notification that an address has been released/dispatched
void	notifyAddressThrottleFound(DccThrottle t)	Receive notification that a throttle has been found
void	notifyConsistAddressChosen(LocoAddress l)	Receive notification that a new Consist address has been selected.
void	notifyConsistAddressReleased(LocoAddress la)	Receive notification that a consist address has been released/dispatched.
void	notifyConsistAddressThrottleFound(DccThrottle throttle)	Receive notification that a throttle has been found
void	notifyRosterEntrySelected(RosterEntry re)	Receive notification that a new roster entry has been selected (and not validated yet).
void	saveRosterChanges()
void	saveThrottle(org.jdom2.Element throttleElement)
void	saveThrottleAs(org.jdom2.Element throttleElement)
void	setAddress(DccLocoAddress la)
void	setConsistAddress(DccLocoAddress la)
void	setLastUsedSaveFile(String lusf)
void	setRosterEntry(RosterEntry re)
void	setXml(org.jdom2.Element e)	Set the preferences based on the XML Element.

Methods inherited from class java.lang.Object

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

Constructor Details

ThrottleUICore

public ThrottleUICore(ThrottleManager tm,
 ThrottleControllerUI tc,
 boolean withPopupMenu)

ThrottleUICore

public ThrottleUICore(ThrottleManager tm,
 ThrottleControllerUI tc)

Method Details

getDefaultThrottleFolder

public static String getDefaultThrottleFolder()

getDefaultThrottleFilename

public static String getDefaultThrottleFilename()

getAddressPanel

public AddressPanel getAddressPanel()

getThrottle

public DccThrottle getThrottle()

getFunctionThrottle

public DccThrottle getFunctionThrottle()

getRosterEntry

public RosterEntry getRosterEntry()

getFunctionRosterEntry

public RosterEntry getFunctionRosterEntry()

getControlPanel

public ControlPanel getControlPanel()

getFunctionPanel

public FunctionPanel getFunctionPanel()

getSpeedPanel

public SpeedPanel getSpeedPanel()

getConsistFunctionsPanel

public ConsistFunctionPanel getConsistFunctionsPanel()

getBackgroundPanel

public BackgroundPanel getBackgroundPanel()

getLocoIconPanel

public LocoIconPanel getLocoIconPanel()

hasActiveFunction

public boolean hasActiveFunction()

setRosterEntry

public void setRosterEntry(RosterEntry re)

setAddress

public void setAddress(DccLocoAddress la)

getAddress

public DccLocoAddress getAddress()

setConsistAddress

public void setConsistAddress(DccLocoAddress la)

eStop

public void eStop()

dispose

public void dispose()

Handle my own destruction.

1. dispose of sub windows.
2. notify my manager of my demise.

saveRosterChanges

public void saveRosterChanges()

getXml

public void getXml(ArrayList<org.jdom2.Element> children)

Collect the prefs of this object into the given XML Element array

Parameters:

children - the array to fill with the XML Elements for this object. The caller will add these to the parent element as needed.

setXml

public void setXml(org.jdom2.Element e)

Set the preferences based on the XML Element.

• Window prefs
• Frame title
• ControlPanel
• FunctionPanel
• AddressPanel
• SpeedPanel

Parameters:

e - The Element for this object.

saveThrottleAs

public void saveThrottleAs(org.jdom2.Element throttleElement)

saveThrottle

public void saveThrottle(org.jdom2.Element throttleElement)

loadThrottle

public org.jdom2.Element loadThrottle(String sfile)
                               throws IOException,
NullPointerException,
org.jdom2.JDOMException,
FileNotFoundException

Throws:

IOException

NullPointerException

org.jdom2.JDOMException

FileNotFoundException

loadDefaultThrottle

public void loadDefaultThrottle()

notifyAddressChosen

public void notifyAddressChosen(LocoAddress l)

Description copied from interface: AddressListener

Receive notification that a new address has been selected and validated.

Specified by:

notifyAddressChosen in interface AddressListener

Parameters:

l - The address that is now selected and validated.

notifyRosterEntrySelected

public void notifyRosterEntrySelected(RosterEntry re)

Description copied from interface: AddressListener

Receive notification that a new roster entry has been selected (and not validated yet). In the RosterEntry combobox for example.

Specified by:

notifyRosterEntrySelected in interface AddressListener

Parameters:

re - The roster entry that is now selected.

notifyAddressReleased

public void notifyAddressReleased(LocoAddress la)

Description copied from interface: AddressListener

Receive notification that an address has been released/dispatched

Specified by:

notifyAddressReleased in interface AddressListener

Parameters:

la - The address released/dispatched

notifyAddressThrottleFound

public void notifyAddressThrottleFound(DccThrottle t)

Description copied from interface: AddressListener

Receive notification that a throttle has been found

Specified by:

notifyAddressThrottleFound in interface AddressListener

Parameters:

t - The throttle

notifyConsistAddressChosen

public void notifyConsistAddressChosen(LocoAddress l)

Description copied from interface: AddressListener

Receive notification that a new Consist address has been selected.

Specified by:

notifyConsistAddressChosen in interface AddressListener

Parameters:

l - The address that is now selected.

notifyConsistAddressReleased

public void notifyConsistAddressReleased(LocoAddress la)

Description copied from interface: AddressListener

Receive notification that a consist address has been released/dispatched.

Specified by:

notifyConsistAddressReleased in interface AddressListener

Parameters:

la - The address that is now selected.

notifyConsistAddressThrottleFound

public void notifyConsistAddressThrottleFound(DccThrottle throttle)

Description copied from interface: AddressListener

Receive notification that a throttle has been found

Specified by:

notifyConsistAddressThrottleFound in interface AddressListener

Parameters:

throttle - The throttle

getLastUsedSaveFile

public String getLastUsedSaveFile()

setLastUsedSaveFile

public void setLastUsedSaveFile(String lusf)