View (Solibri Model Checker API 9.10.8.29 API)

```
public interface View
```
A View defines a custom view that can be shown in the software.

Since:

9.10.8

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default Icon`	`getIcon()` Returns the icon for the view.
`default String`	`getName()` The internationalized name of the view.
`String`	`getUniqueId()` The unique ID of the view.
`void`	`initializePanel(JPanel panel)` This method is used for initializing the contents inside the view.
`default void`	`onBasketSelectionChanged(Set<Component> oldSelection, Set<Component> newSelection)` Action to take when a the selection basket contents change.
`default void`	`onCheckingEnded()` Action to take when checking has finished.
`default void`	`onCheckingStarted()` Action to take when checking is about to start.
`default void`	`onComponentChosen(Component component)` Action to take when the user chooses a component from the UI.
`default void`	`onComponentsHidden(Collection<Component> components)` Action to take when the user zooms hides some components from the UI.
`default void`	`onComponentsZoomedTo(Collection<Component> components)` Action to take when the user zooms to some components from the UI.
`default void`	`onItoFinished()` Action to take when information takeoff has finished.
`default void`	`onItoStarted()` Action to take when information takeoff has been triggered.
`default void`	`onModelLoaded(Model model)` Action to take when a model is loaded to the software.
`default void`	`onSettingsChanged()` Action to take when the setting have been changed.

- Method Detail
  - getUniqueId
```
String getUniqueId()
```
    The unique ID of the view.
    
    Returns:
    
    the ID of the view
    
    Since:
    
    9.10.8
  - getName
```
default String getName()
```
    The internationalized name of the view. The default implementation returns value based on properties files value with key "NAME". Returns the ID of the view if no property is found.
    
    Returns:
    
    the name of the view
    
    Since:
    
    9.10.8
  - getIcon
```
default Icon getIcon()
```
    Returns the icon for the view. The default implementation tries to find icon from file called icon.png and uses that if it is found from the same package as the view. If icon.png does not exist, the properties file for the view is searched for property called ICON and the relative path given in that property is used.
    
    Returns:
    
    the icon
    
    Since:
    
    9.10.8
  - initializePanel
```
void initializePanel(JPanel panel)
```
    This method is used for initializing the contents inside the view. Everything in the view is contained inside a single JPanel. This method is called automatically when the view is being initialized.
    
    Parameters:
    
    panel - the parent JPanel that holds the contents
    
    Since:
    
    9.10.8
  - onModelLoaded
```
default void onModelLoaded(Model model)
```
    Action to take when a model is loaded to the software. The default implementation does nothing.
    
    Parameters:
    
    model - the model that has been loaded
    
    Since:
    
    9.10.8
  - onBasketSelectionChanged
```
default void onBasketSelectionChanged(Set<Component> oldSelection,
                                      Set<Component> newSelection)
```
    Action to take when a the selection basket contents change. The default implementation does nothing.
    
    Parameters:
    
    oldSelection - the components that were part of the old selection
    
    newSelection - the components that are part of the new selection
    
    Since:
    
    9.10.8
  - onCheckingStarted
```
default void onCheckingStarted()
```
    Action to take when checking is about to start. The default implementation does nothing.
    
    Since:
    
    9.10.8
  - onCheckingEnded
```
default void onCheckingEnded()
```
    Action to take when checking has finished. The default implementation does nothing.
    
    Since:
    
    9.10.8
  - onComponentChosen
```
default void onComponentChosen(Component component)
```
    Action to take when the user chooses a component from the UI. The default implementation does nothing.
    
    Parameters:
    
    component - the chosen component
    
    Since:
    
    9.10.8
  - onComponentsZoomedTo
```
default void onComponentsZoomedTo(Collection<Component> components)
```
    Action to take when the user zooms to some components from the UI. The default implementation does nothing.
    
    Parameters:
    
    components - the zoomed components
    
    Since:
    
    9.10.8
  - onComponentsHidden
```
default void onComponentsHidden(Collection<Component> components)
```
    Action to take when the user zooms hides some components from the UI. The default implementation does nothing.
    
    Parameters:
    
    components - the hidden components
    
    Since:
    
    9.10.8
  - onSettingsChanged
```
default void onSettingsChanged()
```
    Action to take when the setting have been changed. This makes it possible to implement hotloading of new settings in to the view updating the view contents dynamically as settings change. Note that this method being called does not guarantee that any setting actually changed its value. It just means that save action on some setting was triggered.
    
    Since:
    
    9.10.8
  - onItoStarted
```
default void onItoStarted()
```
    Action to take when information takeoff has been triggered. This will be usually called before the calculation is done, but there is no guarantee of that, since the call is asynchronous.
    
    Since:
    
    9.10.8
  - onItoFinished
```
default void onItoFinished()
```
    Action to take when information takeoff has finished.
    
    Since:
    
    9.10.8

Interface View

Method Summary

Method Detail

getUniqueId

getName

getIcon

initializePanel

onModelLoaded

onBasketSelectionChanged

onCheckingStarted

onCheckingEnded

onComponentChosen

onComponentsZoomedTo

onComponentsHidden

onSettingsChanged

onItoStarted

onItoFinished