Package com._1c.g5.v8.dt.form.generator

Interface IFormGenerator

public interface IFormGenerator

Main interface for form generator

Method Summary

Modifier and Type	Method	Description
Map<org.eclipse.core.runtime.IPath,Supplier<InputStream>>	generateAttachments(FormType formType, ScriptVariant scriptVariant, String editingLanguageCode, Version version)	Generate attachments for form with specified parameters.
Form	generateForm(MdObject mdObject, BasicForm basicForm, FormType formType, ScriptVariant scriptVariant, String languageCode, Version version, FormFieldInfo rootField, Integer columnCount)	Generate form by type
Supplier<InputStream>	generateModuleContent(FormType formType, ScriptVariant scriptVariant, String languageCode, Version version)	Deprecated. Use five-argument counterpart.
Supplier<InputStream>	generateModuleContent(FormType formType, ScriptVariant scriptVariant, String languageCode, Version version, String lineDelimiter)	Generate module content for form with specified parameters.

Method Detail

generateForm

Form generateForm(MdObject mdObject,
                  BasicForm basicForm,
                  FormType formType,
                  ScriptVariant scriptVariant,
                  String languageCode,
                  Version version,
                  FormFieldInfo rootField,
                  Integer columnCount)

Generate form by type

Parameters:

mdObject - form parent object, must contains in configuration hierarchy, cannot be null

basicForm - form metadata object, must contains in given mdObject, cannot by null

formType - FormType, cannot be null

scriptVariant - the current configuration script variant, cannot be null

languageCode - the current editing language code, cannot be null

version - the runtime version, cannot be null

rootField - FormFieldInfo taken form IFormFieldGenerator.getFormGeneratorFields(com._1c.g5.v8.dt.metadata.mdclass.MdObject, com._1c.g5.v8.dt.form.generator.FormType, com._1c.g5.v8.dt.metadata.mdclass.ScriptVariant, com._1c.g5.v8.dt.platform.version.Version), cannot be null

columnCount - number of column count. need for CONSTANT, OBJECT, GROUP, RECORD form types, can be null

Returns:

generated Form, never null

generateModuleContent

@Deprecated
Supplier<InputStream> generateModuleContent(FormType formType,
                                            ScriptVariant scriptVariant,
                                            String languageCode,
                                            Version version)

Deprecated.

Use five-argument counterpart.

Generate module content for form with specified parameters. In contrast to its five-argument counterpart this method uses system line delimiter.

Each time supplier invoked will be generate new instance of InputStream. And each time it must be closed.

Parameters:

formType - FormType, cannot be null

scriptVariant - the current configuration script variant, cannot be null

languageCode - the current editing language code, cannot be null

version - the runtime version, cannot be null

Returns:

supplier of InputStream of module content, can be null if form with specified parameters has no module

generateModuleContent

Supplier<InputStream> generateModuleContent(FormType formType,
                                            ScriptVariant scriptVariant,
                                            String languageCode,
                                            Version version,
                                            String lineDelimiter)

Generate module content for form with specified parameters.

Each time supplier invoked will be generate new instance of InputStream. And each time it must be closed.

Parameters:

formType - FormType, cannot be null

scriptVariant - the current configuration script variant, cannot be null

languageCode - the current editing language code, cannot be null

version - the runtime version, cannot be null

lineDelimiter - the line delimiter to use, cannot be null

Returns:

supplier of InputStream of module content, can be null if form with specified parameters has no module

generateAttachments

Map<org.eclipse.core.runtime.IPath,Supplier<InputStream>> generateAttachments(FormType formType,
                                                                                    ScriptVariant scriptVariant,
                                                                                    String editingLanguageCode,
                                                                                    Version version)

Generate attachments for form with specified parameters. In the form of pairs of relative paths and InputStream content suppliers

Each time supplier invoked will be generate new instance of InputStream. And each time it must be closed.

Parameters:

formType - FormType, cannot be null

scriptVariant - the current configuration script variant, cannot be null

languageCode - the current editing language code, cannot be null

version - the runtime version, cannot be null

Returns:

map of attachments, never null, may be empty