Array containing the variable names that should be ignored by the codec.
Array containing the variable names that should be turned into or converted from references. See Codec.getId and Codec.getObject.
Maps from field names to XML attribute names.
Maps from XML attribute names to fieldnames.
Holds the template object associated with this codec.
Static
allowStatic global switch that specifies if expressions in arrays are allowed.
NOTE: Enabling this carries a possible security risk.
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.
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.
Hook for subclassers to post-process the node for the given object after encoding and return the post-processed node. This implementation returns the input node. The return value of this method is returned to the encoder from encode.
Hook for subclassers to pre-process the node for the specified object and return the node to be used for further processing by decode. The object is created based on the template in the calling method and is never null. This implementation returns the input node. The return value of this function is used in decode to perform the default decoding into the given object.
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.
Converts booleans and numeric values to the respective types. Values are numeric if isNumericAttribute returns true.
Converts true to "1" and false to "0" is isBooleanAttribute returns true. All other values are not converted.
Reads a sequence of the following child nodes and attributes:
Child Nodes:
add - Binds a keystroke to an action name.
Attributes:
as - Keycode. action - Action name to execute in editor. control - Optional boolean indicating if the control key must be pressed.
Example:
<EditorKeyHandler as="keyHandler">
<add as="88" control="true" action="cut"/>
<add as="67" control="true" action="copy"/>
<add as="86" control="true" action="paste"/>
</EditorKeyHandler>
The keycodes are for the x, c and v keys.
See also: <EditorKeyHandler.bindAction>, http://www.js-examples.com/page/tutorials__key_codes.html
Decodes all attributes of the given node using decodeAttribute.
Decodes all children of the given node using decodeChild.
Calls decodeAttributes and decodeChildren for the given node.
Returns null
.
Encodes the value of each member in then given obj into the given node using encodeValue.
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.
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.
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.
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.
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 true if the given attribute is to be ignored by the codec. This implementation returns true if the given field name is in exclude or if the field name equals ObjectIdentity.FIELD_NAME.
Object instance that contains the field.
Fieldname of the field.
Value of the field.
Optional
write: booleanBoolean indicating if the field is being encoded or decoded. Write is true if the field is being encoded, else it is being decoded.
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.
Object instance that contains the field.
Field name of the field.
Value of the field.
Optional
write: booleanBoolean indicating if the field is being encoded or decoded. Write is true if the field is being encoded, else it is being decoded.
Writes the given value into node using writePrimitiveAttribute or writeComplexAttribute depending on the type of the value.
Writes the given value as a child node of the given node.
Writes the given value as an attribute of the given node.
Custom codec for configuring EditorKeyHandlers.
This class is created and registered dynamically at load time and used implicitly via Codec and the CodecRegistry.
This codec only reads configuration data for existing key handlers, it does not encode or create key handlers.