Package org.ametys.runtime.model

Interface ViewItemAccessor

All Known Subinterfaces:
ViewItemContainer, ViewItemGroup
All Known Implementing Classes:
AbstractViewItemGroup, ModelViewItemGroup, SimpleViewItemGroup, View, ViewElementAccessor
public interface ViewItemAccessor
Interface for objects that can access to some view items

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addViewItem(ViewItem item)
    Add a view item in the accessor
    default void
    addViewItems(List<ViewItem> items)
    Add view items in the accessor
    void
    clear()
    Removes all items of this accessor
    default ModelViewItem
    getModelViewItem(String itemName)
    Retrieves the model view item with the given name If there are more than one corresponding items, the first one is retrieved
    default ViewItem
    getViewItem(String itemName)
    Retrieves the view item with the given name If there are more than one corresponding items, the first one is retrieved
    List<ViewItem>
    getViewItems()
    Retrieves all the view items of this accessor
    default boolean
    hasModelViewItem(String itemName)
    Checks if there is a model view item with the given name
    default boolean
    hasModelViewItem(ModelViewItem item)
    Checks if the current ViewItemAccessor contains the given model view item Consider that the accessor contains the given item if it contains an item representing the same definition
    default boolean
    hasModelViewItem(ModelViewItem item, String currentAccessorPath, String itemPath)
    Checks if the current ViewItemAccessor contains the given model view item Consider that the accessor contains the given item if it contains an item representing the same definition AND with the same children if it is a group AND at the same position as the given path
    void
    insertViewItem(ViewItem item, int index)
    Insert a view item in the accessor at the given index
    boolean
    removeViewItem(ViewItem item)
    Removes the given items of this accessor

  • Method Details

    • getViewItems

      List<ViewItem> getViewItems()
      Retrieves all the view items of this accessor
      Returns:
      the view items

    • addViewItem

      void addViewItem(ViewItem item)
      Add a view item in the accessor
      Parameters:
      item - the item to add

    • insertViewItem

      void insertViewItem(ViewItem item, int index)
      Insert a view item in the accessor at the given index
      Parameters:
      item - the item to insert
      index - index at which the item has to be inserted

    • removeViewItem

      boolean removeViewItem(ViewItem item)
      Removes the given items of this accessor
      Parameters:
      item - the item to remove
      Returns:
      true if this accessor contained the given item, false otherwise

    • clear

      void clear()
      Removes all items of this accessor

    • addViewItems

      default void addViewItems(List<ViewItem> items)
      Add view items in the accessor
      Parameters:
      items - the items to add

    • hasModelViewItem

      default boolean hasModelViewItem(ModelViewItem item)
      Checks if the current ViewItemAccessor contains the given model view item Consider that the accessor contains the given item if it contains an item representing the same definition
      Parameters:
      item - the item
      Returns:
      true if the accessor contains the given item, false otherwise

    • hasModelViewItem

      default boolean hasModelViewItem(ModelViewItem item, String currentAccessorPath, String itemPath)
      Checks if the current ViewItemAccessor contains the given model view item Consider that the accessor contains the given item if it contains an item representing the same definition AND with the same children if it is a group AND at the same position as the given path
      Parameters:
      item - the item
      currentAccessorPath - The path of the current item accessor
      itemPath - the path of the item in the accessor
      Returns:
      true if the accessor contains the given item, false otherwise

    • hasModelViewItem

      default boolean hasModelViewItem(String itemName)
      Checks if there is a model view item with the given name
      Parameters:
      itemName - the name of the item
      Returns:
      true if the accessor can access to an item with the given name, false otherwise

    • getModelViewItem

      default ModelViewItem getModelViewItem(String itemName)
      Retrieves the model view item with the given name If there are more than one corresponding items, the first one is retrieved
      Parameters:
      itemName - the name of the item
      Returns:
      the model view item, or null if none was found

    • getViewItem

      default ViewItem getViewItem(String itemName)
      Retrieves the view item with the given name If there are more than one corresponding items, the first one is retrieved
      Parameters:
      itemName - the name of the item
      Returns:
      the view item, or null if none was found