A B C D E F G H I L M N O P R S T U V W

A

addContextExtensions(DocumentModel, DocumentWrapper, Map<String, Object>) - Method in interface org.nuxeo.template.api.TemplateProcessorService

addInput(TemplateInput) - Method in interface org.nuxeo.template.api.adapters.TemplateSourceDocument

Add or update a TemplateInput to the list of template parameters.

aliasNames - Variable in class org.nuxeo.template.api.descriptor.ContextExtensionFactoryDescriptor

allowInstanceOverride() - Method in interface org.nuxeo.template.api.adapters.TemplateSourceDocument

Return flag to indicate if Documents associated to this template can override parametes value

autoLoop - Variable in class org.nuxeo.template.api.TemplateInput

B

booleanValue - Variable in class org.nuxeo.template.api.TemplateInput

C

chainId - Variable in class org.nuxeo.template.api.descriptor.OutputFormatDescriptor

className - Variable in class org.nuxeo.template.api.descriptor.TemplateProcessorDescriptor

clone() - Method in class org.nuxeo.template.api.descriptor.ContextExtensionFactoryDescriptor

clone() - Method in class org.nuxeo.template.api.descriptor.OutputFormatDescriptor

clone() - Method in class org.nuxeo.template.api.descriptor.TemplateProcessorDescriptor

ContentInputType - Enum in org.nuxeo.template.api

Enum for types on Content associated to a TemplateInput

ContextExtensionFactory - Interface in org.nuxeo.template.api.context

Factory used to register new Context Extensions The resturned Object will be directly accessible inside the Rendering context

ContextExtensionFactoryDescriptor - Class in org.nuxeo.template.api.descriptor

ContextExtensionFactoryDescriptor() - Constructor for class org.nuxeo.template.api.descriptor.ContextExtensionFactoryDescriptor

D

dateValue - Variable in class org.nuxeo.template.api.TemplateInput

defaultProcessor - Variable in class org.nuxeo.template.api.descriptor.TemplateProcessorDescriptor

desciption - Variable in class org.nuxeo.template.api.TemplateInput

detachTemplateBasedDocument(DocumentModel, String, boolean) - Method in interface org.nuxeo.template.api.TemplateProcessorService

Detach a Template from a DocumentModel

DocumentWrapper - Interface in org.nuxeo.template.api.context

Wrapper interface used to wrap the Object that will be put inside the rendering context.

E

enabled - Variable in class org.nuxeo.template.api.descriptor.ContextExtensionFactoryDescriptor

enabled - Variable in class org.nuxeo.template.api.descriptor.OutputFormatDescriptor

enabled - Variable in class org.nuxeo.template.api.descriptor.TemplateProcessorDescriptor

F

factory - Variable in class org.nuxeo.template.api.descriptor.ContextExtensionFactoryDescriptor

factoryClass - Variable in class org.nuxeo.template.api.descriptor.ContextExtensionFactoryDescriptor

findProcessor(Blob) - Method in interface org.nuxeo.template.api.TemplateProcessorService

Finds the TemplateProcessor for a given Blob.

findProcessorName(Blob) - Method in interface org.nuxeo.template.api.TemplateProcessorService

Finds the template processor name for a given Blob.

G

getAdaptedDoc() - Method in interface org.nuxeo.template.api.adapters.TemplateBasedDocument

Return the underlying adapted DocumentModel

getAdaptedDoc() - Method in interface org.nuxeo.template.api.adapters.TemplateSourceDocument

Return the underlying adapted DocumentModels

getAliases() - Method in class org.nuxeo.template.api.descriptor.ContextExtensionFactoryDescriptor

getApplicableTypes() - Method in interface org.nuxeo.template.api.adapters.TemplateSourceDocument

Get List of Document Types than can be associated to this Template.

getAvailableOfficeTemplates(CoreSession, String) - Method in interface org.nuxeo.template.api.TemplateProcessorService

Retrieve the TemplateSourceDocument that can be used as an Office template (i.e that support to store the template file as main blob of target DocumentModel)

getAvailableTemplateDocs(CoreSession, String) - Method in interface org.nuxeo.template.api.TemplateProcessorService

Find TemplateSourceDocuments that can be bound to a given doc type.

getAvailableTemplates(CoreSession, String) - Method in interface org.nuxeo.template.api.TemplateProcessorService

Find TemplateSourceDocuments that can be bound to a given doc type.

getBooleanValue() - Method in class org.nuxeo.template.api.TemplateInput

getByValue(String) - Static method in enum org.nuxeo.template.api.ContentInputType

getByValue(String) - Static method in enum org.nuxeo.template.api.InputType

getChainId() - Method in class org.nuxeo.template.api.descriptor.OutputFormatDescriptor

getClassName() - Method in class org.nuxeo.template.api.descriptor.TemplateProcessorDescriptor

getCopy(boolean) - Method in class org.nuxeo.template.api.TemplateInput

getDateValue() - Method in class org.nuxeo.template.api.TemplateInput

getDesciption() - Method in class org.nuxeo.template.api.TemplateInput

getExtension(DocumentModel, DocumentWrapper, Map<String, Object>) - Method in interface org.nuxeo.template.api.context.ContextExtensionFactory

Called before redering to let you add objects inside the rendering context.

getExtensionFactory() - Method in class org.nuxeo.template.api.descriptor.ContextExtensionFactoryDescriptor

getFileName() - Method in interface org.nuxeo.template.api.adapters.TemplateSourceDocument

Shortcut to access the underlying Blob filename

getForcedTypes() - Method in interface org.nuxeo.template.api.adapters.TemplateSourceDocument

Get List of Document Types that must be automatically bound to this template at creation time

getId() - Method in interface org.nuxeo.template.api.adapters.TemplateSourceDocument

Shortcut to access the underlying DocumentModel uuid

getId() - Method in class org.nuxeo.template.api.descriptor.OutputFormatDescriptor

getInitialParametersDefinition(Blob) - Method in interface org.nuxeo.template.api.TemplateProcessor

Extract parameters from the Template file.

getLabel() - Method in interface org.nuxeo.template.api.adapters.TemplateSourceDocument

Return label key used for template

getLabel() - Method in class org.nuxeo.template.api.descriptor.OutputFormatDescriptor

getLabel() - Method in class org.nuxeo.template.api.descriptor.TemplateProcessorDescriptor

getLinkedTemplateBasedDocuments(DocumentModel) - Method in interface org.nuxeo.template.api.TemplateProcessorService

Retrieve the DocumentModels using a given TemplateSourceDocument

getMimeType() - Method in class org.nuxeo.template.api.descriptor.OutputFormatDescriptor

getName() - Method in interface org.nuxeo.template.api.adapters.TemplateSourceDocument

Shortcut to access the underlying DocumentModel name

getName() - Method in class org.nuxeo.template.api.descriptor.ContextExtensionFactoryDescriptor

getName() - Method in class org.nuxeo.template.api.descriptor.TemplateProcessorDescriptor

getName() - Method in class org.nuxeo.template.api.TemplateInput

getOutputFormat() - Method in interface org.nuxeo.template.api.adapters.TemplateSourceDocument

Return the expected mime-type of the resulting rendering

getOutputFormatDescriptor(String) - Method in interface org.nuxeo.template.api.TemplateProcessorService

The returned OutputFormatDescriptor contains either an operation chain or a mime-type use to convert the output of a rendered document.

getOutputFormats() - Method in interface org.nuxeo.template.api.TemplateProcessorService

getParams(String) - Method in interface org.nuxeo.template.api.adapters.TemplateBasedDocument

Retrieve parameters for the associated template

getParams() - Method in interface org.nuxeo.template.api.adapters.TemplateSourceDocument

Retrieve the parameters associated to the Template file

getParamsAsString() - Method in interface org.nuxeo.template.api.adapters.TemplateSourceDocument

Return the String representation of the parameters of the template

getProcessor() - Method in class org.nuxeo.template.api.descriptor.TemplateProcessorDescriptor

getProcessor(String) - Method in interface org.nuxeo.template.api.TemplateProcessorService

Get a TemplateProcessor by it's name.

getRegisteredTemplateProcessors() - Method in interface org.nuxeo.template.api.TemplateProcessorService

Returns all registered TemplateProcessors

getRegistredContextExtensions() - Method in interface org.nuxeo.template.api.TemplateProcessorService

getReservedContextKeywords() - Method in interface org.nuxeo.template.api.TemplateProcessorService

getSource() - Method in class org.nuxeo.template.api.TemplateInput

getSourceTemplate(String) - Method in interface org.nuxeo.template.api.adapters.TemplateBasedDocument

Retrieve the TemplateSourceDocument for a given template name

getSourceTemplateDoc(String) - Method in interface org.nuxeo.template.api.adapters.TemplateBasedDocument

Retrieve the Template DocumentModel for a given template name

getSourceTemplateDocRef(String) - Method in interface org.nuxeo.template.api.adapters.TemplateBasedDocument

Retrieve the Template DocumentRef for a given template name

getSourceTemplates() - Method in interface org.nuxeo.template.api.adapters.TemplateBasedDocument

List all TemplateSourceDocuments that are bound to the underlying DocumentModel

getStringValue() - Method in class org.nuxeo.template.api.TemplateInput

getSupportedExtensions() - Method in class org.nuxeo.template.api.descriptor.TemplateProcessorDescriptor

getSupportedMimeTypes() - Method in class org.nuxeo.template.api.descriptor.TemplateProcessorDescriptor

getTargetRenditionName() - Method in interface org.nuxeo.template.api.adapters.TemplateSourceDocument

Get the associated Rendition if any

getTemplateBasedDocuments() - Method in interface org.nuxeo.template.api.adapters.TemplateSourceDocument

Get the list of TemplateBasedDocuments associated to this template

getTemplateBlob(String) - Method in interface org.nuxeo.template.api.adapters.TemplateBasedDocument

Return the Blob of the associated template

getTemplateBlob() - Method in interface org.nuxeo.template.api.adapters.TemplateSourceDocument

Retrieve the Blob holding the template file

getTemplateNameForRendition(String) - Method in interface org.nuxeo.template.api.adapters.TemplateBasedDocument

Find the template associated to a given RenditionName

getTemplateNames() - Method in interface org.nuxeo.template.api.adapters.TemplateBasedDocument

Get the names of all the associated templates

getTemplateType(String) - Method in interface org.nuxeo.template.api.adapters.TemplateBasedDocument

Return the template type for a given template name

getTemplateType() - Method in interface org.nuxeo.template.api.adapters.TemplateSourceDocument

Return the template Type (i.e. the associated TemplateProcessor name.

getTitle() - Method in interface org.nuxeo.template.api.adapters.TemplateSourceDocument

Shortcut to access the underlying DocumentModel title

getType() - Method in class org.nuxeo.template.api.TemplateInput

getTypeAsString() - Method in class org.nuxeo.template.api.TemplateInput

getTypeMapping() - Method in interface org.nuxeo.template.api.TemplateProcessorService

Retrieve the Map used for mapping Document Types to Template Names.

getValue() - Method in enum org.nuxeo.template.api.ContentInputType

getValue() - Method in enum org.nuxeo.template.api.InputType

getVersionLabel() - Method in interface org.nuxeo.template.api.adapters.TemplateSourceDocument

Shortcut to access the underlying DocumentModel versionLabel

H

hasEditableParams(String) - Method in interface org.nuxeo.template.api.adapters.TemplateBasedDocument

Indicate of the associated Template has editable parameters or not

hasEditableParams() - Method in interface org.nuxeo.template.api.adapters.TemplateSourceDocument

Indicate of the associated Template has editable parameters or not

hasParams(String) - Method in interface org.nuxeo.template.api.adapters.TemplateBasedDocument

Indicate of the associated Template requires parameters or not

I

id - Variable in class org.nuxeo.template.api.descriptor.OutputFormatDescriptor

init() - Method in class org.nuxeo.template.api.descriptor.TemplateProcessorDescriptor

INIT_DONE_FLAG - Static variable in interface org.nuxeo.template.api.adapters.TemplateSourceDocument

initializeFromTemplate(String, boolean) - Method in interface org.nuxeo.template.api.adapters.TemplateBasedDocument

Initialize the template parameters from the associated template

initTemplate(boolean) - Method in interface org.nuxeo.template.api.adapters.TemplateSourceDocument

Initialize the DocumentModel finds associated TemplateProcessor extract Template parameters

initTypesBindings() - Method in interface org.nuxeo.template.api.adapters.TemplateSourceDocument

Initialize the Types2Template binding

InputType - Enum in org.nuxeo.template.api

Enum for types of TemplateInput

isAutoLoop() - Method in class org.nuxeo.template.api.TemplateInput

isDefaultProcessor() - Method in class org.nuxeo.template.api.descriptor.TemplateProcessorDescriptor

isEnabled() - Method in class org.nuxeo.template.api.descriptor.ContextExtensionFactoryDescriptor

isEnabled() - Method in class org.nuxeo.template.api.descriptor.OutputFormatDescriptor

isEnabled() - Method in class org.nuxeo.template.api.descriptor.TemplateProcessorDescriptor

isReadOnly() - Method in class org.nuxeo.template.api.TemplateInput

isSet() - Method in class org.nuxeo.template.api.TemplateInput

isSimpleValue() - Method in class org.nuxeo.template.api.TemplateInput

isSourceValue() - Method in class org.nuxeo.template.api.TemplateInput

L

label - Variable in class org.nuxeo.template.api.descriptor.OutputFormatDescriptor

label - Variable in class org.nuxeo.template.api.descriptor.TemplateProcessorDescriptor

log - Static variable in class org.nuxeo.template.api.descriptor.ContextExtensionFactoryDescriptor

log - Static variable in class org.nuxeo.template.api.descriptor.OutputFormatDescriptor

log - Static variable in class org.nuxeo.template.api.descriptor.TemplateProcessorDescriptor

M

makeTemplateBasedDocument(DocumentModel, DocumentModel, boolean) - Method in interface org.nuxeo.template.api.TemplateProcessorService

Associate a DocumentModel to a TemplateSourceDocument.

merge(ContextExtensionFactoryDescriptor) - Method in class org.nuxeo.template.api.descriptor.ContextExtensionFactoryDescriptor

merge(OutputFormatDescriptor) - Method in class org.nuxeo.template.api.descriptor.OutputFormatDescriptor

merge(TemplateProcessorDescriptor) - Method in class org.nuxeo.template.api.descriptor.TemplateProcessorDescriptor

mimeType - Variable in class org.nuxeo.template.api.descriptor.OutputFormatDescriptor

N

name - Variable in class org.nuxeo.template.api.descriptor.ContextExtensionFactoryDescriptor

name - Variable in class org.nuxeo.template.api.descriptor.TemplateProcessorDescriptor

name - Variable in class org.nuxeo.template.api.TemplateInput

O

org.nuxeo.template.api - package org.nuxeo.template.api

org.nuxeo.template.api.adapters - package org.nuxeo.template.api.adapters

org.nuxeo.template.api.context - package org.nuxeo.template.api.context

org.nuxeo.template.api.descriptor - package org.nuxeo.template.api.descriptor

OutputFormatDescriptor - Class in org.nuxeo.template.api.descriptor

OutputFormatDescriptor() - Constructor for class org.nuxeo.template.api.descriptor.OutputFormatDescriptor

P

processor - Variable in class org.nuxeo.template.api.descriptor.TemplateProcessorDescriptor

R

readOnly - Variable in class org.nuxeo.template.api.TemplateInput

registerTypeMapping(DocumentModel) - Method in interface org.nuxeo.template.api.TemplateProcessorService

Update Type2Template Mapping from the data contained in the source DocumentModel.

removeForcedType(String, boolean) - Method in interface org.nuxeo.template.api.adapters.TemplateSourceDocument

Remove Type mapping for this template

removeTemplateBinding(String, boolean) - Method in interface org.nuxeo.template.api.adapters.TemplateBasedDocument

Detach a template from the underlying DocumentModel

renderAndStoreAsAttachment(String, boolean) - Method in interface org.nuxeo.template.api.adapters.TemplateBasedDocument

Render the named template against the underlying DocumentModel and store the result in the main Blob

renderTemplate(TemplateBasedDocument, String) - Method in interface org.nuxeo.template.api.TemplateProcessor

Perform rendering of the named template against the TemplateBasedDocument

renderWithTemplate(String) - Method in interface org.nuxeo.template.api.adapters.TemplateBasedDocument

Render the named template against the underlying DocumentModel

S

save() - Method in interface org.nuxeo.template.api.adapters.TemplateSourceDocument

Save changes in the underlying DocumentModel

saveParams(String, List<TemplateInput>, boolean) - Method in interface org.nuxeo.template.api.adapters.TemplateBasedDocument

Save parameters changes.

saveParams(List<TemplateInput>, boolean) - Method in interface org.nuxeo.template.api.adapters.TemplateSourceDocument

Save parameters changes

setAutoLoop(boolean) - Method in class org.nuxeo.template.api.TemplateInput

setBooleanValue(Boolean) - Method in class org.nuxeo.template.api.TemplateInput

setDateValue(Date) - Method in class org.nuxeo.template.api.TemplateInput

setDesciption(String) - Method in class org.nuxeo.template.api.TemplateInput

setForcedTypes(String[], boolean) - Method in interface org.nuxeo.template.api.adapters.TemplateSourceDocument

Update the Type mapping for this template

setName(String) - Method in class org.nuxeo.template.api.TemplateInput

setOutputFormat(String, boolean) - Method in interface org.nuxeo.template.api.adapters.TemplateSourceDocument

Sets the expected output mime-type.

setReadOnly(boolean) - Method in class org.nuxeo.template.api.TemplateInput

setSource(String) - Method in class org.nuxeo.template.api.TemplateInput

setStringValue(String) - Method in class org.nuxeo.template.api.TemplateInput

setTargetRenditioName(String, boolean) - Method in interface org.nuxeo.template.api.adapters.TemplateSourceDocument

Associate Template to a Rendition

setTemplate(DocumentModel, boolean) - Method in interface org.nuxeo.template.api.adapters.TemplateBasedDocument

Associate the document to a Template.

setTemplateBlob(Blob, boolean) - Method in interface org.nuxeo.template.api.adapters.TemplateSourceDocument

Write accessor to the Blob used to store the template

setType(InputType) - Method in class org.nuxeo.template.api.TemplateInput

setTypeAsString(String) - Method in class org.nuxeo.template.api.TemplateInput

source - Variable in class org.nuxeo.template.api.TemplateInput

stringValue - Variable in class org.nuxeo.template.api.TemplateInput

supportedExtensions - Variable in class org.nuxeo.template.api.descriptor.TemplateProcessorDescriptor

supportedMimeTypes - Variable in class org.nuxeo.template.api.descriptor.TemplateProcessorDescriptor

T

TemplateBasedDocument - Interface in org.nuxeo.template.api.adapters

Adapter interface for the DocumentModel that support rendering via a Template.

TemplateInput - Class in org.nuxeo.template.api

Represents input parameters of a Template.

TemplateInput(String) - Constructor for class org.nuxeo.template.api.TemplateInput

TemplateInput(String, Object) - Constructor for class org.nuxeo.template.api.TemplateInput

TemplateProcessor - Interface in org.nuxeo.template.api

Interface used to drive rendition of the TemplateBasedDocument

TemplateProcessorDescriptor - Class in org.nuxeo.template.api.descriptor

TemplateProcessorDescriptor() - Constructor for class org.nuxeo.template.api.descriptor.TemplateProcessorDescriptor

TemplateProcessorService - Interface in org.nuxeo.template.api

This is the service interface to manage TemplateProcessor and associated templates.

TemplateSourceDocument - Interface in org.nuxeo.template.api.adapters

It is mainly the source used by TemplateBasedDocument to handle the rendering.

toString() - Method in enum org.nuxeo.template.api.ContentInputType

toString() - Method in enum org.nuxeo.template.api.InputType

toString() - Method in class org.nuxeo.template.api.TemplateInput

type - Variable in class org.nuxeo.template.api.TemplateInput

U

update(TemplateInput) - Method in class org.nuxeo.template.api.TemplateInput

useAsMainContent() - Method in interface org.nuxeo.template.api.adapters.TemplateSourceDocument

Indicate if the template can be used as main blob in the TemplateBasedDocument (i.e. if the template is editable by the end user)

V

valueOf(String) - Static method in enum org.nuxeo.template.api.ContentInputType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.nuxeo.template.api.InputType

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.nuxeo.template.api.ContentInputType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.nuxeo.template.api.InputType

Returns an array containing the constants of this enum type, in the order they are declared.

W

wrap(DocumentModel) - Method in interface org.nuxeo.template.api.context.DocumentWrapper

wrap(List<LogEntry>) - Method in interface org.nuxeo.template.api.context.DocumentWrapper

A B C D E F G H I L M N O P R S T U V W