TablePresentations (Jmix-ui 1.0 API)

All Known Implementing Classes:

TablePresentationsImpl
```
public interface TablePresentations
```
Provide the workflow with presentations (visual settings of a component).

A component must implement HasTablePresentations interface.

See Also:

TablePresentation

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`add(TablePresentation p)` Adds a new presentation
`void`	`addListener(PresentationsChangeListener listener)` Adds listener
`void`	`commit()` Commits all changes into the database
`TablePresentation`	`create()`
`java.lang.String`	`getCaption(java.lang.Object id)` Returns presentation caption by its id
`TablePresentation`	`getCurrent()` Returns the current active presentation or `null` if a current presentation didn't set
`TablePresentation`	`getDefault()` Returns a default presentation or `null` if it didn't set
`TablePresentation`	`getPresentation(java.lang.Object id)` Returns presentation by its id or `null` if a presentation doesn't exist
`TablePresentation`	`getPresentationByName(java.lang.String name)` Returns a presentation by its name with ignored case.
`java.util.Collection<java.lang.Object>`	`getPresentationIds()` Returns a collection of the component presentations
`java.lang.String`	`getSettingsString(TablePresentation p)`
`boolean`	`isAutoSave(TablePresentation p)` Returns `true` if the selected presentation has an `autoSave` settings else returns `false`
`boolean`	`isGlobal(TablePresentation p)` Returns `true` if the selected presentation is marked as global else returns `false`
`void`	`modify(TablePresentation p)` Modifies the selected presentation
`void`	`remove(TablePresentation p)` Removes a presentation from the list of available presentations
`void`	`removeListener(PresentationsChangeListener listener)` Removes listener
`void`	`setCurrent(TablePresentation p)` Sets current active presentation for a component
`void`	`setDefault(TablePresentation p)` Sets a default presentation
`void`	`setSettings(TablePresentation p, java.lang.String settings)` Sets user settings for the selected presentation

- Method Detail
  - getCurrent
```
@Nullable
TablePresentation getCurrent()
```
    Returns the current active presentation or null if a current presentation didn't set
  - setCurrent
```
void setCurrent(@Nullable
                TablePresentation p)
```
    Sets current active presentation for a component
  - getSettingsString
```
@Nullable
java.lang.String getSettingsString(TablePresentation p)
```
    Parameters:
    
    p - presentation
    
    Returns:
    
    user settings for the selected presentation or null if the presentation doesn't exist or if the presentation doesn't contain any settings
  - setSettings
```
void setSettings(TablePresentation p,
                 @Nullable
                 java.lang.String settings)
```
    Sets user settings for the selected presentation
    
    Parameters:
    
    p - presentation
    
    settings - user settings
  - getPresentation
```
@Nullable
TablePresentation getPresentation(java.lang.Object id)
```
    Returns presentation by its id or null if a presentation doesn't exist
  - getCaption
```
@Nullable
java.lang.String getCaption(java.lang.Object id)
```
    Returns presentation caption by its id
  - getPresentationIds
```
java.util.Collection<java.lang.Object> getPresentationIds()
```
    Returns a collection of the component presentations
  - getDefault
```
@Nullable
TablePresentation getDefault()
```
    Returns a default presentation or null if it didn't set
  - setDefault
```
void setDefault(@Nullable
                TablePresentation p)
```
    Sets a default presentation
  - add
```
void add(TablePresentation p)
```
    Adds a new presentation
  - remove
```
void remove(TablePresentation p)
```
    Removes a presentation from the list of available presentations
  - modify
```
void modify(TablePresentation p)
```
    Modifies the selected presentation
  - isAutoSave
```
boolean isAutoSave(TablePresentation p)
```
    Returns true if the selected presentation has an autoSave settings else returns false
  - isGlobal
```
boolean isGlobal(TablePresentation p)
```
    Returns true if the selected presentation is marked as global else returns false
  - commit
```
void commit()
```
    Commits all changes into the database
  - getPresentationByName
```
@Nullable
TablePresentation getPresentationByName(java.lang.String name)
```
    Returns a presentation by its name with ignored case. It returns null if a presentation with such name doesn't exist
  - addListener
```
void addListener(PresentationsChangeListener listener)
```
    Adds listener
  - removeListener
```
void removeListener(PresentationsChangeListener listener)
```
    Removes listener
  - create
```
TablePresentation create()
```
    Returns:
    
    presentation instance or stub if corresponding add-on is not added to the project

Interface TablePresentations

Method Summary

Method Detail

getCurrent

setCurrent

getSettingsString

setSettings

getPresentation

getCaption

getPresentationIds

getDefault

setDefault

add

remove

modify

isAutoSave

isGlobal

commit

getPresentationByName

addListener

removeListener

create