Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ITableEvents

Интерфейс, определяющий события, генерируемые элементом ITable.

Hierarchy

Events

afterAddRow

  • Событие вызывается сразу после добавления строки в таблицу. Событие генерируется методом ITable.addRow или установкой значения ITable.value, а также методом ITable.setData. Событие вызывается после срабатывания всех событий элемента строки.

    let table: ITable = <ITable>{
        type: 'ITable',
        onAfterLoad(event: UILoadEvent, form: IForm, elem: ITable): Promise<void>{
             elem.on('afterAddRow', (event: UIRowEvent, form: IForm, elem: ITable) =>{
                 console.log(`Строка ${event.item.value} установлена`);
             });
        }   
    }
    

    Добавленная строка IRow доступна в объекте события UIRowEvent.row

    Parameters

    • event: UIRowEvent

      объект события для управления событием.

    • form: IForm<IFormEvents>

      Объект формы, которая содержит элемент.

    • elem: ITable<ITableEvents>

      Текущая таблица, для которой вызывается метод ITable.addRow.

    Returns void

Optional afterEdit

  • Событие вызывается после редактирования, в результате вызова метода IElement.edit.

    Для получения или изменения значения после редактирования используйте UIEditEvent.value.

    По завершении метода результат редактирования UIEditEvent.value будет подставлен в IElement.value.

    Так как редактирование завершено вызов UIEditEvent.stop игнорируется.

    На данные (если элемент - наследник IDataElement) возвращаемое значение никак не влияет. Если вы хотите изменить данные элемента вызывайте метод this.setData(...).

    Parameters

    • editEvent: UIEditEvent

      Объект для управлиения событием onBeforeedit.

    • form: IForm<IFormEvents>

      Объект формы, которая содержит элемент.

    • elem: IElement<IElementEvents>

      Текущий элемент формы, для которого вызывается метод.

    • item: IElement<IElementEvents>

      Подэлемент, если у элемента редактируется подэлемент (например, в IList или IGroup).

    Returns void

Optional afterLoad

Optional afterOpenContextMenu

  • afterOpenContextMenu(form: IForm<IFormEvents>, elem: IContextMenuElement, data?: any): void
  • Событие вызывается после открытия контекстного меню, и перед вызовом метода {@link IContextMenuElement.onAfterOpenContextMenu | onAfterOpenContextMenu()}.

    Событие не вызывается, если метод {@link IContextMenuElement.onBeforeOpenContextMenu | onBeforeOpenContextMenu()} вернул false.

    Parameters

    • form: IForm<IFormEvents>

      Объект формы, которая содержит элемент.

    • elem: IContextMenuElement

      Текущий элемент формы, для которого вызывается метод.

    • Optional data: any

      Данные элемента

    Returns void

afterRemoveRow

  • Событие вызывается сразу после удаления строки таблицы. Событие генерируется методом ITable.removeRow.

    Удаленная строка IRow доступна в объекте события UIRowEvent.row

    Parameters

    • event: UIRowEvent

      объект события для управления событием.

    • form: IForm<IFormEvents>

      Объект формы, которая содержит таблицу.

    • elem: ITable<ITableEvents>

      Текущая таблица, для которой вызывается метод ITable.removeRow.

    Returns void

Optional afterSetData

beforeAddRow

  • Событие, которое вызывается перед добавлением строки таблицы.

    let table: ITable = <ITable>{
        type: <ITable>,
        onAfterLoad(event: UILoadEvent, form: IForm, elem: ITable): Promise<void>{
             elem.on('beforeAddRow', (event: UIRowEvent, form: IForm, elem: ITable) =>{
                 console.log(`Данные строки перед добавлением ${event.data}`);
             });
        }  
    }
    

    Строка IRow еще не добавлена, поэтому свойство объекта события UIRowEvent.row == undefined.

    В этом событии доступны данные, используемые для добавления строки: UIRowEvent.data, если строка добавляется методом setData(), UIRowEvent.value, если строка добавляется установкой value.

    Отмена добавления вызывается методом UIRowEvent.stop

    Parameters

    • event: UIRowEvent

      объект события для управления событием.

    • form: IForm<IFormEvents>

      Объект формы, которая содержит элемент.

    • elem: ITable<ITableEvents>

      Текущая таблица, для которой вызывается метод ITable.addRow.

    Returns void

Optional beforeEdit

  • Событие вызывается перед началом редактирования, в результате вызова метода IElement.edit.

    Для получения значения до изменения используйте UIEditEvent.value.

    Для отмены редактирования выполните UIEditEvent.stop.

    Parameters

    • editEvent: UIEditEvent

      Объект для управлиения событием onBeforeedit.

    • form: IForm<IFormEvents>

      Объект формы, которая содержит элемент.

    • elem: IElement<IElementEvents>

      Текущий элемент формы, для которого вызывается метод.

    • item: IElement<IElementEvents>

      Подэлемент, если у элемента редактируется подэлемент (например, в IList или IGroup).

    Returns void

Optional beforeLoad

  • Событие вызывается перед загрузкой элемента, и перед вызовом метода onBeforeLoad().

    Если вы хотите получить данные, переданные в событие beforeLoad, или хотите остановить загрузку элемента, используйте объект event: UILoadEvent, соответственно UILoadEvent.data и UILoadEvent.stop.

    Parameters

    • event: UILoadEvent

      Объект события загузки.

    • form: IForm<IFormEvents>

      Объект формы, которая содержит элемент.

    • elem: IElement<IElementEvents>

      Текущий элемент формы, для которого вызывается событие.

    Returns void

Optional beforeOpenContextMenu

  • beforeOpenContextMenu(form: IForm<IFormEvents>, elem: IContextMenuElement, data?: any): void
  • Событие вызывается перед открытием контекстного меню, и перед вызовом метода {@link IContextMenuElement.onBeforeOpenContextMenu | onBeforeOpenContextMenu()}.

    Parameters

    • form: IForm<IFormEvents>

      Объект формы, которая содержит элемент.

    • elem: IContextMenuElement

      Текущий элемент формы, для которого вызывается метод.

    • Optional data: any

      Данные элемента.

    Returns void

beforeRemoveRow

  • Событие, которое вызывается перед удалением строки таблицы.

    let table: ITable = <ITable>{
        type: <ITable>,
        onAfterLoad(event: UILoadEvent, form: IForm, elem: ITable): Promise<void>{
             elem.on('beforeRemoveRow', (event: UIRowEvent, form: IForm, elem: ITable) =>{
                 console.log(`Элемент ${event.row.value} перед удалением`);
             });
        }   
    }
    

    Удаляемая строка IRow доступна в объекте события UIRowEvent.row Отмена удаления вызывается методом UIRowEvent.stop

    Parameters

    • event: UIRowEvent

      объект события для управления событием.

    • form: IForm<IFormEvents>

      Объект формы, которая содержит таблицу.

    • elem: ITable<ITableEvents>

      Текущая таблица, для которой вызывается метод ITable.removeRow.

    Returns void

Optional beforeSetData

  • Событие вызывается перед установкой данных элемента, и перед вызовом метода onBeforeSetData().

    Устанавливаемые данные можно получить UISetDataEvent.data.

    Если внутри метода вызвать UISetDataEvent.stop, то установка данных для элемента прекратится.

    Данные получаются соответствии со значением свойства IDataElement.bindingProperty. Эти данные могут быть изменены в этом методе и возвращены свойству UISetDataEvent.data. Возвращенные данные будут установлены для этого элемента.

    Parameters

    • event: UISetDataEvent

      Объект события установки данных.

    • form: IForm<IFormEvents>

      Объект формы, которая содержит элемент.

    • elem: IDataElement<IDataElementEvents>

      Текущий элемент формы, для которого вызывается метод.

    Returns void

Optional blur

  • Событие вызывается при потере фокуса элементом в следующих случаях:

    • при клике мыши на другом элементе,
    • при переключении между элементами с помощью клавиатуры,
    • при вызове метода IElement.blur.

    Сначала происходит погружение от элемента ко всем подэлементам, т.е. событие blur вызывается сначала у элемента, потом по всей иерархии вложенных элементов с фокусом. Затем всплытие, т.е событие blur вызывается по всей иерархии вложенных элементов от вложенного элемента с фокусом к элементу.

    Parameters

    • event: UIFocusEvent
    • form: IForm<IFormEvents>

      Объект формы, которая содержит элемент.

    • elem: IElement<IElementEvents>

      Элемент формы, на котором происходит событие.

    • item: IElement<IElementEvents>

      Подэлемент, если элемент формы включает другие элементы (например, подэлемент IList - IListItem).

    Returns void

Optional click

  • Событие вызывается после нажатия клавиши мыши.

    Parameters

    Returns void

Optional dblClick

  • Событие вызывается после двойного нажатия клавиши мыши.

    Parameters

    • event: UIMouseEvent
    • form: IForm<IFormEvents>

      Объект формы, которая содержит элемент.

    • elem: IElement<IElementEvents>

      Элемент формы, по которому клик.

    • item: IElement<IElementEvents>

      Подэлемент, по которому клик, если элемент формы включает другие элементы (например, подэлемент IList - IListItem).

    Returns void

Optional focus

  • Фокус на IElement появляется при клике и при навигации клавишами, только если установлено свойство tabindex, кроме IElements, являющихся подэлементом IList, ITable. Для них фокус если IList и ITable с tabindex.

    Событие вызывается при фокусе на элементе в следующих случаях:

    • при клике мыши (если установлено свойство tabindex),
    • при переключении между элементами с помощью клавиатуры (если установлено свойство tabindex),
    • при вызове метода IElement.focus.

    Сначала происходит погружение от формы к элементу, т.е. событие focus вызывается сначала у формы, потом по всей иерархии вложенных элементов. Затем всплытие, т.е. событе focus вызывается по всей иерархии вложенных элементов от элемента к форме.

    Parameters

    • event: UIFocusEvent
    • form: IForm<IFormEvents>

      Объект формы, которая содержит элемент.

    • elem: IElement<IElementEvents>

      Элемент формы, на котором происходит событие.

    • item: IElement<IElementEvents>

      Подэлемент, если элемент формы включает другие элементы (например, подэлемент IList - IListItem).

    Returns void

Optional hide

Optional keydown

  • Событие вызывается при нажатии клавиши на элементе, на котором установлен фокус (IElement.focus)

    Сначала происходит погружение от формы к элементу, т.е. событие keydown вызывается сначала у формы, потом по всей иерархии вложенных элементов. Затем всплытие, т.е. событе keydown вызывается по всей иерархии вложенных элементов от элемента к форме.

    Parameters

    Returns Promise<void>

Optional keyup

  • Событие вызывается при отпускании клавиши на элементе, на котором установлен фокус (IElement.focus)

    Сначала происходит погружение от формы к элементу, т.е. событие keyup вызывается сначала у формы, потом по всей иерархии вложенных элементов. Затем всплытие, т.е. событе keyup вызывается по всей иерархии вложенных элементов от элемента к форме.

    Parameters

    Returns Promise<void>

Optional show

  • Событие вызывается в момент привоения значения свойству IElement.visibility = true

    При открытии формы это событие вызывается только у формы. У элементов формы это событие не вызывается.

    Parameters

    Returns void

Generated using TypeDoc