Package jmri.jmrit.display.layoutEditor.configurexml

Class LayoutBlockManagerXml

java.lang.Object

jmri.configurexml.AbstractXmlAdapter

jmri.managers.configurexml.AbstractNamedBeanManagerConfigXML

jmri.jmrit.display.layoutEditor.configurexml.LayoutBlockManagerXml

All Implemented Interfaces:

XmlAdapter

public class LayoutBlockManagerXml
extends AbstractNamedBeanManagerConfigXML

Provides the functionality for configuring a LayoutBlockManager

Nested Class Summary

Nested classes/interfaces inherited from class jmri.configurexml.AbstractXmlAdapter

AbstractXmlAdapter.EnumIO<T extends java.lang.Enum<T>>, AbstractXmlAdapter.EnumIoMapped<T extends java.lang.Enum<T>>, AbstractXmlAdapter.EnumIoNames<T extends java.lang.Enum<T>>, AbstractXmlAdapter.EnumIoNamesNumbers<T extends java.lang.Enum<T>>, AbstractXmlAdapter.EnumIoOrdinals<T extends java.lang.Enum<T>>

Field Summary

Fields inherited from class jmri.configurexml.AbstractXmlAdapter

STR_FALSE, STR_NO, STR_TRUE, STR_YES

Constructor Summary

Constructors

Constructor	Description
LayoutBlockManagerXml()

Method Summary

Modifier and Type	Method	Description
void	load(org.jdom2.Element element, java.lang.Object o)	Create a set of configured objects from their XML description, using an auxiliary object.
boolean	load(org.jdom2.Element shared, org.jdom2.Element perNode)	Create a set of configured objects from their XML description.
void	loadLayoutBlocks(org.jdom2.Element layoutblocks)	Utility method to load the individual LayoutBlock objects.
protected void	replaceLayoutBlockManager()	Replace the current LayoutBlockManager, if there is one, with one newly created during a load operation.
void	setStoreElementClass(org.jdom2.Element layoutblocks)	Subclass provides implementation to create the correct top element, including the type information.
org.jdom2.Element	store(java.lang.Object o)	Implementation for storing the contents of a LayoutBlockManager

Methods inherited from class jmri.managers.configurexml.AbstractNamedBeanManagerConfigXML

checkedNamedBeanHandle, checkedNamedBeanName, checkedNamedBeanReference, getSystemName, getUserName, getUserName, loadCommon, storeCommon

Methods inherited from class jmri.configurexml.AbstractXmlAdapter

getAttributeBooleanValue, getAttributeDoubleValue, getAttributeFloatValue, getAttributeIntegerValue, getExceptionHandler, handleException, load, load, loadDeferred, loadOrder, setExceptionHandler, store

Methods inherited from class java.lang.Object

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

Constructor Detail

LayoutBlockManagerXml

public LayoutBlockManagerXml()

Method Detail

store

public org.jdom2.Element store(java.lang.Object o)

Implementation for storing the contents of a LayoutBlockManager

Parameters:

o - Object to store, of type LayoutBlockManager

Returns:

Element containing the complete info

setStoreElementClass

public void setStoreElementClass(org.jdom2.Element layoutblocks)

Subclass provides implementation to create the correct top element, including the type information. Default implementation is to use the local class here.

Parameters:

layoutblocks - The top-level element being created

load

public void load(org.jdom2.Element element,
                 java.lang.Object o)

Description copied from class: AbstractXmlAdapter

Create a set of configured objects from their XML description, using an auxiliary object.

For example, the auxilary object o might be a manager or GUI of some type that needs to be informed as each object is created.

Specified by:

load in interface XmlAdapter

Overrides:

load in class AbstractXmlAdapter

Parameters:

element - Top-level XML element containing the description

o - Implementation-specific Object needed for the conversion

load

public boolean load(org.jdom2.Element shared,
                    org.jdom2.Element perNode)

Description copied from class: AbstractXmlAdapter

Create a set of configured objects from their XML description.

Specified by:

load in interface XmlAdapter

Overrides:

load in class AbstractXmlAdapter

Parameters:

shared - Top-level XML element containing the common, multi-node elements of the description

perNode - Top-level XML element containing the private, single-node elements of the description

Returns:

true if successful

loadLayoutBlocks

public void loadLayoutBlocks(org.jdom2.Element layoutblocks)

Utility method to load the individual LayoutBlock objects. If there's no additional info needed for a specific layoutblock type, invoke this with the parent of the set of layoutblock elements.

Parameters:

layoutblocks - Element containing the layoutblock elements to load.

replaceLayoutBlockManager

protected void replaceLayoutBlockManager()

Replace the current LayoutBlockManager, if there is one, with one newly created during a load operation. This is skipped if they are of the same absolute type.