com.haulmont.cuba.gui.settings

Interface Settings

All Known Implementing Classes:

SettingsImpl

public interface Settings

Interface defining methods for working with screen settings.

Screen settings are saved in the database for the current user.

See Also:

AbstractWindow.getSettings(), AbstractWindow.applySettings(Settings)

Method Summary

Modifier and Type	Method and Description
void	commit() INTERNAL.
void	delete() INTERNAL.
org.dom4j.Element	get()
org.dom4j.Element	get(java.lang.String componentId)
void	setModified(boolean modified) INTERNAL.

Method Detail

get

@Nonnull
org.dom4j.Element get()

Returns:

root element of the screen settings. Never null.

get

@Nonnull
org.dom4j.Element get(java.lang.String componentId)

Returns:

an element of the screen settings for the given component. Never null. For example:

     getSettings().get(hintBox.getId()).addAttribute("visible", "false");
 

setModified

void setModified(boolean modified)

INTERNAL. The lifecycle of settings is controlled by the framework.

commit

void commit()

INTERNAL. The lifecycle of settings is controlled by the framework.

delete

void delete()

INTERNAL. The lifecycle of settings is controlled by the framework.