3.5.4.2. Стандартные действия

Стандартные действия, предлагаемые платформой, предназначены для решения типовых задач, таких как вызов экрана редактирования для сущности, выбранной в таблице. Стандартные действия можно объявлять в XML-дескрипторе экрана, просто указав их тип в атрибуте type, к примеру:

<!-- in a table -->
<action type="create"/>

<!-- in a PickerField -->
<action id="lookup" type="picker_lookup"/>

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

Существует два вида стандартных действий:

В своих проектах вы можете создавать похожие действия или переопределять существующие стандартные типы.

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

  1. Создайте для действия отдельный класс с аннотацией @ActionType, в которой укажите желаемое имя типа:

    package com.company.sample.web.actions;

import com.haulmont.cuba.core.entity.Entity;
import com.haulmont.cuba.core.global.MetadataTools;
import com.haulmont.cuba.gui.ComponentsHelper;
import com.haulmont.cuba.gui.Notifications;
import com.haulmont.cuba.gui.components.ActionType;
import com.haulmont.cuba.gui.components.Component;
import com.haulmont.cuba.gui.components.actions.ItemTrackingAction;

import javax.inject.Inject;

@ActionType("showSelected")
public class ShowSelectedAction extends ItemTrackingAction {

    @Inject
    private MetadataTools metadataTools;

    public ShowSelectedAction(String id) {
        super(id);
        setCaption("Show Selected");
    }

    @Override
    public void actionPerform(Component component) {
        Entity selected = getTarget().getSingleSelected();
        if (selected != null) {
            Notifications notifications = ComponentsHelper.getScreenContext(target).getNotifications();
            notifications.create()
                    .setType(Notifications.NotificationType.TRAY)
                    .setCaption(metadataTools.getInstanceName(selected))
                    .show();
        }
    }
}

  2. В файле web-spring.xml добавьте элемент <gui:actions>, и в его атрибуте base-packages укажите пакет, в котором нужно искать ваши аннотированные действия:

    <beans ... xmlns:gui="http://schemas.haulmont.com/cuba/spring/cuba-gui.xsd">
    <!-- ... -->
    <gui:actions base-packages="com.company.sample.web.actions"/>
</beans>

  3. Теперь вы можете использовать действие в дескрипторах экрана, просто указывая его тип:

    <groupTable id="customersTable">
    <actions>
        <action id="show" type="showSelected"/>
    </actions>
    <columns>
        <!-- ... -->
    </columns>
    <buttonsPanel>
        <button action="customersTable.show"/>
    </buttonsPanel>
</groupTable>