Package com.microstrategy.web.objects

Class WebVisualizationSettingsImpl

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addToList​(java.lang.String item)
      Adds the given visualization to the list.
      void clearList()
      Clears the visualization list.
      protected java.lang.String generateAbbreviation()  
      java.lang.String getFileName()
      Returns the file name (e.g. swf file) that corresponds to the selected visualization.
      java.lang.String getImage()
      The image to be used by this visualization
      int getMode()
      Returns the visualization mode.
      java.lang.String getProps()
      The visualization properties
      java.lang.String getSelectedAndroidTabletVisualization()
      Returns the currently selected visualization for Android Tablet.
      java.lang.String getSelectedAndroidVisualization()
      Returns the currently selected visualization for Android.
      java.lang.String getSelectedIPadVisualization()
      Returns the currently selected visualization for the ipad
      java.lang.String getSelectedIPhoneVisualization()
      Returns the currently selected visualization for the iphone.
      java.lang.String getSelectedVisualization()
      Returns the currently selected visualization.
      java.lang.String[] getVisualizationsList()
      Returns a list of the currently activated visualizations.
      boolean isEnabled()
      Returns whether visualizations are enabled on this object.
      void removeFromList​(java.lang.String item)
      Removes the given visualization from the list.
      void setEnabled​(boolean enabled)
      Sets whether visualizations are enabled.
      void setFileName​(java.lang.String val)
      Sets the file name (e.g. swf file) that corresponds to the selected visualization.
      void setImage​(java.lang.String image)
      The image to be used by this visualization
      void setIncludeMDProps​(java.lang.String includeMDProps)
      Whether to include the MD properties on the XML passed to the visualization
      void setMode​(int mode)
      Sets the visualization mode.
      void setProps​(java.lang.String val)
      The visualization properties
      void setSelectedAndroidTabletVisualization​(java.lang.String val)
      Sets the currently selected visualization.
      void setSelectedAndroidVisualization​(java.lang.String val)
      Sets the currently selected visualization.
      void setSelectedIPadVisualization​(java.lang.String val)
      Sets the currently selected visualization.
      void setSelectedIPhoneVisualization​(java.lang.String val)
      Sets the currently selected visualization.
      void setSelectedVisualization​(java.lang.String val)
      Sets the currently selected visualization.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • getMode

        public int getMode()
        Description copied from interface: WebVisualizationSettings
        Returns the visualization mode. If this is 0, then the visualization mode is off. If it is nonzero, then the visualization mode is the value returned. It is up to the API user to define the meanings of the various visualization modes.
        Returns:
        The current visualization mode.

      • setMode

        public void setMode​(int mode)
        Description copied from interface: WebVisualizationSettings
        Sets the visualization mode.
        Parameters:
        mode - The new visualization mode.

      • isEnabled

        public boolean isEnabled()
        Description copied from interface: WebVisualizationSettings
        Returns whether visualizations are enabled on this object.
        Returns:
        Whether visualizations are enabled or not.

      • setEnabled

        public void setEnabled​(boolean enabled)
        Description copied from interface: WebVisualizationSettings
        Sets whether visualizations are enabled.
        Parameters:
        enabled - True if the visualizations should be enabled, false otherwise.

      • getSelectedVisualization

        public java.lang.String getSelectedVisualization()
        Description copied from interface: WebVisualizationSettings
        Returns the currently selected visualization.
        Returns:
        The currently selected visualization.

      • setSelectedVisualization

        public void setSelectedVisualization​(java.lang.String val)
        Description copied from interface: WebVisualizationSettings
        Sets the currently selected visualization. It is recommended that this be one of the object from the visualization list returned from getVisualizationsList.
        Parameters:
        val - The selected visualization.

      • getSelectedIPhoneVisualization

        public java.lang.String getSelectedIPhoneVisualization()
        Description copied from interface: WebVisualizationSettings
        Returns the currently selected visualization for the iphone.
        Returns:
        The currently selected visualization for the iphone.

      • setSelectedIPhoneVisualization

        public void setSelectedIPhoneVisualization​(java.lang.String val)
        Description copied from interface: WebVisualizationSettings
        Sets the currently selected visualization. It is recommended that this be one of the object from the visualization list returned from getVisualizationsList.
        Parameters:
        val - The selected visualization.

      • getSelectedIPadVisualization

        public java.lang.String getSelectedIPadVisualization()
        Description copied from interface: WebVisualizationSettings
        Returns the currently selected visualization for the ipad
        Returns:
        The currently selected visualization for the ipad

      • setSelectedIPadVisualization

        public void setSelectedIPadVisualization​(java.lang.String val)
        Description copied from interface: WebVisualizationSettings
        Sets the currently selected visualization. It is recommended that this be one of the object from the visualization list returned from getVisualizationsList.
        Parameters:
        val - The selected visualization.

      • getSelectedAndroidVisualization

        public java.lang.String getSelectedAndroidVisualization()
        Description copied from interface: WebVisualizationSettings
        Returns the currently selected visualization for Android.
        Returns:
        The currently selected visualization for Android.

      • setSelectedAndroidVisualization

        public void setSelectedAndroidVisualization​(java.lang.String val)
        Description copied from interface: WebVisualizationSettings
        Sets the currently selected visualization. It is recommended that this be one of the object from the visualization list returned from getVisualizationsList.
        Parameters:
        val - The selected visualization.

      • getSelectedAndroidTabletVisualization

        public java.lang.String getSelectedAndroidTabletVisualization()
        Description copied from interface: WebVisualizationSettings
        Returns the currently selected visualization for Android Tablet.
        Returns:
        The currently selected visualization for Android Tablet.

      • setSelectedAndroidTabletVisualization

        public void setSelectedAndroidTabletVisualization​(java.lang.String val)
        Description copied from interface: WebVisualizationSettings
        Sets the currently selected visualization. It is recommended that this be one of the object from the visualization list returned from getVisualizationsList.
        Parameters:
        val - The selected visualization.

      • getFileName

        public java.lang.String getFileName()
        Description copied from interface: WebVisualizationSettings
        Returns the file name (e.g. swf file) that corresponds to the selected visualization.
        Returns:
        the file name (e.g. swf file) that corresponds to the selected visualization.
        Since:
        MicroStrategy Web 8.1.0

      • setFileName

        public void setFileName​(java.lang.String val)
        Description copied from interface: WebVisualizationSettings
        Sets the file name (e.g. swf file) that corresponds to the selected visualization.
        Parameters:
        val - the file name (e.g. swf file) that corresponds to the selected visualization.
        Since:
        MicroStrategy Web 8.1.0

      • setIncludeMDProps

        public void setIncludeMDProps​(java.lang.String includeMDProps)
        Description copied from interface: WebVisualizationSettings
        Whether to include the MD properties on the XML passed to the visualization

      • setImage

        public void setImage​(java.lang.String image)
        The image to be used by this visualization
        Parameters:
        image - The image to be used by this visualization

      • getImage

        public java.lang.String getImage()
        The image to be used by this visualization
        Parameters:
        image - The image to be used by this visualization

      • getProps

        public java.lang.String getProps()
        Description copied from interface: WebVisualizationSettings
        The visualization properties

      • setProps

        public void setProps​(java.lang.String val)
        Description copied from interface: WebVisualizationSettings
        The visualization properties
        Parameters:
        val - The visualization properties

      • addToList

        public void addToList​(java.lang.String item)
        Description copied from interface: WebVisualizationSettings
        Adds the given visualization to the list.
        Parameters:
        item - The visualization to add to the list.

      • removeFromList

        public void removeFromList​(java.lang.String item)
        Description copied from interface: WebVisualizationSettings
        Removes the given visualization from the list.
        Parameters:
        item - The visualization to remove from the list.

      • clearList

        public void clearList()
        Description copied from interface: WebVisualizationSettings
        Clears the visualization list.

      • getVisualizationsList

        public java.lang.String[] getVisualizationsList()
        Description copied from interface: WebVisualizationSettings
        Returns a list of the currently activated visualizations.
        Returns:
        A String[] containing the names of the activated visualizations.

      • generateAbbreviation

        protected java.lang.String generateAbbreviation()