Перейти к основному содержимому
Версия: 7.0

Опции свойства

При объявлении свойства в инструкции = в конце объявления может указываться некоторый набор опций свойства.

Синтаксис​

Опции перечесляются друг за другом в произвольном порядке через пробел или переводы строк:

propertyOption1 ... propertyOptionN

Поддерживается следующий набор опций (синтаксис каждой опции указывается в отдельной строке):

IN groupName
viewType
customView
ON eventType { actionOperator }
CHANGEKEY key [SHOW | HIDE]
CHANGEMOUSE key [SHOW | HIDE]
STICKY | NOSTICKY
syncType
MATERIALIZED [dbName]
TABLE tableName
INDEXED [dbName] [indexType]
COMPLEX | NOCOMPLEX
PREREAD
HINT | NOHINT
NONULL [DELETE] eventClause
AGGR
AUTOSET
CHARWIDTH width [FLEX | NOFLEX]
PATTERN patternStr
REGEXP rexpr [message] 
ECHO
DEFAULTCOMPARE compare
EVENTID eventId
LAZY [WEAK | STRONG] [WAIT | NOWAIT]
EXTID extId
imageSetting
annotationSetting

Описание и параметры​

  • MATERIALIZED [dbName]

    Ключевое слово, помечающее свойство как материализованное. Такие свойства будут храниться в полях таблицы базы данных.

    • dbName

      Строковый литерал, задающий физическое имя поля (колонки) в базе данных. Если не указан, имя генерируется автоматически.

  • TABLE tableName

    Указание таблицы, в которой будет храниться свойство. Количество ключей таблицы должно совпадать с количеством аргументов свойства, и классы аргументов должны подходить к классам ключей таблицы. Если таблица не задана, свойство автоматически будет помещено в "ближайшую" существующую в системе таблицу.

    • tableName

      Имя таблицы. Составной идентификатор.

  • INDEXED

    Ключевое слово, указание которого создает индекс по этому свойству. Может использоваться только для материализованного свойства. Аналогично использованию инструкции INDEX.

    • dbName

      Строковый литерал, задающий физическое имя индекса в базе данных. Если не указан, имя генерируется автоматически.

    • indexType

      Необязательный выбор специального типа индекса. Если не указан, создается обычный индекс.

      • LIKE

        Ключевое слово, указание которого для строковых свойств сохраняет обычный индекс и дополнительно пытается создать специализированный GIN индекс для операций LIKE.

      • MATCH

        Ключевое слово, указание которого создает индекс для операций MATCH.

        • для одного поля типа TSVECTOR создается только специализированный GIN индекс по самому полю
        • для строковых свойств сохраняется обычный индекс и дополнительно пытаются создаваться специализированные индексы для MATCH и LIKE
        • строковый MATCH индекс строится по to_tsvector с текущим языком полнотекстового поиска

        Специализированные LIKE / MATCH индексы создаются только если для текущего адаптера БД доступна соответствующая trigram/full-text поддержка. Обычный индекс при этом создается независимо от нее.

  • COMPLEX | NOCOMPLEX

    Ключевые слова, помечающие вычисление свойства как сложное (COMPLEX) или явно несложное (NOCOMPLEX). Сложное свойство всегда вычитывается заранее. Если ничего не указано, свойство считается сложным только если прямо или транзитивно зависит от сложного свойства.

  • PREREAD

    Ключевое слово, при котором значение свойства вычитывается заранее при обработке изменений, а не вычисляется на месте.

  • HINT | NOHINT

    Ключевые слова, управляющие автоматическим инкрементальным кэшированием изменений свойства. HINT принудительно включает такое кэширование для свойства, когда оно применимо; NOHINT отключает его для свойства и зависящих от него свойств. Без указания платформа решает автоматически (эвристически).

  • NONULL [DELETE] eventClause

    Добавление ограничения определенности. Если это ограничение в результате каких-то изменений для некоторых объектов нарушается, то будет либо показано соответствующее сообщение, либо при указании DELETE такие объекты будут удалены.

    • DELETE

      Ключевое слово, при указании которого в случае, если свойство становится равным NULL, будут удалены объекты, которые являются в данном случае аргументами свойства.

    • eventClause

      Блок описания типа события. Описывает событие по которому будет выполняться проверка свойства на NULL.

  • AGGR

    Ключевое слово, помечающее свойство как агрегирующее. Предназначено для свойства, которое принимает один параметр пользовательского класса и возвращает объект, в который этот параметр агрегируется; только такое свойство регистрируется как агрегирующее свойство этого класса. Платформа обращается с ним так же, как со свойством, которое оператор AGGR создает автоматически для поиска агрегируемого объекта по его параметрам: для заданного объекта-параметра оно находит существующий агрегируемый объект, что позволяет платформе проверять целостность агрегации и повторно использовать этот объект вместо создания дубликата. Это опция свойства, и её не следует путать с оператором AGGR, который является определением свойства.

  • AUTOSET

    Ключевое слово, помечающее первичное свойство с объектным параметром и объектным значением для автоматической установки при создании объекта. Если объект создается с опцией AUTOSET (например, NEW ... AUTOSET) и его класс совпадает с классом параметра свойства или является его наследником, платформа устанавливает для него это свойство в текущий объект класса значения, если он доступен.

Блок интерактивного представления​

  • viewType

    Указание типа представления свойства при добавлении на форму.

    • GRID - колонка таблицы
    • TOOLBAR - тулбар
    • PANEL - панель

    По действию аналогично указанию опции viewType в блоке свойств инструкции FORM. Соответственно если эта опция не указана ни в опциях свойств, ни в блоке свойств непосредственно на форме, используется тип представления по умолчанию для группы отображения, добавляемого на форму свойства.

  • customView

    Указание пользовательского представления значения свойства при добавлении на форму. По действию аналогично указанию опции customView в блоке свойств инструкции FORM, которая может его переопределить.

  • ON eventType { actionOperator }

    Указание действия, которое будет обработкой по умолчанию некоторого события формы всех интерактивных представлений этого свойства. Могут быть переопределены в блоке свойств инструкции FORM.

    • eventType

      Тип события формы. Задается одним из следующих вариантов:

      • CHANGE - происходит при попытке изменения значения свойства.
      • CHANGEWYS - происходит при попытке изменении значения свойства с помощью специального механизма ввода.
      • GROUPCHANGE - происходит при попытке изменения значения свойства для всех объектов в таблице (групповое редактирование).
      • EDIT - происходит при попытке редактировать объект, который является значением этого свойства.
      • CONTEXTMENU [caption] - пользователь выбрал в контекстном меню свойства на форме заданный пункт. Также при необходимости можно задать заголовок caption этого пункта меню (строковый литерал). Если этого не сделать, то, по умолчанию, он будет равен заголовку действия.

    • actionOperator

      Контекстно-зависимый оператор-действие. Оператор, описывающий выполняемое по событию действие. В качестве параметров оператора можно использовать параметры самого свойства.

  • imageSetting

    Настройка иконки, которая будет отображаться для свойства. Эта опция позволяет настроить отображение иконки вручную. Может иметь один из двух видов:

    • IMAGE [imageLiteral]

      Указание иконки, которая будет отображаться в качестве иконки свойства. Если imageLiteral не указывается, то происходит переключение в режим автоматической установки иконки.

      • imageLiteral

        Строковый литерал, значение которого определяет иконку.

    • NOIMAGE

      Ключевое слово, указывающее на то, что иконка свойства должна отсутствовать.

  • annotationSetting

    Аннотация свойства. Начинается с @@. Поддерживаются следующие аннотации:

    • @@deprecated

    • @@deprecated(since)

    • @@deprecated(since,message)

      Пометка свойства как устаревшего и не рекомендованного для использования. Плагин показывает использование таких свойств перечёркнутым.

      • since

        Строковый литерал, версия платформы, начиная с которой свойство считается устаревшим.

      • message

        Строковый литерал, сообщение, поясняющее, почему свойство помечено устаревшим.

Блок значений по умолчанию инструкции DESIGN​

  • CHARWIDTH width [FLEX | NOFLEX]

    Указание количества символов значения свойства, которые должны быть видны пользователю. Устанавливает значение для дизайна по умолчанию, может быть переопределено в инструкции DESIGN.

    • width

      Количество символов. Целочисленный литерал.

    • FLEX

      Ключевое слово. Если указано, коэффициент расширения значения свойства автоматически устанавливается равным его базовому размеру.

    • NOFLEX

      Ключевое слово. Если указано, коэффициент расширения значения свойства автоматически устанавливается равным нулю.

  • PATTERN patternStr

    Указание шаблона форматирования значения свойства. Синтаксис задания шаблона аналогичен синтаксису DecimalFormat либо SimpleDateFormat в зависимости от типа значения.

    • patternStr

      Строковый литерал, задающий шаблон форматирования. Может быть локализуемым.

  • REGEXP rexpr [message]

    Указание регулярного выражения, которому должно соответствовать значение свойства после редактирования. Устанавливает значение для дизайна по умолчанию, может быть переопределено в инструкции DESIGN.

    • rexpr

      Строковый литерал, описывающий регулярное выражение. Правила задания аналогичны принятым в языке Java. Может быть локализуемым.

    • message

      Строковый литерал, описывающий сообщение, которое будет показано пользователю в случае, если он введет значение, не соответствующее регулярному выражению. Может быть локализуемым. Если не указывается, то будет показано сообщение по умолчанию.

  • ECHO

    Ключевое слово, указание которого приведет к отображению символов звездочки * вместо значения свойства. Используется, например, для паролей. Может быть переопределено в инструкции DESIGN.

  • CHANGEKEY key [SHOW | HIDE]

    Указание комбинации клавиш, при нажатии которой будет начато редактирование свойства. Устанавливает значение для дизайна по умолчанию, может быть переопределено в инструкции DESIGN.

    • key

    Строковый литерал, описывающий комбинацию клавиш. Синтаксис:

    keyStroke [;(modeKey=modeValue;)*]

    • keyStroke Строковое представление комбинации клавиш. Принцип задания аналогичен способу задания параметра в методе Java-класса Keystroke.getKeystroke(String).

    • (modeKey=modeValue;)* Опции, задающие условия выполнения для keyStroke. Поддерживаются следующие опции:

      • priority = priorityValue Приоритет, целочисленное значение. Если несколько свойств имеют подходящий под условия CHANGEKEY, выполнится тот, у которого приоритет будет выше. Если приоритет не задан, он равняется порядковому номеру свойства на форме. Кроме того, в любом случае к значению приоритета добавляется 1000, если совпадает группа объектов.

      • preview = previewValue Все события проверяются на выполнение дважды: сначала с isPreview=true, потом - с isPreview=false. Поддерживаемые значения previewValue:

        • auto, only -> isPreview
        • no -> !isPreview
        • all -> true

      • dialog = dialogValue Проверка, выполнять ли CHANGEKEY в диалоговом окне. Поддерживаемые значения dialogValue:

        • auto, all -> true
        • only -> isDialog
        • no -> !isDialog

      • window = windowValue Проверка, выполнять ли CHANGEKEY в модальном окне. Поддерживаемые значения windowValue:

        • auto, all -> true
        • only -> isWindow
        • no -> !isWindow

      • group = groupValue Проверка, совпадает ли группа объектов. Поддерживаемые значения groupValue:

        • auto, all -> true
        • only -> equalGroup
        • no -> !equalGroup

      • editing = editingValue Проверка, выполнять ли CHANGEKEY в режиме редактирования свойства. Поддерживаемые значения editingValue:

        • auto -> !(isEditing() && getEditElement().isOrHasChild(Element.as(event.getEventTarget())))
        • all -> true
        • only -> isEditing
        • no -> !isEditing

      • showing = showingValue Проверка, показывается ли в данный момент свойство на форме (для свойств, скрытых через hide в дизайне). Поддерживаемые значения showingValue:

        • auto, only -> isShowing
        • all -> true
        • no -> !isShowing

      • panel = panelValue Проверка, находится ли свойство в панели. Поддерживаемые значения panelValue:

        • auto -> !isMouse || !isPanel
        • all -> true
        • only -> isPanel
        • no -> !isPanel

      • cell = cellValue Проверка, находится ли свойство в таблице. Поддерживаемые значения cellValue:

        • auto -> !isMouse || isCell
        • all -> true
        • only -> isCell
        • no -> !isCell

      Для всех опций кроме priority значением по умолчанию является auto.

    • SHOW

      Ключевое слово, при указании которого комбинация клавиш будет отображаться в заголовке свойства. Используется по умолчанию.

    • HIDE

      Ключевое слово, при указании которого комбинация клавиш не будет отображаться в заголовке свойства.

  • CHANGEMOUSE key [SHOW | HIDE]

    Указание комбинации клавиш мыши, при нажатии которых будет начато редактирование свойства. Устанавливает значение для дизайна по умолчанию, может быть переопределено в инструкции DESIGN.

    • key

    Строковый литерал, описывающий комбинацию клавиш. Синтаксис:

    keyStroke [;(modeKey=modeValue;)*]

    • keyStroke Строковое представление комбинации клавиш мыши. В данный момент единственное поддерживаемое значение - DBLCLK - двойной клик.

    • (modeKey=modeValue;)* Синтаксис полностью совпадает с CHANGEKEY.

    • SHOW

      Ключевое слово, при указании которого комбинация клавиш мыши будет отображаться в заголовке свойства. Используется по умолчанию.

    • HIDE

      Ключевое слово, при указании которого комбинация клавиш мыши не будет отображаться в заголовке свойства.

  • STICKY | NOSTICKY

    Ключевые слова. STICKY указывает на то, что свойство в таблице будет прикреплено слева и при скроллинге вправо будет оставаться видимым. NOSTICKY снимает это закрепление. По умолчанию STICKY или NOSTICKY вычисляется эвристически.

  • syncType

    Определяет, включены ли для свойства асинхронные действия:

    • WAIT - асинхронные действия выключены.
    • NOWAIT - асинхронные действия включены.

    Если опция не указана, действия выполняются синхронно.

  • DEFAULTCOMPARE compare

    Указание для свойства типа фильтра по умолчанию.

    • compare

      Тип фильтра по умолчанию. Строковый литерал. Может принимать следующие значения: =, >, <, >=, <=, !=, =* (содержит), =@ (нечёткий поиск). По умолчанию принимает значение = для всех типов данных кроме строковых регистронезависимых, для которых принимает значение =@ или =* (а при включенной настройке System.defaultCompareForStringContains - кроме всех строковых, независимо от регистронезависимости). Выбор значения =@ или =* зависит от настройки System.defaultCompareSearchInsteadOfContains (true - =@, false - =*, по умолчанию true). Может быть переопределено в инструкции DESIGN.

  • EVENTID eventId

    Указание для свойства специального режима обработки ввода.

    • eventId

      Строковый литерал. На данный момент поддерживается только значение SCANNER. Включает специальный режим обработки нажатий клавиш для выявления ввода GS (group separator).

  • LAZY [WEAK | STRONG] [WAIT | NOWAIT]

    Указание для свойства уровня кэширования (значение свойства кэшируется на сервере приложений, если чтение идет для всех фиксированных параметров). WEAK и STRONG определяют, что очищается из кэша при изменении свойства. WEAK означает, что при любом изменении, от которого зависит свойство, очищаются все его закэшированные значения. STRONG означает, что кэш будет очищаться не целиком при любом изменении свойства, а будет создаваться событие и будут очищаться конкретные значения. Требует, чтобы множество измененных значений было перечислимым. По умолчанию WEAK. WAIT и NOWAIT определяют, когда происходит инвалидация кэша. При WAIT инвалидация синхронна с применением изменения: после применения изменения ни одно чтение не вернет из кэша предыдущее значение. Используйте для свойств, на основе значений которых логика принимает решения (например, проверка существования объекта по уникальному значению). При NOWAIT инвалидация отложена и выполняется периодически (период задается настройкой flushAsyncValuesCaches, по умолчанию 1 секунда), поэтому короткое время после изменения чтения могут возвращать предыдущее значение. Используйте там, где такое кратковременное устаревание безвредно. По умолчанию NOWAIT. Для STRONG инвалидация всегда синхронна, поэтому NOWAIT с ним указать нельзя.

  • EXTID extId

    Указание имени, которое будет использоваться для экспорта / импорта свойства при добавлении на форму. По действию аналогично указанию опции EXTID в блоке свойств инструкции FORM, которая может его переопределить.

    • extId

      Строковый литерал.

Примеры​

// cвойство задано контекстно-независимым оператором-свойством DATA
cost 'Стоимость' (i) = DATA NUMERIC[12,3] (Item);

// cвойство задано выражением
weightedSum 'Взвешенная сумма' (a, b) = 2*a + 3*b;

// заголовком этого свойства будет 'diff', а параметрами - (a, b)
diff = a - b;

// свойство задано оператором DATA с указанием дополнительных опций свойства
teamName 'Название команды' = DATA BPSTRING[30](Team) IN baseGroup TABLE team;