Package com.microstrategy.web.objects.rw

Interface RWControl

    • Method Detail

      • getKey

        java.lang.String getKey()
        Returns control key
        Returns:
        control key

      • getTargetCount

        int getTargetCount()
        Returns number of control targets
        Returns:
        number of control targets

      • getTarget

        RWUnitDef getTarget​(int i)
        Returns i-th target
        Parameters:
        i - index
        Returns:
        i-th target

      • getGroupByTargetKeys

        java.lang.String[] getGroupByTargetKeys()
        Returns array of target control group by keys
        Since:
        MicroStrategy Web 9.0.1

      • getTargets

        java.util.Enumeration getTargets()
        Returns enumeration over all control targets
        Returns:
        enumeration over all control targets

      • addDatasetTarget

        void addDatasetTarget​(java.lang.String did)
        Adds specified data set as this control target
        Parameters:
        did - of data set

      • addDatasetTarget

        void addDatasetTarget​(java.lang.String did,
                      int sourceType)
        Adds specified data set as this control target
        Parameters:
        did - of data set
        sourceType - of the data set

      • removeDatasetTarget

        void removeDatasetTarget​(java.lang.String did)
        removes specified data set as this control target
        Parameters:
        did - of data set

      • hasDatasetTarget

        boolean hasDatasetTarget​(java.lang.String did)
        Checks if specified data set is a this control's target
        Parameters:
        did - of data set
        Returns:
        true if the data set is present among this control targets

      • getDatasetTargets

        java.util.List<java.lang.String> getDatasetTargets()
        Get all control data sets targets

      • removeAllDatasetTargets

        void removeAllDatasetTargets()
        Remove all control data sets targets

      • setTargetType

        void setTargetType​(int value)
        Set target type is document(0)/data set(1)
        Parameters:
        target - type

      • getTargetType

        int getTargetType()
        Get Target type
        Returns:
        target type

      • removeTarget

        void removeTarget​(java.lang.String key)
           throws WebObjectsException
        Removes specified unit from control targets
        Parameters:
        key - target unit key
        Throws:
        WebObjectsException

      • hasTarget

        boolean hasTarget​(java.lang.String key)
        Checks if specified unit is a this control's target
        Parameters:
        key - unit key
        Returns:
        true if the unit is present among this control targets

      • canMultiSelect

        boolean canMultiSelect()
        Returns true if this control supports multi-select mode
        Returns:
        true if this control supports multi-select mode

      • isShowAll

        boolean isShowAll()
        Returns true if the show all option is on
        Returns:
        true if the show all option is on

      • setShowAll

        void setShowAll​(boolean value)
        Sets show all option
        Parameters:
        value - show all option

      • getKeyContext

        java.lang.String getKeyContext()
        Returns the control key in the server-specific format. This method is used to optimize the Set Current Element events as this key format allows executing these events without reloading document defintion.
        Returns:
        the control key in the server-specific format

      • canUseSubtotals

        boolean canUseSubtotals()
        Since:
        MicroStrategy Web 9.0.0

      • getSubtotals

        RWSubtotals getSubtotals()
        Since:
        MicroStrategy Web 9.0.0

      • hasTargets

        boolean hasTargets()
        Returns true if the given selector has targets. Please notice that because of partial display functionality it is possible that the getTarget(int) method will return 0 event if this method returns true.
        Since:
        MicroStrategy Web 9.0.1

      • isUnset

        boolean isUnset()
        Since:
        MicroStrategy Web 9.0.1

      • addPlaceHolderTarget

        void addPlaceHolderTarget​(java.lang.String key,
                          java.util.Set<java.lang.Integer> indices)
                   throws WebObjectsException
        Add the specified place holder as the control target.
        Parameters:
        key - node key of the template where the place holder is defined on
        indices - set of place holder indices to be added
        Throws:
        WebObjectsException

      • removePlaceHolderTarget

        void removePlaceHolderTarget​(java.lang.String key,
                             java.util.Set<java.lang.Integer> indices)
        Remove the specified place holder from the control targets.
        Parameters:
        key - node key of the template where the place holder is defined on
        index - set of place holder indices to be removed

      • getPlaceHolderTargets

        java.util.Map<java.lang.String,​java.util.Set<java.lang.Integer>> getPlaceHolderTargets()
        Returns the place holders targeted by this control.
        Returns:
        An immutable collection of place holders, which maps the template node key to a set of place holder indices

      • getPlaceHolderGroupByTargetKeys

        java.lang.String[] getPlaceHolderGroupByTargetKeys()
        Returns an array of group by target keys for the place holders.
        Returns:
        An array of place holder group by target keys.

      • getTransactionAction

        int getTransactionAction()
        return transactionAction EnumDSSXMLTransactionAction
        Returns:
        transactionAction EnumDSSXMLTransactionAction

      • getParent

        RWUnitDef getParent()
        Returns:
        parent

      • setInfoWindowTarget

        void setInfoWindowTarget​(java.lang.String targetKey)
                  throws java.lang.IllegalArgumentException
        Set the specified panel stack as the control information window target
        Parameters:
        targetKey - node key of target information window
        Throws:
        java.lang.IllegalArgumentException

      • getInfoWindowTarget

        java.lang.String getInfoWindowTarget()
        Get information window target
        Returns:
        information window target key

      • generateGridControlFormatDelta

        void generateGridControlFormatDelta()
        generate the delta for grid control format

      • setTopMost

        void setTopMost​(boolean _isTopMost)
        set isTopMost property
        Parameters:
        _isTopMost -

      • isTopMost

        boolean isTopMost()
        return isTopMost