Interface IXmlWriter

Hierarchy

Index

Properties

Methods

Properties

optional public alias?: Array<string>

[Config Option] (String[])

optional public alternateClassName?: any

[Config Option] (String/String[])

optional public config?: any

[Config Option] (Object)

optional public defaultDocumentRoot?: string

[Config Option] (String)

optional public documentRoot?: string

[Config Option] (String)

optional public extend?: string

[Config Option] (String)

optional public header?: string

[Config Option] (String)

optional public inheritableStatics?: any

[Config Option] (Object)

optional public mixins?: any

[Config Option] (Object)

optional public nameProperty?: string

[Config Option] (String)

optional public platformConfig?: any

[Config Option] (Object)

optional public record?: string

[Config Option] (String)

optional public self?: IClass

[Property] (Ext.Class)

optional public singleton?: boolean

[Config Option] (Boolean)

optional public statics?: any

[Config Option] (Object)

optional public uses?: Array<string>

[Config Option] (String[])

optional public writeAllFields?: boolean

[Config Option] (Boolean)

Methods

optional public callOverridden(args?: any): any

[Method] Call the original method that was previously overridden with override This method is deprecated as callParent does

Parameters

  • args?: any optional

    Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments)

Returns

any

Object Returns the result of calling the overridden method

optional public callParent(args?: any): any

[Method] Call the parent method of the current method

Parameters

  • args?: any optional

    Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments)

Returns

any

Object Returns the result of calling the parent method

optional public callSuper(args?: any): any

[Method] This method is used by an override to call the superclass method but bypass any overridden method

Parameters

  • args?: any optional

    Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments)

Returns

any

Object Returns the result of calling the superclass method

optional public destroy()

[Method]

optional public getDefaultDocumentRoot(): string

[Method] Returns the value of defaultDocumentRoot

Returns

string

String

optional public getDocumentRoot(): string

[Method] Returns the value of documentRoot

Returns

string

String

optional public getHeader(): string

[Method] Returns the value of header

Returns

string

String

optional public getInitialConfig(name?: string): any

[Method] Returns the initial configuration passed to constructor

Parameters

  • name?: string optional

    String When supplied, value for particular configuration option is returned, otherwise the full config object is returned.

Returns

any

Object/Mixed

optional public getNameProperty(): string

[Method] Returns the value of nameProperty

Returns

string

String

optional public getRecord(): string

[Method] Returns the value of record

Returns

string

String

optional public getRecordData(record?: any): any

[Method] Formats the data for each record before sending it to the server

Parameters

  • record?: any optional

    Object The record that we are writing to the server.

Returns

any

Object An object literal of name/value keys to be written to the server. By default this method returns the data property on the record.

optional public getWriteAllFields(): boolean

[Method] Returns the value of writeAllFields

Returns

boolean

Boolean

optional public initConfig(instanceConfig?: any): any

[Method] Initialize configuration for this class

Parameters

  • instanceConfig?: any optional

    Object

Returns

any

Object mixins The mixin prototypes as key - value pairs

optional public setDefaultDocumentRoot(defaultDocumentRoot?: string)

[Method] Sets the value of defaultDocumentRoot

Parameters

  • defaultDocumentRoot?: string optional

    String The new value.

optional public setDocumentRoot(documentRoot?: string)

[Method] Sets the value of documentRoot

Parameters

  • documentRoot?: string optional

    String The new value.

optional public setHeader(header?: string)

[Method] Sets the value of header

Parameters

  • header?: string optional

    String The new value.

optional public setNameProperty(nameProperty?: string)

[Method] Sets the value of nameProperty

Parameters

  • nameProperty?: string optional

    String The new value.

optional public setRecord(record?: string)

[Method] Sets the value of record

Parameters

  • record?: string optional

    String The new value.

optional public setWriteAllFields(writeAllFields?: boolean)

[Method] Sets the value of writeAllFields

Parameters

  • writeAllFields?: boolean optional

    Boolean The new value.

optional public write(request?: IRequest): IRequest

[Method] Prepares a Proxy s Ext data Request object

Parameters

  • request?: IRequest optional

    Ext.data.Request The request object.

Returns

IRequest

Ext.data.Request The modified request object.

optional public writeRecords(request?: any, data?: Array<any>): any

[Method]

Parameters

  • request?: any optional

    Object

  • data?: Array<any> optional

    Array

Returns

any

Object