| java.lang.Object | |
| ↳ | com.microstrategy.web.objects.RWUnitVisualizationSettingsImpl |
Summary
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| protected WebFormat | format | ||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| RWUnitVisualizationSettingsImpl(WebFormat _format) | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| void |
addToList(String item)
Adds the given visualization to the list.
| ||||||||||
| void |
clearList()
Clears the visualization list.
| ||||||||||
| String |
getFileName()
Returns the file name (e.g.
| ||||||||||
| String |
getImage()
The image to be used by this visualization
| ||||||||||
| int |
getMode()
Returns the visualization mode.
| ||||||||||
| String |
getProps()
The visualization properties
| ||||||||||
| String |
getSelectedAndroidTabletVisualization()
Returns the currently selected visualization for Android Tablet.
| ||||||||||
| String |
getSelectedAndroidVisualization()
Returns the currently selected visualization for Android.
| ||||||||||
| String |
getSelectedIPadVisualization()
Returns the currently selected visualization for the ipad
| ||||||||||
| String |
getSelectedIPhoneVisualization()
Returns the currently selected visualization for the iphone.
| ||||||||||
| String |
getSelectedVisualization()
Returns the currently selected visualization.
| ||||||||||
| String[] |
getVisualizationsList()
Returns a list of the currently activated visualizations.
| ||||||||||
| boolean |
isEnabled()
Returns whether visualizations are enabled on this object.
| ||||||||||
| void |
removeFromList(String item)
Removes the given visualization from the list.
| ||||||||||
| void |
setEnabled(boolean enabled)
Sets whether visualizations are enabled.
| ||||||||||
| void |
setFileName(String val)
Sets the file name (e.g.
| ||||||||||
| void |
setImage(String image)
The image to be used by this visualization
| ||||||||||
| void |
setIncludeMDProps(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(String value)
The visualization properties
| ||||||||||
| void |
setSelectedAndroidTabletVisualization(String val)
Sets the currently selected visualization.
| ||||||||||
| void |
setSelectedAndroidVisualization(String val)
Sets the currently selected visualization.
| ||||||||||
| void |
setSelectedIPadVisualization(String val)
Sets the currently selected visualization.
| ||||||||||
| void |
setSelectedIPhoneVisualization(String val)
Sets the currently selected visualization.
| ||||||||||
| void |
setSelectedVisualization(String val)
Sets the currently selected visualization.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
|
From interface
com.microstrategy.web.objects.WebVisualizationSettings
| |||||||||||
Fields
Public Constructors
Public Methods
public void addToList (String item)
Adds the given visualization to the list.
Parameters
| item | The visualization to add to the list. |
|---|
public void clearList ()
Clears the visualization list.
public String getFileName ()
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.
public String getImage ()
The image to be used by this visualization
public int getMode ()
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.
public String getProps ()
The visualization properties
public String getSelectedAndroidTabletVisualization ()
Returns the currently selected visualization for Android Tablet.
Returns
- The currently selected visualization for Android Tablet.
public String getSelectedAndroidVisualization ()
Returns the currently selected visualization for Android.
Returns
- The currently selected visualization for Android.
public String getSelectedIPadVisualization ()
Returns the currently selected visualization for the ipad
Returns
- The currently selected visualization for the ipad
public String getSelectedIPhoneVisualization ()
Returns the currently selected visualization for the iphone.
Returns
- The currently selected visualization for the iphone.
public String getSelectedVisualization ()
Returns the currently selected visualization.
Returns
- The currently selected visualization.
public String[] getVisualizationsList ()
Returns a list of the currently activated visualizations.
Returns
- A String[] containing the names of the activated visualizations.
public boolean isEnabled ()
Returns whether visualizations are enabled on this object.
Returns
- Whether visualizations are enabled or not.
public void removeFromList (String item)
Removes the given visualization from the list.
Parameters
| item | The visualization to remove from the list. |
|---|
public void setEnabled (boolean enabled)
Sets whether visualizations are enabled.
Parameters
| enabled | True if the visualizations should be enabled, false otherwise. |
|---|
public void setFileName (String val)
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. |
|---|
public void setImage (String image)
The image to be used by this visualization
Parameters
| image | The image to be used by this visualization |
|---|
public void setIncludeMDProps (String includeMDProps)
Whether to include the MD properties on the XML passed to the visualization
public void setMode (int mode)
Sets the visualization mode.
Parameters
| mode | The new visualization mode. |
|---|
public void setProps (String value)
The visualization properties
Parameters
| value | The visualization properties |
|---|
public void setSelectedAndroidTabletVisualization (String val)
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. |
|---|
public void setSelectedAndroidVisualization (String val)
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. |
|---|
public void setSelectedIPadVisualization (String val)
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. |
|---|
public void setSelectedIPhoneVisualization (String val)
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. |
|---|
public void setSelectedVisualization (String val)
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. |
|---|