Package com._1c.g5.v8.dt.core.navigator.order.index

Interface INavigatorOrderDescription

  • All Known Implementing Classes:
    NavigatorOrderDescription
    public interface INavigatorOrderDescription
    An abstract description of objects order in the navigator.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Set<String> getFeaturesWithOrder()
      Returns the set of feature names the objects order was specified for.
      int getObjectIndex​(String featureName, long bmObjectId)
      Returns the index of the object with the given bm id among siblings for the given feature.
      int getObjectIndex​(String featureName, org.eclipse.emf.ecore.EObject object)
      Returns the index of the given object among siblings for the given feature.
      Map<Long,​Integer> getObjectsOrder​(String featureName)
      Returns the navigator objects order associated with the given feature.
      void setObjectOrder​(String featureName, long bmObjectId, int orderIndex)
      Sets the navigator objects order associated with the given feature for the specified child object.
      void setObjectsOrder​(String featureName, Map<Long,​Integer> objectsOrder)
      Sets the navigator objects order associated with the given feature.

    • Method Detail

      • getObjectsOrder

        Map<Long,​Integer> getObjectsOrder​(String featureName)
        Returns the navigator objects order associated with the given feature.
        Parameters:
        featureName - the feature name to get feature value objects order for, cannot be null
        Returns:
        the objects order, never null

      • getObjectIndex

        int getObjectIndex​(String featureName,
                   long bmObjectId)
        Returns the index of the object with the given bm id among siblings for the given feature.
        Parameters:
        featureName - the feature name to get feature value objects order for, cannot be null
        bmObjectId - the bm object id to get index for, cannot be null
        Returns:
        the index among siblings or -1 if there is no object with the given id

      • getObjectIndex

        int getObjectIndex​(String featureName,
                   org.eclipse.emf.ecore.EObject object)
        Returns the index of the given object among siblings for the given feature.
        Parameters:
        featureName - the feature name to get feature value objects order for, cannot be null
        object - the given object to get index for, cannot be null
        Returns:
        the index among siblings or -1 if there is no object with the given id

      • setObjectsOrder

        void setObjectsOrder​(String featureName,
                     Map<Long,​Integer> objectsOrder)
        Sets the navigator objects order associated with the given feature.
        Parameters:
        featureName - the feature name to update feature value objects order for, cannot be null
        objectsOrder - a new objects order, cannot be null

      • setObjectOrder

        void setObjectOrder​(String featureName,
                    long bmObjectId,
                    int orderIndex)
        Sets the navigator objects order associated with the given feature for the specified child object.
        Parameters:
        featureName - the feature name to update feature value objects order for, cannot be null
        bmObjectId - the child object bm id to set index for
        orderIndex - a new order index for the specified child object

      • getFeaturesWithOrder

        Set<String> getFeaturesWithOrder()
        Returns the set of feature names the objects order was specified for.
        Returns:
        the set of feature names, never null