Class VisualizationPropertiesTransform
- 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
-
- All Implemented Interfaces:
AppTransform
,LayoutTransform
,Transform
- Direct Known Subclasses:
ImageLayoutVisualizationPropertiesTransform
,ImageViewerVisualizationPropertiesTransform
,IPadTimeLineVisualizationPropertiesTransform
,IPhoneGridVisualizationPropertiesTransform
,IPhoneImageMapPropertiesTransform
,IPhoneMapVisualizationPropertiesTransform
,IPhoneMarkerMashupVisualizationPropertiesTransform
,IPhoneTimeSeriesEditorTransform
,MultiMediaVisualizationPropertiesTransform
,SurveyVisualizationPropertiesTransform
,TreePickerVisualizationPropertiesTransform
public class VisualizationPropertiesTransform extends AbstractAppTransform implements LayoutTransform
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
AbstractAppTransform.Context
-
-
Field Summary
Fields Modifier and Type Field Description protected ReportBean
_rb
protected RWBean
_rwb
protected WebTemplate
_template
protected ViewBean
_vb
protected FormalParameter
colorPickerName
static java.lang.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.-
Fields inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
_bean, _componentBlock, _cssPrefix, _imgBlank, _imgWait, _selfOutput, _subOutput, appliesTo, CLASS_INPUT, CLASS_MESSAGE, contextMenus, cssFile, cssPrefix, debugErrorFlags, debugFlags, dragMode, extraInput, extraUrl, FP_APPLIES_TO, FP_CONTEXT_MENUS, FP_CSS_ERROR_MESSAGE, FP_CSS_ERROR_TITLE, FP_CSS_FILE, FP_CSS_PREFIX, FP_DEBUG_ERROR_FLAGS, FP_DEBUG_FLAGS, FP_DRAG_MODE, FP_EXTRA_INPUT, FP_EXTRA_URL, FP_HEIGHT, FP_IFRAME_ENABLED, FP_IMG_WAIT, FP_INITIAL_INDENT, FP_ORIENTATION, FP_ORIENTATIONS_ALLOWED, FP_PARTIAL_IFRAME_UPDATE, FP_PROCESSING_BUTTONS_FLAGS, FP_PROCESSING_INFO_FLAGS, FP_RESIZE_LEVEL, FP_SCRIPT_CLASS, FP_TYPE, FP_USE_DHTML, FP_WIDTH, globalCssErrorMessage, globalCssErrorTitle, height, iframeEnabled, imgWait, indent, initialIndent, isDHTML, orientation, orientationsAllowed, partialIframeUpdate, PROCESSING_BUTTONS_ALL, PROCESSING_BUTTONS_CANCEL, PROCESSING_BUTTONS_HISTORY_LIST, PROCESSING_BUTTONS_REFRESH, PROCESSING_BUTTONS_VIEW_DETAILS, PROCESSING_INFO_ALL, PROCESSING_INFO_DESCRIPTION, PROCESSING_INFO_LAST_UPDATE, PROCESSING_INFO_NAME, PROCESSING_INFO_NONE, PROCESSING_INFO_STATUS, processingButtonsFlags, processingInfoFlags, RESIZE_ALL, RESIZE_HORIZONTAL, RESIZE_NONE, RESIZE_VERTICAL, resizeLevel, scriptClass, scriptEndTagEncoder, type, useDHTML, width
-
-
Constructor Summary
Constructors Constructor Description VisualizationPropertiesTransform()
Default no-argument constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected ShortcutList
getColorPicker()
Returns the color picker.java.lang.String
getDescription()
Returns a textual description of the transform.protected VisualizationPropertiesEditorBean
getEditorBean()
protected HashList<java.lang.String,java.lang.String>
getHashListFromString(java.lang.String elems)
java.lang.String
getStyleShellDiv()
Returns thestyle
(that is, the style attribute used for css formatting) of the shell's div.protected java.lang.String
getTemplateName(RWGridGraphDef def)
protected java.lang.String
getVisPropValue(java.lang.String propName)
protected WebTemplate
getWebTemplate()
void
initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform, such as width and height.protected boolean
isDescriptor(java.lang.String value)
protected boolean
isDialog()
Defines whether this Transform should behave as a dialog (for example, a pop-up window).protected boolean
isOpen()
Defines whether this Transform is currently visible to the end user.boolean
isRW()
void
renderCheckbox(MarkupOutput out, java.lang.String propName)
Renders a checkbox.void
renderCheckbox(MarkupOutput out, java.lang.String propName, HashList<java.lang.String,java.lang.String> extraAttributes)
Renders a checkbox.void
renderCheckbox(MarkupOutput out, java.lang.String propName, HashList<java.lang.String,java.lang.String> extraAttributes, java.lang.String defaultValue)
Renders a checkbox.void
renderCheckbox(MarkupOutput out, java.lang.String propName, java.lang.String extraAttributes)
Renders a checkbox.void
renderCheckbox(MarkupOutput out, java.lang.String propName, java.lang.String extraAttributes, java.lang.String defaultValue)
Renders a checkbox.protected void
renderColorDropdown(MarkupOutput out, java.lang.String cmdId, java.lang.String cmdValue, ShortcutList picker)
This method renders a single dropdown to be used with a color pickervoid
renderColorPicker(MarkupOutput out, java.lang.String propName)
Renders a color pickervoid
renderColorPicker(MarkupOutput out, java.lang.String propName, java.lang.String defaultValue)
Renders a color pickervoid
renderHiddenInput(MarkupOutput out, java.lang.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 valuevoid
renderHiddenInput(MarkupOutput out, java.lang.String propName, java.lang.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 valuevoid
renderHiddenInput(MarkupOutput out, java.lang.String propName, java.lang.String value, HashList<java.lang.String,java.lang.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 valueprotected void
renderJavascript(MarkupOutput out)
This method renders all javascript that will be necessary for the Transform to work correctly.void
renderRadio(MarkupOutput out, java.lang.String propName, HashList<java.lang.String,java.lang.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 valuevoid
renderRadio(MarkupOutput out, java.lang.String propName, HashList<java.lang.String,java.lang.String> elems, HashList<java.lang.String,java.lang.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 valuevoid
renderRadio(MarkupOutput out, java.lang.String propName, HashList<java.lang.String,java.lang.String> elems, HashList<java.lang.String,java.lang.String> extraAttributes, java.lang.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 valuevoid
renderRadio(MarkupOutput out, java.lang.String propName, java.lang.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 valuevoid
renderRadio(MarkupOutput out, java.lang.String propName, java.lang.String elems, java.lang.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 valuevoid
renderRadio(MarkupOutput out, java.lang.String propName, java.lang.String elems, java.lang.String extraAttributes, java.lang.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 valuevoid
renderSecondaryDataProvidersSelectbox(MarkupOutput out, java.lang.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, java.lang.String propName, HashList<java.lang.String,java.lang.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 valuevoid
renderSelectBox(MarkupOutput out, java.lang.String propName, HashList<java.lang.String,java.lang.String> elems, HashList<java.lang.String,java.lang.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 valuevoid
renderSelectBox(MarkupOutput out, java.lang.String propName, HashList<java.lang.String,java.lang.String> elems, HashList<java.lang.String,java.lang.String> extraAttributes, java.lang.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 valuevoid
renderSelectBox(MarkupOutput out, java.lang.String propName, java.lang.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 valuevoid
renderSelectBox(MarkupOutput out, java.lang.String propName, java.lang.String elems, java.lang.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 valuevoid
renderSelectBox(MarkupOutput out, java.lang.String propName, java.lang.String elems, java.lang.String extraAttributes, java.lang.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 valuevoid
renderTabs(MarkupOutput out, java.lang.String tabNames)
Renders a collection of tabs for the editorvoid
renderTextarea(MarkupOutput out, java.lang.String propName)
Renders a textarea input.
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this valuevoid
renderTextarea(MarkupOutput out, java.lang.String propName, HashList<java.lang.String,java.lang.String> extraAttributes)
Renders a textarea input.
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this valuevoid
renderTextarea(MarkupOutput out, java.lang.String propName, HashList<java.lang.String,java.lang.String> extraAttributes, java.lang.String defaultValue)
Renders a textarea input.
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this valuevoid
renderTextarea(MarkupOutput out, java.lang.String propName, java.lang.String extraAttributes)
Renders a text input.
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this valuevoid
renderTextarea(MarkupOutput out, java.lang.String propName, java.lang.String extraAttributes, java.lang.String defaultValue)
Renders a textarea input.
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this valuevoid
renderTextbox(MarkupOutput out, java.lang.String propName)
Renders a text input.
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this valuevoid
renderTextbox(MarkupOutput out, java.lang.String propName, HashList<java.lang.String,java.lang.String> extraAttributes)
Renders a text input.
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this valuevoid
renderTextbox(MarkupOutput out, java.lang.String propName, HashList<java.lang.String,java.lang.String> extraAttributes, java.lang.String defaultValue)
Renders a text input.
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this valuevoid
renderTextbox(MarkupOutput out, java.lang.String propName, java.lang.String extraAttributes)
Renders a text input.
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this valuevoid
renderTextbox(MarkupOutput out, java.lang.String propName, java.lang.String extraAttributes, java.lang.String defaultValue)
Renders a text input.
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this valueprotected void
setBoneProperties(JsonGenerator boneProps)
Sets the necessary properties to the bone assigned to this transform (based on theAbstractAppTransform.scriptClass
formal parameter)
Usually called byAbstractAppTransform.renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.protected void
setExtraAttributesOnInput(HashList<java.lang.String,java.lang.String> extraAttributes, Tag input)
void
transformForRequestSuccessful(MarkupOutput out)
Generates the output when the bean's status isEnumRequestStatus.WebBeanRequestSuccessful
.-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
addContactInfo, addDynamicScriptClass, addDynamicScriptFile, addFormalParameter, checkLevel, checkProcessingButtonsFlag, checkProcessingInfoFlag, checkStatus, displayError, displayError, displayError, emptyCell, excludeStaticTags, generateAnchor, generateAnchorForExport, generateHiddenInputsForEvent, generateIFrameTag, getAppContext, getArgumentName, getAttributesShellDiv, getBeanPath, getBoneId, getCancelEvent, getClientSideHelper, getContainerServices, getContext, getContextMenu, getContextMenuManager, getContextMenuManagerName, getContextMenusDefinition, getCssPrefix, getDateFormat, getDebugOut, getDescriptor, getDescriptor, getDescriptor, getDescriptor, getDisplayMode, getDisplayName, getErrorMessage, getErrorMessage, getErrorTitle, getErrorTitle, getEventManager, getFirstDayOfWeek, getFloatValue, getHelpPath, getID, getIntValue, getJSNameSpace, getLayoutContext, getLocale, getLocale, getPreferenceValue, getProjectID, getRefreshEvent, getRequestKeys, getResourcesFolder, getScriptClass, getStringValue, getStyleRequestContext, getSupportedBeanType, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, initializeCss, initializeImages, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameEnabled, isIFrameRequest, isJobExpired, isModal, isPortlet, isTrue, localIsIFrameDisplayMode, newContext, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, redirectToDisplayError, renderBean, renderBean, renderBean, renderBean, renderCancelButton, renderContextMenus, renderCssLink, renderDescriptor, renderDescriptor, renderErrorButton, renderHiddenInputFromRequest, renderImage, renderLayout, renderProcessingButton, renderProcessingButton, renderProcessingButton, renderProcessingButtonForGet, renderProcessingButtonForGet, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoData, renderProcessingInfoImage, renderProcessingInfoSubtitle, renderProcessingInfoTitle, renderProcessingObjectName, renderRefreshButton, renderRegisterBone, renderSelf, renderShell, renderSubBlock, renderUserHelpAnchor, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, shouldDisplay, transform, transformForRequestCanceled, transformForRequestInError, transformForRequestNotInited, transformForRequestProcessing, transformForRequestWaitingForUserInput
-
Methods inherited from class com.microstrategy.web.transform.AbstractLayoutTransform
getLayoutDefinition, setLayoutDefinition, transformUsingLayout
-
Methods inherited from class com.microstrategy.web.transform.AbstractTransform
addFormalParam, canTransform, getEvents, getFormalParams, getPreview, isPreviewAvailable, isResolved, removeFormalParam, setAnnotation, setDeprecated, supports, supports
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.microstrategy.web.transform.LayoutTransform
getLayoutDefinition, setLayoutDefinition
-
Methods inherited from interface com.microstrategy.web.transform.Transform
canTransform, getFormalParams, getID, getPreview, getSupportedBeanType, isPreviewAvailable, isResolved, supports, supports, transform
-
-
-
-
Field Detail
-
_rb
protected ReportBean _rb
-
_vb
protected ViewBean _vb
-
_rwb
protected RWBean _rwb
-
_template
protected WebTemplate _template
-
colorPickerName
protected FormalParameter colorPickerName
-
FP_COLOR_PICKER_NAME
public static final java.lang.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. Value is colorPickerName.- See Also:
- Constant Field Values
-
-
Method Detail
-
initializeTransform
public void initializeTransform(Transformable data)
Description copied from class:AbstractAppTransform
This method initialize the private and protected fields of the transform, such as width and height. It also invokes the
This method is automatically called from theinitializeWebComponent
,initializeImages
andinitializeCss
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.- Specified by:
initializeTransform
in interfaceAppTransform
- Overrides:
initializeTransform
in classAbstractAppTransform
- Parameters:
data
- the bean to transform.
-
getEditorBean
protected VisualizationPropertiesEditorBean getEditorBean()
-
getWebTemplate
protected WebTemplate getWebTemplate()
-
transformForRequestSuccessful
public void transformForRequestSuccessful(MarkupOutput out)
Description copied from class:AbstractAppTransform
Generates the output when the bean's status isEnumRequestStatus.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.- Specified by:
transformForRequestSuccessful
in classAbstractAppTransform
- Parameters:
out
- output by this transform- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
isOpen
protected boolean isOpen()
Description copied from class:AbstractAppTransform
Defines whether this Transform is currently visible to the end user.- Overrides:
isOpen
in classAbstractAppTransform
- Returns:
- true if the bean is visible
-
isDialog
protected boolean isDialog()
Description copied from class:AbstractAppTransform
Defines whether this Transform should behave as a dialog (for example, a pop-up window).- Overrides:
isDialog
in classAbstractAppTransform
- Returns:
- true if it's transforming a dialog
-
renderJavascript
protected void renderJavascript(MarkupOutput out)
This method renders all javascript that will be necessary for the Transform to work correctly.- Parameters:
out
- The MarkupOutput object to render the output to.
-
getDescription
public java.lang.String getDescription()
Description copied from interface:Transform
Returns a textual description of the transform.- Specified by:
getDescription
in interfaceTransform
- Returns:
- The textual description of the transform.
-
renderCheckbox
public void renderCheckbox(MarkupOutput out, java.lang.String propName)
Renders a checkbox.
Assumes the true value is "1"
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value- Parameters:
out
- The Markup output of this transformpropName
- the name of the property to render and read the value from
-
renderCheckbox
public void renderCheckbox(MarkupOutput out, java.lang.String propName, java.lang.String extraAttributes)
Renders a checkbox.
Assumes the true value is "1"
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value- Parameters:
out
- The Markup output of this transformpropName
- the name of the property to render and read the value fromextraAttributes
- A list with value/name pairs of extra attributes to add to the input. The format is "onclick^alert('a')|onchange^alert('b')"
-
renderCheckbox
public void renderCheckbox(MarkupOutput out, java.lang.String propName, HashList<java.lang.String,java.lang.String> extraAttributes)
Renders a checkbox.
Assumes the true value is "1"
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value- Parameters:
out
- The Markup output of this transformpropName
- the name of the property to render and read the value fromextraAttributes
- A HashList with value/name pairs of extra attributes to add to the input.
-
renderCheckbox
public void renderCheckbox(MarkupOutput out, java.lang.String propName, java.lang.String extraAttributes, java.lang.String defaultValue)
Renders a checkbox.
Assumes the true value is "1"
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value- Parameters:
out
- The Markup output of this transformpropName
- the name of the property to render and read the value fromextraAttributes
- 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.
-
renderCheckbox
public void renderCheckbox(MarkupOutput out, java.lang.String propName, HashList<java.lang.String,java.lang.String> extraAttributes, java.lang.String defaultValue)
Renders a checkbox.
Assumes the true value is "1"
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value- Parameters:
out
- The Markup output of this transformpropName
- the name of the property to render and read the value fromextraAttributes
- 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.
-
renderTextbox
public void renderTextbox(MarkupOutput out, java.lang.String propName)
Renders a text input.
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value- Parameters:
out
- The Markup output of this transformpropName
- the name of the property to render and read the value from
-
renderTextbox
public void renderTextbox(MarkupOutput out, java.lang.String propName, java.lang.String extraAttributes)
Renders a text input.
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value- Parameters:
out
- The Markup output of this transformpropName
- the name of the property to render and read the value fromextraAttributes
- A HashList with value/name pairs of extra attributes to add to the input.
-
renderTextbox
public void renderTextbox(MarkupOutput out, java.lang.String propName, HashList<java.lang.String,java.lang.String> extraAttributes)
Renders a text input.
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value- Parameters:
out
- The Markup output of this transformpropName
- the name of the property to render and read the value fromextraAttributes
- A HashList with value/name pairs of extra attributes to add to the input.
-
renderTextbox
public void renderTextbox(MarkupOutput out, java.lang.String propName, java.lang.String extraAttributes, java.lang.String defaultValue)
Renders a text input.
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value- Parameters:
out
- The Markup output of this transformpropName
- the name of the property to render and read the value fromextraAttributes
- 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.
-
renderTextbox
public void renderTextbox(MarkupOutput out, java.lang.String propName, HashList<java.lang.String,java.lang.String> extraAttributes, java.lang.String defaultValue)
Renders a text input.
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value- Parameters:
out
- The Markup output of this transformpropName
- the name of the property to render and read the value fromextraAttributes
- 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.
-
renderTextarea
public void renderTextarea(MarkupOutput out, java.lang.String propName)
Renders a textarea input.
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value- Parameters:
out
- The Markup output of this transformpropName
- the name of the property to render and read the value from
-
renderTextarea
public void renderTextarea(MarkupOutput out, java.lang.String propName, java.lang.String extraAttributes)
Renders a text input.
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value- Parameters:
out
- The Markup output of this transformpropName
- the name of the property to render and read the value fromextraAttributes
- A HashList with value/name pairs of extra attributes to add to the input.
-
renderTextarea
public void renderTextarea(MarkupOutput out, java.lang.String propName, HashList<java.lang.String,java.lang.String> extraAttributes)
Renders a textarea input.
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value- Parameters:
out
- The Markup output of this transformpropName
- the name of the property to render and read the value fromextraAttributes
- A HashList with value/name pairs of extra attributes to add to the input.
-
renderTextarea
public void renderTextarea(MarkupOutput out, java.lang.String propName, java.lang.String extraAttributes, java.lang.String defaultValue)
Renders a textarea input.
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value- Parameters:
out
- The Markup output of this transformpropName
- the name of the property to render and read the value fromextraAttributes
- 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.
-
renderTextarea
public void renderTextarea(MarkupOutput out, java.lang.String propName, HashList<java.lang.String,java.lang.String> extraAttributes, java.lang.String defaultValue)
Renders a textarea input.
Adds the attribute (visprop="1") that informs the visualization Properties editor to save this value- Parameters:
out
- The Markup output of this transformpropName
- the name of the property to render and read the value fromextraAttributes
- 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.
-
renderHiddenInput
public void renderHiddenInput(MarkupOutput out, java.lang.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- Parameters:
out
- The Markup output of this transformpropName
- the name of the property to render and read the value from
-
renderHiddenInput
public void renderHiddenInput(MarkupOutput out, java.lang.String propName, java.lang.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- Parameters:
out
- The Markup output of this transformpropName
- the name of the property to render and read the value fromextraAttributes
- A list with value/name pairs of extra attributes to add to the input. The format is "onclick^alert('a')|onchange^alert('b')"
-
renderHiddenInput
public void renderHiddenInput(MarkupOutput out, java.lang.String propName, java.lang.String value, HashList<java.lang.String,java.lang.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- Parameters:
out
- The Markup output of this transformpropName
- the name of the property to render and read the value fromvalue
- the input's valueextraAttributes
- A HashList with value/name pairs of extra attributes to add to the input.
-
renderSelectBox
public void renderSelectBox(MarkupOutput out, java.lang.String propName, java.lang.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- Parameters:
out
- The Markup output of this transformpropName
- the name of the property to render and read the value fromelems
- A String that represents the values to render on the select box. The format is "0^Red|1^Blue|2^Yellow"
-
renderSelectBox
public void renderSelectBox(MarkupOutput out, java.lang.String propName, HashList<java.lang.String,java.lang.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- Parameters:
out
- The Markup output of this transformpropName
- the name of the property to render and read the value fromelems
- A HashList with value/name pairs that represents the values to render on the select box.
-
renderSelectBox
public void renderSelectBox(MarkupOutput out, java.lang.String propName, java.lang.String elems, java.lang.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- Parameters:
out
- The Markup output of this transformpropName
- the name of the property to render and read the value fromelems
- 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')"
-
renderSelectBox
public void renderSelectBox(MarkupOutput out, java.lang.String propName, HashList<java.lang.String,java.lang.String> elems, HashList<java.lang.String,java.lang.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- Parameters:
out
- The Markup output of this transformpropName
- the name of the property to render and read the value fromelems
- 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.
-
renderSelectBox
public void renderSelectBox(MarkupOutput out, java.lang.String propName, java.lang.String elems, java.lang.String extraAttributes, java.lang.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- Parameters:
out
- The Markup output of this transformpropName
- the name of the property to render and read the value fromelems
- 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.
-
renderSelectBox
public void renderSelectBox(MarkupOutput out, java.lang.String propName, HashList<java.lang.String,java.lang.String> elems, HashList<java.lang.String,java.lang.String> extraAttributes, java.lang.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- Parameters:
out
- The Markup output of this transformpropName
- the name of the property to render and read the value fromelems
- 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.
-
renderRadio
public void renderRadio(MarkupOutput out, java.lang.String propName, java.lang.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- Parameters:
out
- The Markup output of this transformpropName
- the name of the property to render and read the value fromelems
- A String that represents the values to render as Radio buttons. The format is "0^Red|1^Blue|2^Yellow"
-
renderRadio
public void renderRadio(MarkupOutput out, java.lang.String propName, HashList<java.lang.String,java.lang.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- Parameters:
out
- The Markup output of this transformpropName
- the name of the property to render and read the value fromelems
- A HashList with value/name pairs to display as Radio buttons
-
renderRadio
public void renderRadio(MarkupOutput out, java.lang.String propName, java.lang.String elems, java.lang.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- Parameters:
out
- The Markup output of this transformpropName
- the name of the property to render and read the value fromelems
- 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')"
-
renderRadio
public void renderRadio(MarkupOutput out, java.lang.String propName, HashList<java.lang.String,java.lang.String> elems, HashList<java.lang.String,java.lang.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- Parameters:
out
- The Markup output of this transformpropName
- the name of the property to render and read the value fromelems
- A HashList with value/name pairs to display as the Radio buttonsextraAttributes
- A HashList with value/name pairs of extra attributes to add to the input.
-
renderRadio
public void renderRadio(MarkupOutput out, java.lang.String propName, java.lang.String elems, java.lang.String extraAttributes, java.lang.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- Parameters:
out
- The Markup output of this transformpropName
- the name of the property to render and read the value fromelems
- 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.
-
renderRadio
public void renderRadio(MarkupOutput out, java.lang.String propName, HashList<java.lang.String,java.lang.String> elems, HashList<java.lang.String,java.lang.String> extraAttributes, java.lang.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- Parameters:
out
- The Markup output of this transformpropName
- the name of the property to render and read the value fromelems
- A HashList with value/name pairs to display as the Radio buttonsextraAttributes
- 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.
-
getStyleShellDiv
public java.lang.String getStyleShellDiv()
Description copied from class:AbstractAppTransform
Returns thestyle
(that is, the style attribute used for css formatting) of the shell's div.- Overrides:
getStyleShellDiv
in classAbstractAppTransform
- See Also:
AbstractAppTransform.renderShell(com.microstrategy.web.beans.MarkupOutput)
-
renderColorPicker
public void renderColorPicker(MarkupOutput out, java.lang.String propName)
Renders a color picker- Parameters:
out
- The Markup output of this transformpropName
- the name of the property to render and read the value from
-
renderColorPicker
public void renderColorPicker(MarkupOutput out, java.lang.String propName, java.lang.String defaultValue)
Renders a color picker- Parameters:
out
- The Markup output of this transformpropName
- the name of the property to render and read the value fromdefaultValue
- the default value in case the property is not saved. (i.e. #FFFFFF)
-
renderTabs
public void renderTabs(MarkupOutput out, java.lang.String tabNames)
Renders a collection of tabs for the editor- Parameters:
out
- The Markup output of this transformtabNames
- a comma separated list of tabs to display
-
renderSecondaryDataProvidersSelectbox
public void renderSecondaryDataProvidersSelectbox(MarkupOutput out, java.lang.String propName)
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"- Parameters:
out
- The Markup output of this transformpropName
- the name of the property to render and read the value from
-
setExtraAttributesOnInput
protected void setExtraAttributesOnInput(HashList<java.lang.String,java.lang.String> extraAttributes, Tag input)
-
getTemplateName
protected java.lang.String getTemplateName(RWGridGraphDef def)
-
getHashListFromString
protected HashList<java.lang.String,java.lang.String> getHashListFromString(java.lang.String elems)
-
isDescriptor
protected boolean isDescriptor(java.lang.String value)
-
getColorPicker
protected ShortcutList getColorPicker()
Returns the color picker. If a non-null instance have been registered through thesetColorPicker
method, it will return that one, otherwise, it will search for a system picker with the name specified inFP_COLOR_PICKER_NAME
.- Returns:
- ShortcutList to use for the color-picker.
-
renderColorDropdown
protected void renderColorDropdown(MarkupOutput out, java.lang.String cmdId, java.lang.String cmdValue, ShortcutList picker)
This method renders a single dropdown to be used with a color picker- Parameters:
out
- MarkupOutput where the content should be generatedcmdId
- the dropdown's command idcmdValue
- the dropdown's current command value.picker
- the ShortcutList for the picker.
-
getVisPropValue
protected java.lang.String getVisPropValue(java.lang.String propName)
- Parameters:
propName
- The property name- Returns:
- The value of a visualization Property
-
setBoneProperties
protected void setBoneProperties(JsonGenerator boneProps)
Description copied from class:AbstractAppTransform
Sets the necessary properties to the bone assigned to this transform (based on theAbstractAppTransform.scriptClass
formal parameter)
Usually called byAbstractAppTransform.renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.- Overrides:
setBoneProperties
in classAbstractAppTransform
- Parameters:
boneProps
- the JsonGenerator object that contains the collection of bone properties.
-
isRW
public boolean isRW()
-
-