Class mxForm

A simple class for creating HTML forms.

Hierarchy

mxForm

Index

Constructors

constructor

Properties

body
table

Methods

Constructors

constructor

new mxForm(className: string): mxForm

- Defined in util/mxForm.d.ts:8
Creates a HTML table using the specified classname.

Parameters
- className: string
Returns mxForm

Properties

body

body: boolean

Holds the DOM node that represents the tbody (table body). New rows can be added to this object using DOM API.

table

table: HTMLTableElement

Holds the DOM node that represents the table.

Methods

addButtons

addButtons(okFunct: Function, cancelFunct: Function): void

- Defined in util/mxForm.d.ts:35
Helper method to add an OK and Cancel button using the respective functions.

Parameters
- okFunct: Function
- cancelFunct: Function
Returns void

addCheckbox

addCheckbox(name: string, value: boolean): HTMLInputElement

- Defined in util/mxForm.d.ts:45
Adds a checkbox for the given name and value and returns the textfield.

Parameters
- name: string
- value: boolean
Returns HTMLInputElement

addCombo

addCombo(name: string, isMultiSelect: boolean, size?: number): HTMLSelectElement

- Defined in util/mxForm.d.ts:55
Adds a combo for the given name and returns the combo.

Parameters
- name: string
- isMultiSelect: boolean
- Optional size: number
Returns HTMLSelectElement

addField

addField(name: string, input: FormFieldType): FormFieldType

- Defined in util/mxForm.d.ts:66
Adds a new row with the name and the input field in two columns and returns the given input.

Parameters
- name: string
- input: FormFieldType
Returns FormFieldType

addOption

addOption(combo: HTMLElement, label: string, value: any, isSelected?: boolean): void

- Defined in util/mxForm.d.ts:60
Adds an option for the given label to the specified combo.

Parameters
- combo: HTMLElement
- label: string
- value: any
- Optional isSelected: boolean
Returns void

addText

addText(name: string, value: any, type: string): HTMLInputElement

- Defined in util/mxForm.d.ts:40
Adds an input for the given name, type and value and returns it.

Parameters
- name: string
- value: any
- type: string
Returns HTMLInputElement

addTextarea

addTextarea(name: string, value: string, rows: number): HTMLTextAreaElement

- Defined in util/mxForm.d.ts:50
Adds a textarea for the given name and value and returns the textarea.

Parameters
- name: string
- value: string
- rows: number
Returns HTMLTextAreaElement

getTable

getTable(): HTMLTableElement

- Defined in util/mxForm.d.ts:29
Returns the table that contains this form.

Returns HTMLTableElement

Generated using TypeDoc