View (Ametys 4.2.x

java.lang.Object
- org.ametys.runtime.model.View

All Implemented Interfaces:: ViewItemContainer, Labelable, ModifiableLabelable

public class View
extends Object
implements ViewItemContainer, ModifiableLabelable

View of items

Field Summary

Fields
Modifier and Type	Field and Description
`private I18nizableText`	`_description`
`private String`	`_iconDecorator`
`private String`	`_iconGlyph`
`private List<ViewItem>`	`_items`
`private I18nizableText`	`_label`
`private String`	`_largeIcon`
`private String`	`_mediumIcon`
`private String`	`_name`
`private String`	`_smallIcon`

Constructor Summary

Constructors
Constructor and Description
`View()` Default constructor
`View(Model model, boolean recursive, String... itemPaths)` Creates a view with the given items
`View(Model model, String... itemPaths)` Creates a view with the given items

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private ViewItem`	`_getViewItemFromDefinition(ModelItem definition, Boolean recursive)`
`void`	`addViewItem(ViewItem item)` Add a view item in the container
`I18nizableText`	`getDescription()` Retrieves the description.
`String`	`getIconDecorator()` Retrieves the CSS class to use for decorator above the main icon
`String`	`getIconGlyph()` Retrieves the CSS class to use for glyph icon
`I18nizableText`	`getLabel()` Retrieves the label.
`String`	`getLargeIcon()` Retrieves the URL of the small icon without the context path.
`String`	`getMediumIcon()` Retrieves the URL of the small icon without the context path.
`String`	`getName()` Get the name.
`String`	`getSmallIcon()` Retrieves the URL of the small icon without the context path.
`List<ViewItem>`	`getViewItems()` Retrieves all the view items of this container
`boolean`	`hasViewItem(String itemName)` Checks if there is a view item with the given name
`void`	`includeView(View viewToInclude)` Include the given view to the current one.
`void`	`insertViewItem(ViewItem item, int index)` Insert a view item in the container at the given index
`void`	`setDescription(I18nizableText description)` Set the description.
`void`	`setIconDecorator(String iconDecorator)` Set the CSS class to use for decorator above the main icon
`void`	`setIconGlyph(String iconGlyph)` Set the CSS class to use for glyph icon
`void`	`setLabel(I18nizableText label)` Set the label.
`void`	`setLargeIcon(String largeIcon)` Set the URL of the large icon.
`void`	`setMediumIcon(String mediumIcon)` Set the URL of the medium icon.
`void`	`setName(String name)` Set the name.
`void`	`setSmallIcon(String smallIcon)` Set the URL of the small icon.
`Map<String,Object>`	`toJSON()` Converts the view in a JSON map

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

- Field Detail
  - _name
```
private String _name
```
  - _label
```
private I18nizableText _label
```
  - _description
```
private I18nizableText _description
```
  - _iconGlyph
```
private String _iconGlyph
```
  - _iconDecorator
```
private String _iconDecorator
```
  - _smallIcon
```
private String _smallIcon
```
  - _mediumIcon
```
private String _mediumIcon
```
  - _largeIcon
```
private String _largeIcon
```
  - _items
```
private List<ViewItem> _items
```
- Constructor Detail
  - View
```
public View()
```
    Default constructor
  - View
```
public View(Model model,
            String... itemPaths)
```
    Creates a view with the given items
    
    Parameters:
    
    model - the model containing items definitions
    
    itemPaths - the paths of the items to put in the view
  - View
```
public View(Model model,
            boolean recursive,
            String... itemPaths)
```
    Creates a view with the given items
    
    Parameters:
    
    model - the model containing items definitions
    
    recursive - if true, will create view items for groups children
    
    itemPaths - the paths of the items to put in the view
- Method Detail
  - _getViewItemFromDefinition
```
private ViewItem _getViewItemFromDefinition(ModelItem definition,
                                            Boolean recursive)
```
  - getName
```
public String getName()
```
    Description copied from interface: Labelable
    
    Get the name.
    
    Specified by:
    
    getName in interface Labelable
    
    Returns:
    
    the name.
  - setName
```
public void setName(String name)
```
    Description copied from interface: ModifiableLabelable
    
    Set the name.
    
    Specified by:
    
    setName in interface ModifiableLabelable
    
    Parameters:
    
    name - the name.
  - getLabel
```
public I18nizableText getLabel()
```
    Description copied from interface: Labelable
    
    Retrieves the label.
    
    Specified by:
    
    getLabel in interface Labelable
    
    Returns:
    
    the label.
  - setLabel
```
public void setLabel(I18nizableText label)
```
    Description copied from interface: ModifiableLabelable
    
    Set the label.
    
    Specified by:
    
    setLabel in interface ModifiableLabelable
    
    Parameters:
    
    label - the label.
  - getDescription
```
public I18nizableText getDescription()
```
    Description copied from interface: Labelable
    
    Retrieves the description.
    
    Specified by:
    
    getDescription in interface Labelable
    
    Returns:
    
    the description.
  - setDescription
```
public void setDescription(I18nizableText description)
```
    Description copied from interface: ModifiableLabelable
    
    Set the description.
    
    Specified by:
    
    setDescription in interface ModifiableLabelable
    
    Parameters:
    
    description - the description.
  - getIconGlyph
```
public String getIconGlyph()
```
    Retrieves the CSS class to use for glyph icon
    
    Returns:
    
    the glyph name.
  - setIconGlyph
```
public void setIconGlyph(String iconGlyph)
```
    Set the CSS class to use for glyph icon
    
    Parameters:
    
    iconGlyph - the glyph name.
  - getIconDecorator
```
public String getIconDecorator()
```
    Retrieves the CSS class to use for decorator above the main icon
    
    Returns:
    
    the glyph name.
  - setIconDecorator
```
public void setIconDecorator(String iconDecorator)
```
    Set the CSS class to use for decorator above the main icon
    
    Parameters:
    
    iconDecorator - the glyph name.
  - getSmallIcon
```
public String getSmallIcon()
```
    Retrieves the URL of the small icon without the context path.
    
    Returns:
    
    the icon URL for the small image 16x16.
  - setSmallIcon
```
public void setSmallIcon(String smallIcon)
```
    Set the URL of the small icon.
    
    Parameters:
    
    smallIcon - the URL of the small icon, without the context path.
  - getMediumIcon
```
public String getMediumIcon()
```
    Retrieves the URL of the small icon without the context path.
    
    Returns:
    
    the icon URL for the medium sized image 32x32.
  - setMediumIcon
```
public void setMediumIcon(String mediumIcon)
```
    Set the URL of the medium icon.
    
    Parameters:
    
    mediumIcon - the URL of the medium icon, without the context path.
  - getLargeIcon
```
public String getLargeIcon()
```
    Retrieves the URL of the small icon without the context path.
    
    Returns:
    
    the icon URL for the large image 48x48.
  - setLargeIcon
```
public void setLargeIcon(String largeIcon)
```
    Set the URL of the large icon.
    
    Parameters:
    
    largeIcon - the URL of the large icon, without the context path.
  - getViewItems
```
public List<ViewItem> getViewItems()
```
    Description copied from interface: ViewItemContainer
    
    Retrieves all the view items of this container
    
    Specified by:
    
    getViewItems in interface ViewItemContainer
    
    Returns:
    
    the view items
  - hasViewItem
```
public boolean hasViewItem(String itemName)
```
    Description copied from interface: ViewItemContainer
    
    Checks if there is a view item with the given name
    
    Specified by:
    
    hasViewItem in interface ViewItemContainer
    
    Parameters:
    
    itemName - the name of the item
    
    Returns:
    
    true if the container contains an item with the given name, false otherwise
  - addViewItem
```
public void addViewItem(ViewItem item)
```
    Description copied from interface: ViewItemContainer
    
    Add a view item in the container
    
    Specified by:
    
    addViewItem in interface ViewItemContainer
    
    Parameters:
    
    item - the item to add
  - insertViewItem
```
public void insertViewItem(ViewItem item,
                           int index)
```
    Description copied from interface: ViewItemContainer
    
    Insert a view item in the container at the given index
    
    Specified by:
    
    insertViewItem in interface ViewItemContainer
    
    Parameters:
    
    item - the item to insert
    
    index - index at which the item has to be inserted
  - toJSON
```
public Map<String,Object> toJSON()
                          throws ProcessingException
```
    Converts the view in a JSON map
    
    Returns:
    
    The view as a JSON map
    
    Throws:
    
    ProcessingException - If an error occurs when converting the view
  - includeView
```
public void includeView(View viewToInclude)
```
    Include the given view to the current one. Add the items of the view to include if they are not already present in the current view
    
    Parameters:
    
    viewToInclude - the view to include

Class View

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_name

_label

_description

_iconGlyph

_iconDecorator

_smallIcon

_mediumIcon

_largeIcon

_items

Constructor Detail

View

View

View

Method Detail

_getViewItemFromDefinition

getName

setName

getLabel

setLabel

getDescription

setDescription

getIconGlyph

setIconGlyph

getIconDecorator

setIconDecorator

getSmallIcon

setSmallIcon

getMediumIcon

setMediumIcon

getLargeIcon

setLargeIcon

getViewItems

hasViewItem

addViewItem

insertViewItem

toJSON

includeView