Class EmptyGroupElementHandle


  • public class EmptyGroupElementHandle
    extends GroupElementHandle
    Implements an empty group element handle, which actually can do nothing.
    • Constructor Detail

      • EmptyGroupElementHandle

        public EmptyGroupElementHandle()
    • Method Detail

      • allExtendedElements

        protected boolean allExtendedElements()
        Description copied from class: GroupElementHandle
        Checks if all elements have extends parents or virtual parents.
        Specified by:
        allExtendedElements in class GroupElementHandle
        Returns:
        true If all elements have extend parents or virtual parents. Otherwise false;
      • getElements

        public java.util.List getElements()
        Description copied from class: GroupElementHandle
        Returns the list that contains the group of design elements. Contents of it is DesignElementHandle
        Specified by:
        getElements in class GroupElementHandle
        Returns:
        the list that contains the group of design elements.
      • isSameType

        public boolean isSameType()
        Description copied from class: GroupElementHandle
        Indicates that if the given elements are of the same definition. Elements are considered of same type if their element definitions are identical.

        If elements have different definitions. Even the same element type, the return value is false. For example, if the list contains an OdaDataSource and a OdaDataSource, this method returns false.

        Specified by:
        isSameType in class GroupElementHandle
        Returns:
        true if the given elements are of the same type; return false if elements are of different element types, or the given list is empty, or the list contains any object that is not an instance of DesignElementHandle.
      • getCommonProperties

        public java.util.List getCommonProperties()
        Description copied from class: GroupElementHandle
        Returns the common properties shared by the given group of elements(including user properties). Contents of the list is element property definitions. If elements do not share any common property, return an empty list.
        Specified by:
        getCommonProperties in class GroupElementHandle
        Returns:
        the common properties shared by the given group of elements. If elements do not share any common property, or the given list is empty, or the list contains any item that is not an instance of DesignElementHandle, return an empty list.
      • visiblePropertyIterator

        public java.util.Iterator visiblePropertyIterator()
        Description copied from class: GroupElementHandle
        Returns an iterator over the common properties that are visible. Contents of the iterator are handles to the common properties, type of them is GroupPropertyHandle. Note: remove is not support for the iterator.
        Specified by:
        visiblePropertyIterator in class GroupElementHandle
        Returns:
        an iterator over the common properties. Contents of the iterator are handles to the common properties, type of them is GroupPropertyHandle
      • isPropertyVisible

        protected boolean isPropertyVisible​(java.lang.String propName)
        Description copied from class: GroupElementHandle
        Checks whether a property is visible in the property sheet. The visible property is visible in all elements.
        Specified by:
        isPropertyVisible in class GroupElementHandle
        Parameters:
        propName - the property name
        Returns:
        true if it is visible. Otherwise false.
      • clearLocalProperties

        public void clearLocalProperties()
                                  throws SemanticException
        Description copied from class: GroupElementHandle
        Clears values of all common properties(except the extends property) for the given collection of elements. Clearing a property removes any value set for the property on this element. After this, the element will now inherit the property from its parent element, style, or from the default value for the property. Note: this method clear the values of local properties ( not include sub element)
        Specified by:
        clearLocalProperties in class GroupElementHandle
        Throws:
        SemanticException - if the property is not defined on this element
      • isExtendedElements

        public boolean isExtendedElements()
        Description copied from class: GroupElementHandle
        Returns true if each of the given collection of element extends has a parent. Returns false otherwise. If the collection has no elements, also return false
        Specified by:
        isExtendedElements in class GroupElementHandle
        Returns:
        true if each of the given collection of element extends has a parent. Returns false otherwise. If the collection has no elements, also return false
      • isPropertyReadOnly

        protected boolean isPropertyReadOnly​(java.lang.String propName)
        Description copied from class: GroupElementHandle
        Checks whether a property is read-only in the property sheet. The visible property is read-only in all elements.
        Specified by:
        isPropertyReadOnly in class GroupElementHandle
        Parameters:
        propName - the property name
        Returns:
        true if it is read-only. Otherwise false.
      • getPropertyHandle

        public GroupPropertyHandle getPropertyHandle​(java.lang.String propName)
        Description copied from class: GroupElementHandle
        If property is shared by the group of elements, return the corresponding GroupPropertyHandle, otherwise, return null.
        Specified by:
        getPropertyHandle in class GroupElementHandle
        Parameters:
        propName - name of the property needs to be handled.
        Returns:
        If the property is a common property among the elements, return the corresponding GroupPropertyHandle; Otherwise return null.
      • isInGroup

        protected boolean isInGroup​(DesignElementHandle element)
        Description copied from class: GroupElementHandle
        Checks whether the element is a member of GroupElementHandle.
        Specified by:
        isInGroup in class GroupElementHandle
        Parameters:
        element - the element to check
        Returns:
        true if the element is in the list, otherwise false.
      • clearLocalPropertiesIncludeSubElement

        public void clearLocalPropertiesIncludeSubElement()
                                                   throws SemanticException
        Description copied from class: GroupElementHandle
        Clears values of all common properties(except the extends property) for the given collection of elements. Clearing a property removes any value set for the property on this element. After this, the element will now inherit the property from its parent element, style, or from the default value for the property. Note: this method clear all the values of local properties (include sub element)
        Specified by:
        clearLocalPropertiesIncludeSubElement in class GroupElementHandle
        Throws:
        SemanticException - if the property is not defined on this element