Package ro.sync.template

Interface EditorTemplateWithContent

All Superinterfaces:

java.lang.Cloneable, EditorTemplate, PersistentObject, java.io.Serializable

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public interface EditorTemplateWithContent
extends EditorTemplate

Editor template with predefined string content.

Field Summary

Fields inherited from interface ro.sync.exml.editor.EditorTemplate

ARCHIVE_TEMPLATE, EDITOR_TEMPLATE, FILE_TEMPLATE, PROJECT_ARCHIVE_TEMPLATE

Method Summary

Modifier and Type	Method	Description
TemplateContentInfo	getContentInfo(java.lang.String saveLocation)	Gets the template content.
TemplateContentInfo	getContentInfo(java.lang.String saveLocation, boolean interactive)	Returns the template content with editor variables expanded.
TemplateContentInfo	getContentInfo(java.lang.String saveLocation, boolean expandEditorVariables, boolean interactive)	Returns the template content with editor variables expanded.

Methods inherited from interface ro.sync.exml.editor.EditorTemplate

clone, getAdditionalInformation, getCaretPosition, getCustomizePageID, getDescription, getExtension, getFilenamePrefix, getFilenameSuffix, getLongDescription, getName, getSource, getTemplateType, getTypeProperty, isCustomizable

Methods inherited from interface ro.sync.options.PersistentObject

checkValid, getNotPersistentFieldNames

Method Detail

getContentInfo

TemplateContentInfo getContentInfo(java.lang.String saveLocation)
                            throws java.io.IOException,
                                   ro.sync.exml.editor.xmleditor.transform.CancelledException

Gets the template content.

Parameters:

saveLocation - The location where the new template will be saved.

Returns:

The template content. It can be null.

Throws:

java.io.IOException

ro.sync.exml.editor.xmleditor.transform.CancelledException

getContentInfo

TemplateContentInfo getContentInfo(java.lang.String saveLocation,
                                   boolean interactive)
                            throws java.io.IOException,
                                   ro.sync.exml.editor.xmleditor.transform.CancelledException

Returns the template content with editor variables expanded.

Parameters:

saveLocation - The location where the content will be saved.

interactive - true if we should expand interactive editor variables.

Returns:

The expanded content.

Throws:

java.io.IOException

ro.sync.exml.editor.xmleditor.transform.CancelledException

getContentInfo

TemplateContentInfo getContentInfo(java.lang.String saveLocation,
                                   boolean expandEditorVariables,
                                   boolean interactive)
                            throws java.io.IOException,
                                   ro.sync.exml.editor.xmleditor.transform.CancelledException

Returns the template content with editor variables expanded.

Parameters:

saveLocation - The location where the content will be saved.

expandEditorVariables - true to expand editor variables.

interactive - true if we should expand interactive editor variables.

Returns:

The expanded content.

Throws:

java.io.IOException

ro.sync.exml.editor.xmleditor.transform.CancelledException