Flexberry Documentation Flexberry Documentation

  • API Docs for Version: master

    • APIs

    Show:

    FlexberryEnumTransform Class

    Extends DS.Transform
    Defined in: addon/transforms/flexberry-enum.js:9
    Module: ember-flexberry-data

    Base transform class that implements an enumeration type. During serialization\deserialization it converts values to captions and vise versa.

    Item Index

    Methods

    Properties

    Methods

    deserialize

    (
    • serialized
    )
    String

    Defined in addon/transforms/flexberry-enum.js:84

    Returns deserialized enumeration field. Returns null or undefined if serialized has one of these values.

    Parameters:

    Returns:

    String:

    Deserialized enumeration field

    serialize

    (
    • deserialized
    )
    String | Number

    Defined in addon/transforms/flexberry-enum.js:106

    Returns serialized enumeration field. Returns null or undefined if deserialized has one of these values.

    Parameters:

    • deserialized String

      Deserialized enumeration field

    Returns:

    String | Number:

    Serialized enumeration field

    Properties

    captions

    Array

    Defined in addon/transforms/flexberry-enum.js:61

    Array that contains all values of enum properties.

    enum

    Object

    Defined in addon/transforms/flexberry-enum.js:18

    Object that contains enum values and corresponding captions. Must be overridden in inherited classes.

    Should be defined in app/enums/.

    Example:

    // app/enums/order-status.js
                    import { createEnum } from 'ember-flexberry/utils/enum-functions';
                    
                    export default createEnum({
                      Paid: 'Paid',
                      InProcess: 'In process',
                      Sent: 'Sent',
                      Arrived: 'Arrived',
                      NotArrived: 'Not arrived',
                      Unknown: 'Unknown'
                    });
                    
                    // app/transforms/order-status
                    import FlexberryEnum from 'ember-flexberry/transforms/flexberry-enum';
                    import OrderStatus from '../enums/order-status';
                    
                    export default FlexberryEnum.extend({
                      enum: OrderStatus
                    });

    inverse

    Object

    Defined in addon/transforms/flexberry-enum.js:52

    Object with inversed enum, value from enum property will be is property here.

    isEnum

    Boolean static

    Defined in addon/transforms/flexberry-enum.js:129

    Flag: indicates whether class represents enumeration. It is useful in cases when we need to determine that the model attribute type is an enumeration.

    Default: true

    sourceType

    String

    Defined in addon/transforms/flexberry-enum.js:141

    Source type name from the backend.

    Default: null