TablePresentationsImpl (Jmix-ui 1.2 API)

java.lang.Object
- io.jmix.uidata.TablePresentationsImpl

All Implemented Interfaces:: TablePresentations

public class TablePresentationsImpl
extends java.lang.Object
implements TablePresentations

Field Summary

Fields
Modifier and Type	Field and Description
`protected TablePresentation`	`current`
`protected io.jmix.core.usersubstitution.CurrentUserSubstitution`	`currentUserSubstitution`
`protected io.jmix.core.DataManager`	`dataManager`
`protected TablePresentation`	`defaultPresentation`
`protected io.jmix.core.EntityStates`	`entityStates`
`protected io.jmix.core.FetchPlanRepository`	`fetchPlanRepository`
`protected java.util.List<PresentationsChangeListener>`	`listeners`
`protected io.jmix.core.Metadata`	`metadata`
`protected java.lang.String`	`name`
`protected java.util.Set<TablePresentation>`	`needToRemove`
`protected java.util.Set<TablePresentation>`	`needToUpdate`
`protected java.util.Map<java.lang.Object,TablePresentation>`	`presentations`

Constructor Summary

Constructors
Constructor and Description

TablePresentationsImpl(Component c)

Constructors
Constructor and Description
`TablePresentationsImpl(Component c)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(TablePresentation p)` Adds a new presentation
`void`	`addListener(PresentationsChangeListener listener)` Adds listener
`protected void`	`checkLoad()`
`protected void`	`clearCommitList()`
`void`	`commit()` Commits all changes into the database
`void`	`commited(java.util.Set entities)`
`TablePresentation`	`create()`
`protected void`	`fireCurrentPresentationChanged(java.lang.Object oldPresentationId)`
`protected void`	`fireDefaultPresentationChanged(java.lang.Object oldPresentationId)`
`protected void`	`firePresentationsSetChanged()`
`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
`protected void`	`persistDefaultPresentation(TablePresentation newDef)`
`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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - metadata
```
@Autowired
protected io.jmix.core.Metadata metadata
```
  - fetchPlanRepository
```
@Autowired
protected io.jmix.core.FetchPlanRepository fetchPlanRepository
```
  - dataManager
```
@Autowired
protected io.jmix.core.DataManager dataManager
```
  - currentUserSubstitution
```
@Autowired
protected io.jmix.core.usersubstitution.CurrentUserSubstitution currentUserSubstitution
```
  - entityStates
```
@Autowired
protected io.jmix.core.EntityStates entityStates
```
  - name
```
protected java.lang.String name
```
  - presentations
```
protected java.util.Map<java.lang.Object,TablePresentation> presentations
```
  - current
```
protected TablePresentation current
```
  - defaultPresentation
```
protected TablePresentation defaultPresentation
```
  - needToUpdate
```
protected java.util.Set<TablePresentation> needToUpdate
```
  - needToRemove
```
protected java.util.Set<TablePresentation> needToRemove
```
  - listeners
```
protected java.util.List<PresentationsChangeListener> listeners
```
- Constructor Detail
  - TablePresentationsImpl
```
public TablePresentationsImpl(Component c)
```
- Method Detail
  - add
```
public void add(TablePresentation p)
```
    Description copied from interface: TablePresentations
    
    Adds a new presentation
    
    Specified by:
    
    add in interface TablePresentations
  - getCurrent
```
public TablePresentation getCurrent()
```
    Description copied from interface: TablePresentations
    
    Returns the current active presentation or null if a current presentation didn't set
    
    Specified by:
    
    getCurrent in interface TablePresentations
  - setCurrent
```
public void setCurrent(@Nullable
                       TablePresentation p)
```
    Description copied from interface: TablePresentations
    
    Sets current active presentation for a component
    
    Specified by:
    
    setCurrent in interface TablePresentations
  - getSettingsString
```
public java.lang.String getSettingsString(TablePresentation p)
```
    Specified by:
    
    getSettingsString in interface TablePresentations
    
    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
```
public void setSettings(TablePresentation p,
                        @Nullable
                        java.lang.String settings)
```
    Description copied from interface: TablePresentations
    
    Sets user settings for the selected presentation
    
    Specified by:
    
    setSettings in interface TablePresentations
    
    Parameters:
    
    p - presentation
    
    settings - user settings
  - getPresentation
```
public TablePresentation getPresentation(java.lang.Object id)
```
    Description copied from interface: TablePresentations
    
    Returns presentation by its id or null if a presentation doesn't exist
    
    Specified by:
    
    getPresentation in interface TablePresentations
  - getCaption
```
public java.lang.String getCaption(java.lang.Object id)
```
    Description copied from interface: TablePresentations
    
    Returns presentation caption by its id
    
    Specified by:
    
    getCaption in interface TablePresentations
  - getPresentationIds
```
public java.util.Collection<java.lang.Object> getPresentationIds()
```
    Description copied from interface: TablePresentations
    
    Returns a collection of the component presentations
    
    Specified by:
    
    getPresentationIds in interface TablePresentations
  - setDefault
```
public void setDefault(@Nullable
                       TablePresentation p)
```
    Description copied from interface: TablePresentations
    
    Sets a default presentation
    
    Specified by:
    
    setDefault in interface TablePresentations
  - getDefault
```
public TablePresentation getDefault()
```
    Description copied from interface: TablePresentations
    
    Returns a default presentation or null if it didn't set
    
    Specified by:
    
    getDefault in interface TablePresentations
  - persistDefaultPresentation
```
protected void persistDefaultPresentation(@Nullable
                                          TablePresentation newDef)
```
  - remove
```
public void remove(TablePresentation p)
```
    Description copied from interface: TablePresentations
    
    Removes a presentation from the list of available presentations
    
    Specified by:
    
    remove in interface TablePresentations
  - modify
```
public void modify(TablePresentation p)
```
    Description copied from interface: TablePresentations
    
    Modifies the selected presentation
    
    Specified by:
    
    modify in interface TablePresentations
  - isAutoSave
```
public boolean isAutoSave(TablePresentation p)
```
    Description copied from interface: TablePresentations
    
    Returns true if the selected presentation has an autoSave settings else returns false
    
    Specified by:
    
    isAutoSave in interface TablePresentations
  - isGlobal
```
public boolean isGlobal(TablePresentation p)
```
    Description copied from interface: TablePresentations
    
    Returns true if the selected presentation is marked as global else returns false
    
    Specified by:
    
    isGlobal in interface TablePresentations
  - commit
```
public void commit()
```
    Description copied from interface: TablePresentations
    
    Commits all changes into the database
    
    Specified by:
    
    commit in interface TablePresentations
  - commited
```
public void commited(java.util.Set entities)
```
  - addListener
```
public void addListener(PresentationsChangeListener listener)
```
    Description copied from interface: TablePresentations
    
    Adds listener
    
    Specified by:
    
    addListener in interface TablePresentations
  - removeListener
```
public void removeListener(PresentationsChangeListener listener)
```
    Description copied from interface: TablePresentations
    
    Removes listener
    
    Specified by:
    
    removeListener in interface TablePresentations
  - getPresentationByName
```
public TablePresentation getPresentationByName(java.lang.String name)
```
    Description copied from interface: TablePresentations
    
    Returns a presentation by its name with ignored case. It returns null if a presentation with such name doesn't exist
    
    Specified by:
    
    getPresentationByName in interface TablePresentations
  - create
```
public TablePresentation create()
```
    Specified by:
    
    create in interface TablePresentations
    
    Returns:
    
    presentation instance or stub if corresponding add-on is not added to the project
  - fireCurrentPresentationChanged
```
protected void fireCurrentPresentationChanged(java.lang.Object oldPresentationId)
```
  - firePresentationsSetChanged
```
protected void firePresentationsSetChanged()
```
  - fireDefaultPresentationChanged
```
protected void fireDefaultPresentationChanged(@Nullable
                                              java.lang.Object oldPresentationId)
```
  - checkLoad
```
protected void checkLoad()
```
  - clearCommitList
```
protected void clearCommitList()
```

Class TablePresentationsImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

metadata

fetchPlanRepository

dataManager

currentUserSubstitution

entityStates

name

presentations

current

defaultPresentation

needToUpdate

needToRemove

listeners

Constructor Detail

TablePresentationsImpl

Method Detail

add

getCurrent

setCurrent

getSettingsString

setSettings

getPresentation

getCaption

getPresentationIds

setDefault

getDefault

persistDefaultPresentation

remove

modify

isAutoSave

isGlobal

commit

commited

addListener

removeListener

getPresentationByName

create

fireCurrentPresentationChanged

firePresentationsSetChanged

fireDefaultPresentationChanged

checkLoad

clearCommitList