Class mxCellCodec

Add support for the legacy mxGraph format of Cell.

Hierarchy (view full)

Constructors

constructor

Properties

exclude idrefs mapping reverse template allowEval

Methods

addObjectValue afterDecode afterEncode beforeDecode beforeEncode cloneTemplate convertAttributeFromXml convertAttributeToXml decode decodeAttribute decodeAttributes decodeChild decodeChildren decodeNode encode encodeObject encodeValue getAttributeName getFieldName getFieldTemplate getName isBooleanAttribute isCellCodec isExcluded isIgnoredAttribute isNumericAttribute isReference processInclude setName writeAttribute writeComplexAttribute writePrimitiveAttribute

Constructors

constructor

Properties

exclude

exclude: string[]

Array containing the variable names that should be ignored by the codec.

idrefs

idrefs: string[]

Array containing the variable names that should be turned into or converted from references. See Codec.getId and Codec.getObject.

mapping

mapping: {
    [key: string]: string;
}

Maps from field names to XML attribute names.

reverse

reverse: {
    [key: string]: string;
}

Maps from XML attribute names to fieldnames.

template

template: any

Holds the template object associated with this codec.

StaticallowEval

allowEval: boolean = false

Static global switch that specifies if expressions in arrays are allowed.

NOTE: Enabling this carries a possible security risk.

Default

false

Methods

addObjectValue

  • addObjectValue(obj, fieldname, value, template): void

  • Sets the decoded child node as a value of the given object. If the object is a map, then the value is added with the given field name as a key. If the field name is not empty, then setFieldValue is called or else, if the object is a collection, the value is added to the collection. For strongly typed languages it may be required to override this with the correct code to add an entry to an object.

    Parameters

    • obj: any
    • fieldname: string
    • value: any
    • template: any

    Returns void

afterDecode

  • afterDecode(dec, node, obj?): any

  • Hook for subclassers to post-process the object after decoding. This implementation returns the given object without any changes. The return value of this method is returned to the decoder from decode.

    Parameters

    • dec: Codec

      Codec that controls the encoding process.

    • node: null | Element

      XML node to be decoded.

    • Optionalobj: any

      Object that represents the default decoding.

    Returns any

afterEncode

beforeDecode

beforeEncode

  • beforeEncode(enc, obj, node?): any

  • Hook for subclassers to pre-process the object before encoding. This returns the input object. The return value of this function is used in encode to perform the default encoding into the given node.

    Parameters

    • enc: Codec

      Codec that controls the encoding process.

    • obj: any

      Object to be encoded.

    • Optionalnode: Element

      XML node to encode the object into.

    Returns any

cloneTemplate

convertAttributeFromXml

convertAttributeToXml

  • convertAttributeToXml(enc, obj, name, value, node): any

  • Converts true to "1" and false to "0" is isBooleanAttribute returns true. All other values are not converted.

    Parameters

    • enc: Codec

      Codec that controls the encoding process.

    • obj: any

      Objec to convert the attribute for.

    • name: null | string

      Name of the attribute to be converted.

    • value: any

      Value to be converted.

    • node: Element

    Returns any

decode

  • decode(dec, node, into?): any

  • Parses the given node into the object or returns a new object representing the given node.

    Dec is a reference to the calling decoder. It is used to decode complex objects and resolve references.

    If a node has an id attribute then the object cache is checked for the object. If the object is not yet in the cache then it is constructed using the constructor of template and cached in Codec.objects.

    This implementation decodes all attributes and childs of a node according to the following rules:

    • If the variable name is in exclude or if the attribute name is "id" or "as" then it is ignored.
    • If the variable name is in idrefs then Codec.getObject is used to replace the reference with an object.
    • The variable name is mapped using a reverse mapping.
    • If the value has a child node, then the codec is used to create a child object with the variable name taken from the "as" attribute.
    • If the object is an array and the variable name is empty then the value or child object is appended to the array.
    • If an add child has no value or the object is not an array then the child text content is evaluated using eval.

    For add nodes where the object is not an array and the variable name is defined, the default mechanism is used, allowing to override/add methods as follows:

    <Object>
      <add as="hello"><![CDATA[
        function(arg1) {
          mxUtils.alert('Hello '+arg1);
        }
      ]]></add>
    </Object>

    If no object exists for an ID in idrefs a warning is issued using GlobalConfig.logger.

    Returns the resulting object that represents the given XML node or the object given to the method as the into parameter.

    Parameters

    • dec: Codec

      Codec that controls the decoding process.

    • node: Element

      XML node to be decoded.

    • Optionalinto: any

      Optional object to encode the node into.

    Returns any

decodeAttribute

decodeAttributes

decodeChild

  • decodeChild(dec, child, obj): void

  • Reads the specified child into the given object.

    Parameters

    • dec: Codec

      Codec that controls the decoding process.

    • child: Element

      XML child element to be decoded.

    • obj: any

      Objec to encode the node into.

    Returns void

decodeChildren

decodeNode

encode

  • encode(enc, obj): null | Element

  • Encodes the specified object and returns a node representing then given object. Calls beforeEncode after creating the node and afterEncode with the resulting node after processing.

    Enc is a reference to the calling encoder. It is used to encode complex objects and create references.

    This implementation encodes all variables of an object according to the following rules:

    • If the variable name is in exclude then it is ignored.
    • If the variable name is in idrefs then Codec.getId is used to replace the object with its ID.
    • The variable name is mapped using mapping.
    • If obj is an array and the variable name is numeric (ie. an index) then it is not encoded.
    • If the value is an object, then the codec is used to create a child node with the variable name encoded into the "as" attribute.
    • Else, if encodeDefaults is true or the value differs from the template value, then ...
    • ... if obj is not an array, then the value is mapped to an attribute.
    • ... else if obj is an array, the value is mapped to an add child with a value attribute or a text child node, if the value is a function.

    If no ID exists for a variable in idrefs or if an object cannot be encoded, a warning is issued using GlobalConfig.logger.

    Returns the resulting XML node that represents the given object.

    Parameters

    • enc: Codec

      Codec that controls the encoding process.

    • obj: any

      Object to be encoded.

    Returns null | Element

encodeObject

encodeValue

  • encodeValue(enc, obj, name, value, node): void

  • Converts the given value according to the mappings and id-refs in this codec and uses writeAttribute to write the attribute into the given node.

    Parameters

    • enc: Codec

      Codec that controls the encoding process.

    • obj: any

      Object whose property is going to be encoded.

    • name: null | string

      XML node that contains the encoded object.

    • value: any

      Value of the property to be encoded.

    • node: Element

      XML node that contains the encoded object.

    Returns void

getAttributeName

  • getAttributeName(fieldname): null | string

  • Returns the attribute name for the given field name. Looks up the value in the mapping or returns the input if there is no mapping for the given name.

    Parameters

    • fieldname: null | string

    Returns null | string

getFieldName

  • getFieldName(attributename): string

  • Returns the field name for the given attribute name. Looks up the value in the reverse mapping or returns the input if there is no reverse mapping for the given name.

    Parameters

    • attributename: string

    Returns string

getFieldTemplate

  • getFieldTemplate(obj, fieldname, child): any

  • Returns the template instance for the given field. This returns the value of the field, null if the value is an array or an empty collection if the value is a collection. The value is then used to populate the field for a new instance. For strongly typed languages it may be required to override this to return the correct collection instance based on the encoded child.

    Parameters

    • obj: any
    • fieldname: string
    • child: Element

    Returns any

getName

  • getName(): string

  • Returns the name used for the node names and lookup of the codec when classes are encoded and nodes are decoded. For classes to work with this the codec registry automatically adds an alias for the classname if that is different from what this returns.

    The default implementation returns the classname of the template class if no name is set.

    Returns string

isBooleanAttribute

  • isBooleanAttribute(enc, obj, name, value): boolean

  • Returns true if the given object attribute is a boolean value.

    Parameters

    • enc: Codec

      Codec that controls the encoding process.

    • obj: any

      Object to convert the attribute for.

    • name: null | string

      Name of the attribute to be converted.

    • value: any

      Value of the attribute to be converted.

    Returns boolean

isCellCodec

isExcluded

isIgnoredAttribute

  • isIgnoredAttribute(dec, attr, obj?): boolean

  • Returns true if the given attribute should be ignored. This implementation returns true if the attribute name is "as" or "id".

    Parameters

    • dec: Codec

      Codec that controls the decoding process.

    • attr: any

      XML attribute to be decoded.

    • Optionalobj: any

      Objec to encode the attribute into.

    Returns boolean

isNumericAttribute

isReference

  • isReference(obj, attr, value, write?): boolean

  • Returns true if the given field name is to be treated as a textual reference (ID). This implementation returns true if the given field name is in idrefs.

    Parameters

    • obj: any

      Object instance that contains the field.

    • attr: string

      Field name of the field.

    • value: any

      Value of the field.

    • Optionalwrite: boolean

      Boolean indicating if the field is being encoded or decoded. Write is true if the field is being encoded, else it is being decoded.

    Returns boolean

processInclude

  • processInclude(dec, node, into?): boolean

  • Returns true if the given node is an include directive and executes the include by decoding the XML document. Returns false if the given node is not an include directive.

    Parameters

    • dec: Codec

      Codec that controls the encoding/decoding process.

    • node: Element

      XML node to be checked.

    • Optionalinto: any

      Optional object to pass-thru to the codec.

    Returns boolean

setName

writeAttribute

writeComplexAttribute

writePrimitiveAttribute

Settings

Member Visibility

On This Page

Constructors
Properties
Methods