java.lang.Object | ||||
↳ | com.microstrategy.web.transform.AbstractTransform | |||
↳ | com.microstrategy.web.transform.AbstractLayoutTransform | |||
↳ | com.microstrategy.web.app.transforms.AbstractAppTransform | |||
↳ | com.microstrategy.web.app.transforms.VisualizationPropertiesTransform |
![]() |
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String | FP_COLOR_PICKER_NAME | Constant specifying the name of the formal parameter for defining the id of a system picker that contains the possible color options. |
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
protected ReportBean | _rb | ||||||||||
protected RWBean | _rwb | ||||||||||
protected WebTemplate | _template | ||||||||||
protected ViewBean | _vb | ||||||||||
protected FormalParameter | colorPickerName |
[Expand]
Inherited Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
VisualizationPropertiesTransform()
Default no-argument constructor.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String |
getDescription()
Returns a textual description of the transform.
| ||||||||||
String |
getStyleShellDiv()
Returns the
style (that is, the style attribute
used for css formatting) of the shell's div. | ||||||||||
void |
initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform, such as width and height. | ||||||||||
boolean | isRW() | ||||||||||
void |
renderCheckbox(MarkupOutput out, String propName, String extraAttributes, String defaultValue)
Renders a checkbox.
| ||||||||||
void |
renderCheckbox(MarkupOutput out, String propName, HashList<String, String> extraAttributes, String defaultValue)
Renders a checkbox.
| ||||||||||
void |
renderCheckbox(MarkupOutput out, String propName, HashList<String, String> extraAttributes)
Renders a checkbox.
| ||||||||||
void |
renderCheckbox(MarkupOutput out, String propName, String extraAttributes)
Renders a checkbox.
| ||||||||||
void |
renderCheckbox(MarkupOutput out, String propName)
Renders a checkbox.
| ||||||||||
void |
renderColorPicker(MarkupOutput out, String propName, String defaultValue)
Renders a color picker
| ||||||||||
void |
renderColorPicker(MarkupOutput out, String propName)
Renders a color picker
| ||||||||||
void |
renderHiddenInput(MarkupOutput out, String propName, String extraAttributes)
Renders a hidden input that represents a property that is to be persisted in the Visualization properties
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
| ||||||||||
void |
renderHiddenInput(MarkupOutput out, String propName)
Renders a hidden input that represents a property that is to be persisted in the Visualization properties
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
| ||||||||||
void |
renderHiddenInput(MarkupOutput out, String propName, String value, HashList<String, String> extraAttributes)
Renders a hidden input that represents a property that is to be persisted in the Visualization properties
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
| ||||||||||
void |
renderRadio(MarkupOutput out, String propName, HashList<String, String> elems, HashList<String, String> extraAttributes, String defaultValue)
Renders Radio buttons that represents a property that is to be persisted in the Visualization properties
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
| ||||||||||
void |
renderRadio(MarkupOutput out, String propName, String elems, String extraAttributes, String defaultValue)
Renders Radio buttons that represents a property that is to be persisted in the Visualization properties
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
| ||||||||||
void |
renderRadio(MarkupOutput out, String propName, HashList<String, String> elems)
Renders Radio buttons that represents a property that is to be persisted in the Visualization properties
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
| ||||||||||
void |
renderRadio(MarkupOutput out, String propName, HashList<String, String> elems, HashList<String, String> extraAttributes)
Renders Radio buttons that represents a property that is to be persisted in the Visualization properties
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
| ||||||||||
void |
renderRadio(MarkupOutput out, String propName, String elems)
Renders Radio buttons that represents a property that is to be persisted in the Visualization properties
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
| ||||||||||
void |
renderRadio(MarkupOutput out, String propName, String elems, String extraAttributes)
Renders Radio buttons that represents a property that is to be persisted in the Visualization properties
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
| ||||||||||
void |
renderSecondaryDataProvidersSelectbox(MarkupOutput out, String propName)
Renders a select box with the list of templates on the document excluding the one that tghe visualization is applied to.
| ||||||||||
void |
renderSelectBox(MarkupOutput out, String propName, HashList<String, String> elems)
Renders a select box that represents a property that is to be persisted in the Visualization properties
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
| ||||||||||
void |
renderSelectBox(MarkupOutput out, String propName, HashList<String, String> elems, HashList<String, String> extraAttributes)
Renders a select box that represents a property that is to be persisted in the Visualization properties
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
| ||||||||||
void |
renderSelectBox(MarkupOutput out, String propName, String elems)
Renders a select box that represents a property that is to be persisted in the Visualization properties
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
| ||||||||||
void |
renderSelectBox(MarkupOutput out, String propName, String elems, String extraAttributes, String defaultValue)
Renders a select box that represents a property that is to be persisted in the Visualization properties
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
| ||||||||||
void |
renderSelectBox(MarkupOutput out, String propName, HashList<String, String> elems, HashList<String, String> extraAttributes, String defaultValue)
Renders a select box that represents a property that is to be persisted in the Visualization properties
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
| ||||||||||
void |
renderSelectBox(MarkupOutput out, String propName, String elems, String extraAttributes)
Renders a select box that represents a property that is to be persisted in the Visualization properties
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
| ||||||||||
void |
renderTabs(MarkupOutput out, String tabNames)
Renders a collection of tabs for the editor
| ||||||||||
void |
renderTextarea(MarkupOutput out, String propName, HashList<String, String> extraAttributes, String defaultValue)
Renders a textarea input.
| ||||||||||
void |
renderTextarea(MarkupOutput out, String propName, String extraAttributes)
Renders a text input.
| ||||||||||
void |
renderTextarea(MarkupOutput out, String propName, String extraAttributes, String defaultValue)
Renders a textarea input.
| ||||||||||
void |
renderTextarea(MarkupOutput out, String propName, HashList<String, String> extraAttributes)
Renders a textarea input.
| ||||||||||
void |
renderTextarea(MarkupOutput out, String propName)
Renders a textarea input.
| ||||||||||
void |
renderTextbox(MarkupOutput out, String propName, HashList<String, String> extraAttributes, String defaultValue)
Renders a text input.
| ||||||||||
void |
renderTextbox(MarkupOutput out, String propName, HashList<String, String> extraAttributes)
Renders a text input.
| ||||||||||
void |
renderTextbox(MarkupOutput out, String propName)
Renders a text input.
| ||||||||||
void |
renderTextbox(MarkupOutput out, String propName, String extraAttributes, String defaultValue)
Renders a text input.
| ||||||||||
void |
renderTextbox(MarkupOutput out, String propName, String extraAttributes)
Renders a text input.
| ||||||||||
void |
transformForRequestSuccessful(MarkupOutput out)
Generates the output when the bean's status is
WebBeanRequestSuccessful . |
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
ShortcutList |
getColorPicker()
Returns the color picker.
| ||||||||||
VisualizationPropertiesEditorBean | getEditorBean() | ||||||||||
HashList<String, String> | getHashListFromString(String elems) | ||||||||||
String | getTemplateName(RWGridGraphDef def) | ||||||||||
String | getVisPropValue(String propName) | ||||||||||
WebTemplate | getWebTemplate() | ||||||||||
boolean | isDescriptor(String value) | ||||||||||
boolean |
isDialog()
Defines whether this Transform should behave as a dialog (for example, a pop-up window).
| ||||||||||
boolean |
isOpen()
Defines whether this Transform is currently visible to the end user.
| ||||||||||
void |
renderColorDropdown(MarkupOutput out, String cmdId, String cmdValue, ShortcutList picker)
This method renders a single dropdown to be used with a color picker
| ||||||||||
void |
renderJavascript(MarkupOutput out)
This method renders all javascript that will be necessary for the Transform to work correctly.
| ||||||||||
void |
setBoneProperties(JsonGenerator boneProps)
Sets the necessary properties to the bone assigned to this transform (based on the
scriptClass formal parameter) Usually called by renderRegisterBone(MarkupOutput) Can be overwritten to add or modify bone properties. | ||||||||||
void | setExtraAttributesOnInput(HashList<String, String> extraAttributes, Tag input) |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() |
Constant specifying the name of the formal parameter for defining the id of a system picker that contains the possible color options. Value is colorPickerName.
Default no-argument constructor. Initializes formal parameters.
Returns a textual description of the transform.
Returns the style
(that is, the style attribute
used for css formatting) of the shell's div.
This method initialize the private and protected fields of the transform, such as
width and height.
It also invokes the initializeWebComponent
, initializeImages
and initializeCss
methods.
transform
method. Transforms which
would like to invoke other methods in this instance directly (for example, to invoke
some render methods), need first to call this method to
guarantee that the Transform is ready to generate output.data | the bean to transform. |
---|
Renders a checkbox.
Assumes the true value is "1"
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
out | The Markup output of this transform |
---|---|
propName | the name of the property to render and read the value from |
extraAttributes | A list with value/name pairs of extra attributes to add to the input. The format is "onclick^alert('a')|onchange^alert('b')" |
defaultValue | the default value for the textbox. Used if the property is not saved. |
Renders a checkbox.
Assumes the true value is "1"
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
out | The Markup output of this transform |
---|---|
propName | the name of the property to render and read the value from |
extraAttributes | A HashList with value/name pairs of extra attributes to add to the input. |
defaultValue | the default value for the textbox. Used if the property is not saved. |
Renders a checkbox.
Assumes the true value is "1"
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
out | The Markup output of this transform |
---|---|
propName | the name of the property to render and read the value from |
extraAttributes | A HashList with value/name pairs of extra attributes to add to the input. |
Renders a checkbox.
Assumes the true value is "1"
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
out | The Markup output of this transform |
---|---|
propName | the name of the property to render and read the value from |
extraAttributes | A list with value/name pairs of extra attributes to add to the input. The format is "onclick^alert('a')|onchange^alert('b')" |
Renders a checkbox.
Assumes the true value is "1"
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
out | The Markup output of this transform |
---|---|
propName | the name of the property to render and read the value from |
Renders a color picker
out | The Markup output of this transform |
---|---|
propName | the name of the property to render and read the value from |
defaultValue | the default value in case the property is not saved. (i.e. #FFFFFF) |
Renders a color picker
out | The Markup output of this transform |
---|---|
propName | the name of the property to render and read the value from |
Renders a hidden input that represents a property that is to be persisted in the Visualization properties Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
out | The Markup output of this transform |
---|---|
propName | the name of the property to render and read the value from |
extraAttributes | A list with value/name pairs of extra attributes to add to the input. The format is "onclick^alert('a')|onchange^alert('b')" |
Renders a hidden input that represents a property that is to be persisted in the Visualization properties Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
out | The Markup output of this transform |
---|---|
propName | the name of the property to render and read the value from |
Renders a hidden input that represents a property that is to be persisted in the Visualization properties Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
out | The Markup output of this transform |
---|---|
propName | the name of the property to render and read the value from |
value | the input's value |
extraAttributes | A HashList with value/name pairs of extra attributes to add to the input. |
Renders Radio buttons that represents a property that is to be persisted in the Visualization properties Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
out | The Markup output of this transform |
---|---|
propName | the name of the property to render and read the value from |
elems | A HashList with value/name pairs to display as the Radio buttons |
extraAttributes | A HashList with value/name pairs of extra attributes to add to the input. |
defaultValue | the default value for the radio button. Used if the property is not saved. |
Renders Radio buttons that represents a property that is to be persisted in the Visualization properties Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
out | The Markup output of this transform |
---|---|
propName | the name of the property to render and read the value from |
elems | A String that represents the values to render as radio buttons. The format is "0^Red|1^Blue|2^Yellow" |
extraAttributes | A list with value/name pairs of extra attributes to add to the input. The format is "onclick^alert('a')|onchange^alert('b')" |
defaultValue | the default value for the radio button. Used if the property is not saved. |
Renders Radio buttons that represents a property that is to be persisted in the Visualization properties Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
out | The Markup output of this transform |
---|---|
propName | the name of the property to render and read the value from |
elems | A HashList with value/name pairs to display as Radio buttons |
Renders Radio buttons that represents a property that is to be persisted in the Visualization properties Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
out | The Markup output of this transform |
---|---|
propName | the name of the property to render and read the value from |
elems | A HashList with value/name pairs to display as the Radio buttons |
extraAttributes | A HashList with value/name pairs of extra attributes to add to the input. |
Renders Radio buttons that represents a property that is to be persisted in the Visualization properties Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
out | The Markup output of this transform |
---|---|
propName | the name of the property to render and read the value from |
elems | A String that represents the values to render as Radio buttons. The format is "0^Red|1^Blue|2^Yellow" |
Renders Radio buttons that represents a property that is to be persisted in the Visualization properties Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
out | The Markup output of this transform |
---|---|
propName | the name of the property to render and read the value from |
elems | A String that represents the values to render as radio buttons. The format is "0^Red|1^Blue|2^Yellow" |
extraAttributes | A list with value/name pairs of extra attributes to add to the input. The format is "onclick^alert('a')|onchange^alert('b')" |
Renders a select box with the list of templates on the document excluding the one that tghe visualization is applied to. The selected template key will be saved as a secondary data provider as well as a visualization property named "propName"
out | The Markup output of this transform |
---|---|
propName | the name of the property to render and read the value from |
Renders a select box that represents a property that is to be persisted in the Visualization properties Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
out | The Markup output of this transform |
---|---|
propName | the name of the property to render and read the value from |
elems | A HashList with value/name pairs that represents the values to render on the select box. |
Renders a select box that represents a property that is to be persisted in the Visualization properties Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
out | The Markup output of this transform |
---|---|
propName | the name of the property to render and read the value from |
elems | A HashList with value/name pairs that represents the values to render on the select box. |
extraAttributes | A HashList with value/name pairs of extra attributes to add to the input. |
Renders a select box that represents a property that is to be persisted in the Visualization properties Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
out | The Markup output of this transform |
---|---|
propName | the name of the property to render and read the value from |
elems | A String that represents the values to render on the select box. The format is "0^Red|1^Blue|2^Yellow" |
Renders a select box that represents a property that is to be persisted in the Visualization properties Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
out | The Markup output of this transform |
---|---|
propName | the name of the property to render and read the value from |
elems | A String that represents the values to render on the select box. The format is "0^Red|1^Blue|2^Yellow" |
extraAttributes | A list with value/name pairs of extra attributes to add to the input. The format is "onclick^alert('a')|onchange^alert('b')" |
defaultValue | the default value for the selectbox. Used if the property is not saved. |
Renders a select box that represents a property that is to be persisted in the Visualization properties Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
out | The Markup output of this transform |
---|---|
propName | the name of the property to render and read the value from |
elems | A HashList with value/name pairs that represents the values to render on the select box. |
extraAttributes | A HashList with value/name pairs of extra attributes to add to the input. |
defaultValue | the default value for the selectbox. Used if the property is not saved. |
Renders a select box that represents a property that is to be persisted in the Visualization properties Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
out | The Markup output of this transform |
---|---|
propName | the name of the property to render and read the value from |
elems | A String that represents the values to render on the select box. The format is "0^Red|1^Blue|2^Yellow" |
extraAttributes | A list with value/name pairs of extra attributes to add to the input. The format is "onclick^alert('a')|onchange^alert('b')" |
Renders a collection of tabs for the editor
out | The Markup output of this transform |
---|---|
tabNames | a comma separated list of tabs to display |
Renders a textarea input.
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
out | The Markup output of this transform |
---|---|
propName | the name of the property to render and read the value from |
extraAttributes | A HashList with value/name pairs of extra attributes to add to the input. |
defaultValue | the default value for the Textarea. Used if the property is not saved. |
Renders a text input.
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
out | The Markup output of this transform |
---|---|
propName | the name of the property to render and read the value from |
extraAttributes | A HashList with value/name pairs of extra attributes to add to the input. |
Renders a textarea input.
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
out | The Markup output of this transform |
---|---|
propName | the name of the property to render and read the value from |
extraAttributes | A list with value/name pairs of extra attributes to add to the input. The format is "onclick^alert('a')|onchange^alert('b')" |
defaultValue | the default value for the Textarea. Used if the property is not saved. |
Renders a textarea input.
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
out | The Markup output of this transform |
---|---|
propName | the name of the property to render and read the value from |
extraAttributes | A HashList with value/name pairs of extra attributes to add to the input. |
Renders a textarea input.
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
out | The Markup output of this transform |
---|---|
propName | the name of the property to render and read the value from |
Renders a text input.
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
out | The Markup output of this transform |
---|---|
propName | the name of the property to render and read the value from |
extraAttributes | A HashList with value/name pairs of extra attributes to add to the input. |
defaultValue | the default value for the textbox. Used if the property is not saved. |
Renders a text input.
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
out | The Markup output of this transform |
---|---|
propName | the name of the property to render and read the value from |
extraAttributes | A HashList with value/name pairs of extra attributes to add to the input. |
Renders a text input.
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
out | The Markup output of this transform |
---|---|
propName | the name of the property to render and read the value from |
Renders a text input.
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
out | The Markup output of this transform |
---|---|
propName | the name of the property to render and read the value from |
extraAttributes | A list with value/name pairs of extra attributes to add to the input. The format is "onclick^alert('a')|onchange^alert('b')" |
defaultValue | the default value for the textbox. Used if the property is not saved. |
Renders a text input.
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value
out | The Markup output of this transform |
---|---|
propName | the name of the property to render and read the value from |
extraAttributes | A HashList with value/name pairs of extra attributes to add to the input. |
Generates the output when the bean's status is
WebBeanRequestSuccessful
.
This is the main entry point to generate the output for those Transforms that
just want to render the "regular" bean case.
This is an abstract method. All classes need to implement it.
out | output by this transform |
---|
Returns the color picker.
If a non-null instance have been registered
through the setColorPicker
method, it will return that one,
otherwise, it will search for a system picker with the name specified in
FP_COLOR_PICKER_NAME
.
propName | The property name |
---|
Defines whether this Transform should behave as a dialog (for example, a pop-up window).
Defines whether this Transform is currently visible to the end user.
This method renders a single dropdown to be used with a color picker
out | MarkupOutput where the content should be generated |
---|---|
cmdId | the dropdown's command id |
cmdValue | the dropdown's current command value. |
picker | the ShortcutList for the picker. |
This method renders all javascript that will be necessary for the Transform to work correctly.
out | The MarkupOutput object to render the output to. |
---|
Sets the necessary properties to the bone assigned to this transform (based on the scriptClass
formal parameter)
Usually called by renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.
boneProps | the JsonGenerator object that contains the collection of bone properties. |
---|