@ngx-i18nsupport/ngx-i18nsupport-lib/esm2015/api/i-trans-unit.js

A Typescript library to work with Angular generated i18n files (xliff, xmb)

/**
 * @fileoverview added by tsickle
 * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
 */
/**
 * Interface of a translation unit in a translation messages file.
 * @record
 */
export function ITransUnit() { }
if (false) {
    /** @type {?} */
    ITransUnit.prototype.id;
    /**
     * The file the unit belongs to.,
     * @return {?}
     */
    ITransUnit.prototype.translationMessagesFile = function () { };
    /**
     * The original text value, that is to be translated.
     * Contains all markup, depends on the concrete format used.
     * @return {?}
     */
    ITransUnit.prototype.sourceContent = function () { };
    /**
     * Test, wether setting of source content is supported.
     * If not, setSourceContent in trans-unit will do nothing.
     * xtb does not support this, all other formats do.
     * @return {?}
     */
    ITransUnit.prototype.supportsSetSourceContent = function () { };
    /**
     * Set new source content in the transunit.
     * Normally, this is done by ng-extract.
     * Method only exists to allow xliffmerge to merge missing changed source content.
     * @param {?} newContent the new content.
     * @return {?}
     */
    ITransUnit.prototype.setSourceContent = function (newContent) { };
    /**
     * The original text value, that is to be translated, as normalized message.
     * Throws an error if normalized xml is not well formed.
     * (which should not happen in generated files)
     * @return {?}
     */
    ITransUnit.prototype.sourceContentNormalized = function () { };
    /**
     * The translated value.
     * Contains all markup, depends on the concrete format used.
     * @return {?}
     */
    ITransUnit.prototype.targetContent = function () { };
    /**
     * The translated value as normalized message.
     * All placeholders are replaced with {{n}} (starting at 0)
     * and all embedded html is replaced by direct html markup.
     * Throws an error if normalized xml is not well formed.
     * (which should not happen in generated files)
     * @return {?}
     */
    ITransUnit.prototype.targetContentNormalized = function () { };
    /**
     * State of the translation.
     * (on of new, translated, final)
     * Return values are defined as Constants STATE_...
     * @return {?}
     */
    ITransUnit.prototype.targetState = function () { };
    /**
     * Modify the target state.
     * @param {?} newState one of the 3 allowed target states new, translated, final.
     * Constants STATE_...
     * Invalid states throw an error.
     * @return {?}
     */
    ITransUnit.prototype.setTargetState = function (newState) { };
    /**
     * All the source elements in the trans unit.
     * The source element is a reference to the original template.
     * It contains the name of the template file and a line number with the position inside the template.
     * It is just a help for translators to find the context for the translation.
     * This is set when using Angular 4.0 or greater.
     * Otherwise it just returns an empty array.
     * @return {?}
     */
    ITransUnit.prototype.sourceReferences = function () { };
    /**
     * Test, wether setting of source refs is supported.
     * If not, setSourceReferences will do nothing.
     * xtb does not support this, all other formats do.
     * @return {?}
     */
    ITransUnit.prototype.supportsSetSourceReferences = function () { };
    /**
     * Set source ref elements in the transunit.
     * Normally, this is done by ng-extract.
     * Method only exists to allow xliffmerge to merge missing source refs.
     * @param {?} sourceRefs the sourcerefs to set. Old ones are removed.
     * @return {?}
     */
    ITransUnit.prototype.setSourceReferences = function (sourceRefs) { };
    /**
     * The description set in the template as value of the i18n-attribute.
     * e.g. i18n="mydescription".
     * @return {?}
     */
    ITransUnit.prototype.description = function () { };
    /**
     * The meaning (intent) set in the template as value of the i18n-attribute.
     * This is the part in front of the | symbol.
     * e.g. i18n="meaning|mydescription".
     * @return {?}
     */
    ITransUnit.prototype.meaning = function () { };
    /**
     * Test, wether setting of description and meaning is supported.
     * If not, setDescription and setMeaning will do nothing.
     * xtb does not support this, all other formats do.
     * @return {?}
     */
    ITransUnit.prototype.supportsSetDescriptionAndMeaning = function () { };
    /**
     * Change description property of trans-unit.
     * @param {?} description description
     * @return {?}
     */
    ITransUnit.prototype.setDescription = function (description) { };
    /**
     * Change meaning property of trans-unit.
     * @param {?} meaning meaning
     * @return {?}
     */
    ITransUnit.prototype.setMeaning = function (meaning) { };
    /**
     * Get all notes of the trans-unit.
     * Notes are remarks made by a translator.
     * (description and meaning are not included here!)
     * @return {?}
     */
    ITransUnit.prototype.notes = function () { };
    /**
     * Test, wether setting of notes is supported.
     * If not, setNotes will do nothing.
     * xtb does not support this, all other formats do.
     * @return {?}
     */
    ITransUnit.prototype.supportsSetNotes = function () { };
    /**
     * Add notes to trans unit.
     * @throws an Error if any note contains description or meaning as from attribute.
     * @param {?} newNotes the notes to add.
     * @return {?}
     */
    ITransUnit.prototype.setNotes = function (newNotes) { };
    /**
     * Translate the trans unit.
     * @param {?} translation the translated string or (preferred) a normalized message.
     * The pure string can contain any markup and will not be checked.
     * So it can damage the document.
     * A normalized message prevents this.
     * @return {?}
     */
    ITransUnit.prototype.translate = function (translation) { };
}
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"i-trans-unit.js","sourceRoot":"ng://@ngx-i18nsupport/ngx-i18nsupport-lib/","sources":["api/i-trans-unit.ts"],"names":[],"mappings":";;;;;;;;AAWA,gCA0JC;;;IAxJG,wBAAoB;;;;;IAKpB,+DAAoD;;;;;;IAMpD,qDAAwB;;;;;;;IAOxB,gEAAoC;;;;;;;;IAQpC,kEAAqC;;;;;;;IAOrC,+DAA8C;;;;;;IAM9C,qDAAwB;;;;;;;;;IASxB,+DAA8C;;;;;;;IAO9C,mDAAsB;;;;;;;;IAQtB,8DAAiC;;;;;;;;;;IAUjC,wDAA+D;;;;;;;IAO/D,mEAAuC;;;;;;;;IAQvC,qEAA4E;;;;;;IAM5E,mDAAsB;;;;;;;IAOtB,+CAAkB;;;;;;;IAOlB,wEAA4C;;;;;;IAM5C,iEAAoC;;;;;;IAMpC,yDAA4B;;;;;;;IAO5B,6CAAiB;;;;;;;IAOjB,wDAA4B;;;;;;;IAO5B,wDAA4B;;;;;;;;;IAS5B,4DAAoD","sourcesContent":["import {INormalizedMessage} from './i-normalized-message';\r\nimport {ITranslationMessagesFile} from './i-translation-messages-file';\r\nimport {INote} from './i-note';\r\n\r\n/**\r\n * Created by martin on 19.03.2017.\r\n */\r\n\r\n/**\r\n * Interface of a translation unit in a translation messages file.\r\n */\r\nexport interface ITransUnit {\r\n\r\n    readonly id: string;\r\n\r\n    /**\r\n     * The file the unit belongs to.,\r\n     */\r\n    translationMessagesFile(): ITranslationMessagesFile;\r\n\r\n    /**\r\n     * The original text value, that is to be translated.\r\n     * Contains all markup, depends on the concrete format used.\r\n     */\r\n    sourceContent(): string;\r\n\r\n    /**\r\n     * Test, wether setting of source content is supported.\r\n     * If not, setSourceContent in trans-unit will do nothing.\r\n     * xtb does not support this, all other formats do.\r\n     */\r\n    supportsSetSourceContent(): boolean;\r\n\r\n    /**\r\n     * Set new source content in the transunit.\r\n     * Normally, this is done by ng-extract.\r\n     * Method only exists to allow xliffmerge to merge missing changed source content.\r\n     * @param newContent the new content.\r\n     */\r\n    setSourceContent(newContent: string);\r\n\r\n    /**\r\n     * The original text value, that is to be translated, as normalized message.\r\n     * Throws an error if normalized xml is not well formed.\r\n     * (which should not happen in generated files)\r\n     */\r\n    sourceContentNormalized(): INormalizedMessage;\r\n\r\n    /**\r\n     * The translated value.\r\n     * Contains all markup, depends on the concrete format used.\r\n     */\r\n    targetContent(): string;\r\n\r\n    /**\r\n     * The translated value as normalized message.\r\n     * All placeholders are replaced with {{n}} (starting at 0)\r\n     * and all embedded html is replaced by direct html markup.\r\n     * Throws an error if normalized xml is not well formed.\r\n     * (which should not happen in generated files)\r\n     */\r\n    targetContentNormalized(): INormalizedMessage;\r\n\r\n    /**\r\n     * State of the translation.\r\n     * (on of new, translated, final)\r\n     * Return values are defined as Constants STATE_...\r\n     */\r\n    targetState(): string;\r\n\r\n    /**\r\n     * Modify the target state.\r\n     * @param newState one of the 3 allowed target states new, translated, final.\r\n     * Constants STATE_...\r\n     * Invalid states throw an error.\r\n     */\r\n    setTargetState(newState: string);\r\n\r\n    /**\r\n     * All the source elements in the trans unit.\r\n     * The source element is a reference to the original template.\r\n     * It contains the name of the template file and a line number with the position inside the template.\r\n     * It is just a help for translators to find the context for the translation.\r\n     * This is set when using Angular 4.0 or greater.\r\n     * Otherwise it just returns an empty array.\r\n     */\r\n    sourceReferences(): {sourcefile: string, linenumber: number}[];\r\n\r\n    /**\r\n     * Test, wether setting of source refs is supported.\r\n     * If not, setSourceReferences will do nothing.\r\n     * xtb does not support this, all other formats do.\r\n     */\r\n    supportsSetSourceReferences(): boolean;\r\n\r\n    /**\r\n     * Set source ref elements in the transunit.\r\n     * Normally, this is done by ng-extract.\r\n     * Method only exists to allow xliffmerge to merge missing source refs.\r\n     * @param sourceRefs the sourcerefs to set. Old ones are removed.\r\n     */\r\n    setSourceReferences(sourceRefs: {sourcefile: string, linenumber: number}[]);\r\n\r\n    /**\r\n     * The description set in the template as value of the i18n-attribute.\r\n     * e.g. i18n=\"mydescription\".\r\n     */\r\n    description(): string;\r\n\r\n    /**\r\n     * The meaning (intent) set in the template as value of the i18n-attribute.\r\n     * This is the part in front of the | symbol.\r\n     * e.g. i18n=\"meaning|mydescription\".\r\n     */\r\n    meaning(): string;\r\n\r\n    /**\r\n     * Test, wether setting of description and meaning is supported.\r\n     * If not, setDescription and setMeaning will do nothing.\r\n     * xtb does not support this, all other formats do.\r\n     */\r\n    supportsSetDescriptionAndMeaning(): boolean;\r\n\r\n    /**\r\n     * Change description property of trans-unit.\r\n     * @param description description\r\n     */\r\n    setDescription(description: string);\r\n\r\n    /**\r\n     * Change meaning property of trans-unit.\r\n     * @param meaning meaning\r\n     */\r\n    setMeaning(meaning: string);\r\n\r\n    /**\r\n     * Get all notes of the trans-unit.\r\n     * Notes are remarks made by a translator.\r\n     * (description and meaning are not included here!)\r\n     */\r\n    notes(): INote[];\r\n\r\n    /**\r\n     * Test, wether setting of notes is supported.\r\n     * If not, setNotes will do nothing.\r\n     * xtb does not support this, all other formats do.\r\n     */\r\n    supportsSetNotes(): boolean;\r\n\r\n    /**\r\n     * Add notes to trans unit.\r\n     * @param newNotes the notes to add.\r\n     * @throws an Error if any note contains description or meaning as from attribute.\r\n     */\r\n    setNotes(newNotes: INote[]);\r\n\r\n    /**\r\n     * Translate the trans unit.\r\n     * @param translation the translated string or (preferred) a normalized message.\r\n     * The pure string can contain any markup and will not be checked.\r\n     * So it can damage the document.\r\n     * A normalized message prevents this.\r\n     */\r\n    translate(translation: string | INormalizedMessage);\r\n\r\n}\r\n"]}