import DataItemContainer from './gui/data-items/DataItemContainer.jsx'

public class | source

DataItemContainer

Extends:

gui/data-items/DataItem.js~DataItem → DataItemContainer

The purpose of DataItemContainer is to hold one or more child data items and manage the hidden, suppressed, and disabled props for all of it's children.

Constructor Summary

Public Constructor
public	constructor(dataName: string) Constructor

Member Summary

Public Members
public	addDataItem(dataItem: DataItem): * Function that adds a new data item to the data item container.
public	getDataItem(name: string): DataItem: * Function that returns the data item matching the name parameter, if it exists.
public	getDataItems: Array: * Function that returns all child data items.
public	getDisabled: boolean: * Function that returns whether or not any UI element bound to this data item will be disabled for edit; effectively read only.
public	getHidden(test: string): boolean: * Function that returns whether or not any UI element bound to this data item will be hidden.
public	removeDataItem(name: string): * Function that removes the data item matching the name parameter, if it exists.
public	setDisabled(disabled: boolean): * Function that changes whether or not any of the children of the data item container will be disabled for edit; effectively read only.
public	setHidden(hidden: boolean): * Function that allows you to change the visibility of any children of the data item container.
public	toJson(resolve: function, reject: function, macroMode: boolean, allowCdata: boolean): * Function that serializes the data item's value into xml for persistence. This one differs from most in that it allows serialization into a cdata section.

Public Constructors

public constructor(dataName: string) source

Constructor

Params:

Name	Type	Attribute	Description
dataName	string		The name of the data Item.

Public Members

public addDataItem(dataItem: DataItem): * source

Function that adds a new data item to the data item container.

public getDataItem(name: string): DataItem: * source

Function that returns the data item matching the name parameter, if it exists.

Return:

DataItem

The returned data item.

public getDataItems: Array: * source

Function that returns all child data items.

Return:

Array

An array of data items.

public getDisabled: boolean: * source

Function that returns whether or not any UI element bound to this data item will be disabled for edit; effectively read only.

Return:

boolean

public getHidden(test: string): boolean: * source

Function that returns whether or not any UI element bound to this data item will be hidden.

Return:

boolean

public removeDataItem(name: string): * source

Function that removes the data item matching the name parameter, if it exists.

public setDisabled(disabled: boolean): * source

Function that changes whether or not any of the children of the data item container will be disabled for edit; effectively read only.

public setHidden(hidden: boolean): * source

Function that allows you to change the visibility of any children of the data item container.

public toJson(resolve: function, reject: function, macroMode: boolean, allowCdata: boolean): * source

Function that serializes the data item's value into xml for persistence. This one differs from most in that it allows serialization into a cdata section.