Interface WebDisplayUnit

    • Method Detail

      • getID

        java.lang.String getID()
        Returns the DSS ID of the display unit.
        Returns:
        The ID of the display unit.
      • hasDetails

        boolean hasDetails()
        Returns whether this display unit currently has details enabled.
        Returns:
        True if details are enabled, false otherwise.
      • addDetails

        void addDetails​(boolean details)
                 throws WebObjectsException
        This method will add or remove details from the display unit. Note that this call may generate a call to the Intelligence Server if the details are not already present for the display unit.
        Parameters:
        details - The desired state of details for the display unit.
        Throws:
        WebObjectsException - Thrown if the details cannot be retrieved from the Intelligence Server.
      • isHighlighted

        boolean isHighlighted()
        Returns whether this unit is highlighted.
        Returns:
        True if the display unit is highlighted, false otherwise.
      • highlightUnit

        void highlightUnit()
        Sets this display unit to be highlighted. This call will ensure that details are not present for the highlighted unit.
      • highlightUnit

        void highlightUnit​(boolean details)
                    throws WebObjectsException
        Sets this display unit to be highlighted. The details value will determine whether it should include details as well.
        Parameters:
        details - Whether the highlighted unit should include details.
        Throws:
        WebObjectsException - Thrown if the details for a highlighted unit cannot be retrieved from the Intelligence Server.
      • isSelected

        boolean isSelected()
        Returns whether this display unit is selected.
        Returns:
        True if the unit is selected, false otherwise.
      • setSelected

        void setSelected​(boolean selected)
        Sets the current unit's selection status.
        Parameters:
        selected - Whether the unit should be set to be selected or not.
      • getDisplayName

        java.lang.String getDisplayName()
        Returns the display name associated with this object. If this was not set by the user or found in the object XML, then this will be equivalent to the name property of the underlying object.
        Returns:
        The display name associated with the display unit object.
        See Also:
        setDisplayName(java.lang.String), WebObjectInfo.getName()
      • setDisplayName

        void setDisplayName​(java.lang.String displayName)
        This method will set the value of the display name. This name will be used to identify the object in display XML. Setting this value will have no affect on the actual name of the object.
        Parameters:
        displayName - The display name to associate with the object.
        See Also:
        getDisplayName(), WebObjectInfo.getName()
      • isObjectInfo

        boolean isObjectInfo()
        Returns true if underlying Web Object can be cast to WebObjectInfo. If an object can be cast to WebObjectInfo, then it is a first class object.
        Returns:
        true if underlying Web Object can be cast to WebObjectInfo.
      • getChildUnits

        WebDisplayUnits getChildUnits()
                               throws WebObjectsException
        Returns the collection of child display units, or null if the object is not a collection. Note that several display units are actually collections of display units as well.
        Returns:
        The collection of child display units of this instance, or null if this object is not a collection.
        Throws:
        WebObjectsException
      • canHighlight

        boolean canHighlight()
        Since:
        MicroStrategy Web 8.0.0