io.jmix.ui.screen

Class ReadOnlyScreensSupport

java.lang.Object

io.jmix.ui.screen.ReadOnlyScreensSupport

@Component(value="ui_ReadOnlyScreensSupport")
public class ReadOnlyScreensSupport
extends java.lang.Object

Bean that encapsulates the default logic of changing screens read-only mode.

Field Summary

Fields

Modifier and Type	Field and Description
protected io.jmix.core.AccessManager	accessManager

Constructor Summary

Constructors

Constructor and Description
ReadOnlyScreensSupport()

Method Summary

Modifier and Type	Method and Description
protected boolean	isChangeComponentActionEnabled(Action action)
protected boolean	isChangeEditable(Component component)
protected boolean	isChangeOwnActionEnabled(Action action)
protected boolean	isEditableConsideringDataBinding(Component component, boolean editable)
void	secAccessManager(io.jmix.core.AccessManager accessManager)
void	setScreenReadOnly(Screen screen, boolean readOnly) Changes the read-only mode of the given screen.
void	setScreenReadOnly(Screen screen, boolean readOnly, boolean showEnableEditingBtn) Changes the read-only mode of the given screen.
protected void	updateActionsEnableState(java.util.Collection<Action> actions, boolean readOnly, java.util.function.Predicate<Action> shouldChangeEnabled)
protected void	updateComponentsEditableState(Screen screen, boolean readOnly)
protected void	updateOwnActionsEnableState(Screen screen, boolean readOnly)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

accessManager

protected io.jmix.core.AccessManager accessManager

Constructor Detail

ReadOnlyScreensSupport

public ReadOnlyScreensSupport()

Method Detail

secAccessManager

@Autowired
public void secAccessManager(io.jmix.core.AccessManager accessManager)

setScreenReadOnly

public void setScreenReadOnly(Screen screen,
                              boolean readOnly)

Changes the read-only mode of the given screen.

The following components and actions change their state:

• All Component.Editable components that has a not null ValueSource
• All Action.AdjustWhenScreenReadOnly actions obtained from ActionsHolder components
• All own screen actions except EditorScreen.WINDOW_CLOSE and EditorScreen.ENABLE_EDITING

Parameters:

screen - a screen to set the read-only mode

readOnly - whether a screen in the read-only mode

setScreenReadOnly

public void setScreenReadOnly(Screen screen,
                              boolean readOnly,
                              boolean showEnableEditingBtn)

Changes the read-only mode of the given screen.

The following components and actions change their state:

• All Component.Editable components that has a not null ValueSource
• All Action.AdjustWhenScreenReadOnly actions obtained from ActionsHolder components
• All own screen actions except EditorScreen.WINDOW_CLOSE and EditorScreen.ENABLE_EDITING

Parameters:

screen - a screen to set the read-only mode

readOnly - whether a screen in the read-only mode

showEnableEditingBtn - whether or not the EditorScreen.ENABLE_EDITING should be displayed in the read-only mode

updateComponentsEditableState

protected void updateComponentsEditableState(Screen screen,
                                             boolean readOnly)

isEditableConsideringDataBinding

protected boolean isEditableConsideringDataBinding(Component component,
                                                   boolean editable)

isChangeComponentActionEnabled

protected boolean isChangeComponentActionEnabled(Action action)

isChangeOwnActionEnabled

protected boolean isChangeOwnActionEnabled(Action action)

isChangeEditable

protected boolean isChangeEditable(Component component)

updateOwnActionsEnableState

protected void updateOwnActionsEnableState(Screen screen,
                                           boolean readOnly)

updateActionsEnableState

protected void updateActionsEnableState(java.util.Collection<Action> actions,
                                        boolean readOnly,
                                        java.util.function.Predicate<Action> shouldChangeEnabled)