com.inductiveautomation.factorypmi.designer.model

Class TemplateIEHandler

java.lang.Object

com.inductiveautomation.factorypmi.designer.model.TemplateIEHandler

All Implemented Interfaces:

ImportExportHandler<java.lang.String>

public class TemplateIEHandler
extends java.lang.Object
implements ImportExportHandler<java.lang.String>

Import/Export handler for Vision templates.

Constructor Summary

Constructors

Constructor and Description
TemplateIEHandler(VisionDesignerImpl vision)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getExtension() The file extension, like "txt" or "pkg"
java.lang.String	getFileDescription() A resource key for the description for the filetype, like "Exported Windows"
java.lang.String	getFileSelectionInstructions() A resource key for the instructions for the file selection stage.
java.lang.String	getItemName() A resource key for a plural noun like "Windows" that describes the object to be exported.
java.lang.String	getObjectSelectionInstructions() A resource key for the instructions for the object selection stage.
java.lang.String	getObjectSelectionWarning() A resource key for a warning to be displayed during the object selection stage.
void	onBeforeImport(XMLDeserializer deserializer) Called before deserialization starts.
boolean	onExport(XMLSerializer serializer, java.util.List<java.lang.String> objects) Called after the selection of what to export has been made.
void	onImportDone(DeserializationContext context) Called after an imported file has been deserialized

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateIEHandler

public TemplateIEHandler(VisionDesignerImpl vision)

Method Detail

getExtension

public java.lang.String getExtension()

Description copied from interface: ImportExportHandler

The file extension, like "txt" or "pkg"

Specified by:

getExtension in interface ImportExportHandler<java.lang.String>

getFileDescription

public java.lang.String getFileDescription()

Description copied from interface: ImportExportHandler

A resource key for the description for the filetype, like "Exported Windows"

Specified by:

getFileDescription in interface ImportExportHandler<java.lang.String>

getFileSelectionInstructions

public java.lang.String getFileSelectionInstructions()

Description copied from interface: ImportExportHandler

A resource key for the instructions for the file selection stage. Optional.

Specified by:

getFileSelectionInstructions in interface ImportExportHandler<java.lang.String>

getItemName

public java.lang.String getItemName()

Description copied from interface: ImportExportHandler

A resource key for a plural noun like "Windows" that describes the object to be exported. Will be used to generate instructions if they are omitted.

Specified by:

getItemName in interface ImportExportHandler<java.lang.String>

getObjectSelectionInstructions

public java.lang.String getObjectSelectionInstructions()

Description copied from interface: ImportExportHandler

A resource key for the instructions for the object selection stage. Optional.

Specified by:

getObjectSelectionInstructions in interface ImportExportHandler<java.lang.String>

getObjectSelectionWarning

public java.lang.String getObjectSelectionWarning()

Description copied from interface: ImportExportHandler

A resource key for a warning to be displayed during the object selection stage. Optional.

Specified by:

getObjectSelectionWarning in interface ImportExportHandler<java.lang.String>

onExport

public boolean onExport(XMLSerializer serializer,
                        java.util.List<java.lang.String> objects)

Description copied from interface: ImportExportHandler

Called after the selection of what to export has been made. This function is responsible for actually adding the selected objects to the serializer.

Specified by:

onExport in interface ImportExportHandler<java.lang.String>

Parameters:

serializer - The XMLSerializer that will be used to serialize the objects.

objects - The objects that have been selected for export.

Returns:

true if the export should continue, false if it should be aborted.

onBeforeImport

public void onBeforeImport(XMLDeserializer deserializer)

Description copied from interface: ImportExportHandler

Called before deserialization starts.

Specified by:

onBeforeImport in interface ImportExportHandler<java.lang.String>

onImportDone

public void onImportDone(DeserializationContext context)

Description copied from interface: ImportExportHandler

Called after an imported file has been deserialized

Specified by:

onImportDone in interface ImportExportHandler<java.lang.String>