Package io.jmix.ui.screen

Interface EditorScreen<T>

Type Parameters:
T - type of entity
All Superinterfaces:
ChangeTracker
All Known Implementing Classes:
AdditionalBusinessDayEdit, BusinessCalendarEdit, CandidateGroupsEdit, CandidateUsersEdit, CategoryAttrsEdit, CategoryEdit, ContentStorageEdit, DashboardGroupEdit, DecisionDetailsScreen, DmnDecisionTableEdit, EmailAttachmentEdit, EmailTemplateAttachmentEdit, EntityAttributeEdit, EntityAttributeResourcePolicyModelEdit, EntityInspectorEditor, EntityResourcePolicyModelEdit, ErrorDefinitionEdit, EventListenerEdit, ExecutionListenerEdit, ExtensionPropertyEdit, FieldEdit, FilterConditionEdit, FormFieldEdit, FormOutcomeEdit, FormParamEdit, FullTextFilterConditionEdit, GraphQLResourcePolicyModelEdit, GroupFilterConditionEdit, HolidayEdit, ImapMailBoxEdit, ImapMessageEdit, InAppNotificationEdit, InAppNotificationView, InOutBindingModelEdit, InputDefinitionEdit, JobDataEdit, JobModelEdit, JpqlFilterConditionEdit, JpqlParameterEdit, JsonEmailTemplateEdit, LogicalFilterConditionEdit, MBeanAttributeEditor, MBeanInspectScreen, MenuResourcePolicyModelEdit, MessageDefinitionEdit, OutputDefinitionEdit, ParameterEdit, ParameterEditor, PersistentDashboardEdit, PivotTableAggregationEdit, PivotTablePropertyEdit, ProcessDefinitionEdit, ProcessInstanceEdit, ProcessVariableEdit, PropertyFilterConditionEdit, QueryParameterEditor, RegionEditor, ReportEditor, ReportEmailTemplateEdit, ReportGroupEditor, ResourcePolicyModelEdit, ResourceRoleModelEdit, RowLevelPolicyModelEdit, RowLevelRoleModelEdit, ScheduledBusinessDayEdit, ScreenResourcePolicyModelEdit, SignalDefinitionEdit, SpecificResourcePolicyModelEdit, StandardEditor, TaskListenerEdit, TemplateBlockEdit, TemplateBlockGroupEdit, TemplateEditor, TemplateGroupEdit, TenantEdit, TriggerModelEdit, UserGroupEdit, UserSubstitutionEdit, ValueFormatEditor, VariableInstanceDataEdit, WebdavDocumentCollectionEdit, WebdavShowDocumentVersionEdit, WidgetEdit, WidgetTemplateEdit, WidgetTemplateGroupEdit
public interface EditorScreen<T> extends ChangeTracker
Interface for editor screen controllers.

  • Field Details

    • WINDOW_COMMIT

      static final String WINDOW_COMMIT
      Name of action that commits changes.
      If the screen doesn't contain a component with WINDOW_COMMIT_AND_CLOSE ID, this action also closes the screen after commit.
      See Also:

    • WINDOW_COMMIT_AND_CLOSE

      static final String WINDOW_COMMIT_AND_CLOSE
      Name of action that commits changes and closes the screen.
      See Also:

    • WINDOW_CLOSE

      static final String WINDOW_CLOSE
      Name of action that closes the screen.
      See Also:

    • ENABLE_EDITING

      static final String ENABLE_EDITING
      Name of action that enables screen editing, i.e. sets the 'readOnly' mode to false.
      See Also:

  • Method Details

    • setEntityToEdit

      void setEntityToEdit(T entity)
      Sets entity instance to editor.
      Parameters:
      entity - entity

    • getEditedEntity

      T getEditedEntity()
      Returns:
      currently edited entity instance

    • isLocked

      boolean isLocked()
      Returns:
      true if the edited item has been pessimistically locked when the screen is opened