Package com.microstrategy.web.app.transforms

Interface AppTransform

All Superinterfaces:

Transform

All Known Implementing Classes:

AbstractAdminPathTransform, AbstractAdminTransform, AbstractAppTransform, AbstractAppWidgetTransform, AbstractChangePasswordTransform, AbstractColorGradientEditorTransform, AbstractDiagnosticsTransform, AbstractDocumentTransform, AbstractEditorTransform, AbstractExportTransform, AbstractFilterElementTransform, AbstractFolderTransform, AbstractFormatTabTransform, AbstractHeaderFooterTransform, AbstractMojoRWTransform, AbstractMojoTransform, AbstractObjectBrowserTabTransform, AbstractObjectExplorerTransform, AbstractObjectExplorerTreeTransform, AbstractObjectInfoListTransform, AbstractOptionsTransform, AbstractPreferencesTransform, AbstractPrivilegesEditorTransform, AbstractPromptEditorTransform, AbstractPromptWidgetTransform, AbstractReportDataTransform, AbstractReportDataVisualizationTransform, AbstractReportExportTransform, AbstractReportGridExportTransform, AbstractReportGridTransform, AbstractReportOutlineModeExportTransform, AbstractReportTransform, AbstractRWDataVisualizationTransform, AbstractRWTransform, AbstractScheduleListTransform, AbstractServerPropertiesTransform, AbstractSimplifiedRWXMLTransform, AbstractSubscriptionEditTransform, AbstractSubscriptionFolderBeanTransform, AbstractSubscriptionListTransform, AbstractSubscriptionsEditorTransform, AbstractTabTransform, AbstractUserEntitiesTreeCartTransform, AbstractWebBeanTransform, AccordionTabBeanTransform, AccordionTabManagerTransform, AddDataSetWizardTransform, AddressDeleteTransform, AddressListFileTransform, AddressListPrintTransform, AddressListTransform, AddressTransform, AdminFolderQuickSearchResultsTransform, AdminFolderSearchResultsTransform, AdminFolderViewTransform, AdminGenericTabTransform, AdminPathTransform, AdvancedThresholdsEditorTransform, AdvSortDataTransform, AlertsEditorTransform, AlertsObjectExplorerTransform, AllObjectBrowserHTMLTransform, AllObjectBrowserTransform, AndroidMapTransformImpl, AnnotationsTransform, AttributeElementsWidgetTransform, AttributeFormsEditorTransform, AttributeFormsQualificationTransform, BeanGeneratedOutputTransform, BlockColorPickerTransform, ChangePasswordGeneralTransform, ChangePasswordPreferencesTransform, ColorGradientEditorTransform, ColorPickerEditorTransform, ConfirmOverwriteDialogTransform, ConnectedServersTransform, ConstantPromptEditorTransform, ControlToolbarTransform, CubeExplorerForViewReportTransform, CurrentItemTransform, DataExplorerElementsWidgetTransform, DataExplorerFolderWidgetTransform, DataExplorerTransform, DataExplorerWidgetTransform, DataImportTransform, DatasetObjectExplorerTransform, DerivedElementCalculationTransform, DerivedElementFilterTransform, DerivedElementFormatEditorTransform, DerivedElementListTransform, DerivedElementsBrowserTransform, DerivedElementsConvertDialogTransform, DerivedElementsEditorTransform, DerivedElementTransform, DesktopPathTransform, DiagnosticsPropertiesTransform, DiagnosticsStatisticsTransform, DiagnosticsViewerTransform, DialogPathTransform, DirectExportTransform, DocumentDetailsTransform, DocumentDetailsXHTMLTransform, DocumentExportTransform, DocumentFastExportTransform, DocumentGridToolbarBlockLoaderTransform, DocumentSimpleTransform, DrillFilterEditorTransform, EditorToolbarTransform, ElementPickerTransform, ElementsPromptEditorTransform, EmptyTransform, ESRIMapTransform, ESRIVisualizationPropertiesTransform, ExportOptionsEditorTransform, ExportTransform, ExpressionGenericTransform, ExpressionPromptEditorTransform, FilterAllObjectBrowserTransform, FilterDetailsEditorTransform, FilterDetailsFormattingEditorTransform, FilterElementRWTransform, FilterElementTransform, FilterExpressionTransform, FilterObjectBrowserTransform, FilterTransform, FloatingEditorBlockTransform, FolderAddDataSetExplorerTransform, FolderAddDataSetTransform, FolderAdminBrowserTransform, FolderBulletReportsTransform, FolderBulletRWTransform, FolderBulletTransform, FolderCreateDocumentTransform, FolderCreateReportTransform, FolderCreateReportXHTMLTransform, FolderDeleteObjectTransform, FolderDetailsTransform, FolderFrameTreeTransform, FolderIconRadioButtonTransform, FolderIconTransform, FolderListTransform, FolderObjectBrowserTransform, FolderObjectExplorerTransform, FolderOMDBrowserTransform, FolderProjectBrowserTransform, FolderQuickSearchResultsXHTMLTransform, FolderQuickSearchTransform, FolderRadioButtonTransform, FolderSaveAsBrowserTransform, FolderSaveAsTransform, FolderSaveAsXHTMLTransform, FolderSearchResultsTransform, FolderSearchResultsXHTMLTransform, FolderSmallIconTransform, FolderSummaryCreateDocumentTransform, FolderSummaryCreateReportTransform, FolderSummaryTransform, FolderSummaryViewTransform, FolderTreeTransform, FolderViewTransform, FolderViewWidgetTransform, FolderViewXMLTransform, FormatEditorTabManagerTransform, FormatPromptNumberTransform, FormatTabAlignmentTransform, FormatTabColorLinesTransform, FormatTabEffectsTransform, FormatTabFontTransform, FormatTabNumberTransform, FormatToolbarTransform, FormulaBarTransform, FrameGenericTransform, FunctionEditorTransform, GenericEditorTransform, GoogleMapTransform, GoogleMapVisualizationDataTransformImpl, GraphImageTransform, GridAutoStylesTransform, GroupbyPropertiesEditorTransform, GroupPathTransform, GuiElementsBlockTransform, HelpOnCBTabManagerTransform, HelpSetupTransform, HyperLinkObjectExplorerTransform, ImageLayoutVisualizationPropertiesTransform, ImageMapVisualizationDataTransform, ImageViewerVisualizationPropertiesTransform, ImportDerivedElementsTransform, InboxClearTransform, InboxDetailsTransform, InboxExtrasTransform, InboxListTransform, InboxListXHTMLTransform, InboxToolbarTransform, InsertLayoutBlockTransform, InsertMenuBlockTransform, InteractiveGridVisualizationDataTransform, IPadTimeLineVisualizationPropertiesTransform, IPhoneGridVisualizationPropertiesTransform, IPhoneImageMapPropertiesTransform, IPhoneMapVisualizationPropertiesTransform, IPhoneMarkerMashupVisualizationPropertiesTransform, IPhoneReportGridTransformImpl, IPhoneRWTransform, IPhoneTimeSeriesEditorTransform, JsonRWDTransform, LimitElementTransform, LoginContinueTransform, LoginTransform, LoginXHTMLTransform, LogoutTransform, MDXReportLimitElementTransform, MenuBlockTransform, MetricQualLevelEditorTransform, MobileChunkedRWTransform, MobileHTMLGridTransform, MojoAttributeTransform, MojoCustomGroupTransform, MojoFolderTransform, MojoIVETransform, MojoMapTransform, MojoPathTransform, MojoRWDTransform, MojoServerJsonVisualizationDataTransform, MojoSubscriptionTransform, MojoTemplateTransformImpl, MojoToolbarTransform, MojoVisualizationDataTransform, MojoVisualizationDateSelectionTransform, MojoVisualizationSimplifiedDataTransform, MojoXtabTransformImpl, MultiMediaVisualizationPropertiesTransform, MultipleObjectSelectorTransform, ObjectBrowserManagerTransform, ObjectBrowserTabOMDTransform, ObjectBrowserTabProjectBrowserTransform, ObjectBrowserTabReportAllObjectsTransform, ObjectBrowserTabReportWorkingSetTransform, ObjectBrowserTabRWWorkingSetTransform, ObjectExplorerBlockTransform, ObjectInfoTransform, ObjectManipulationDialogTransform, ObjectPathTransform, ObjectPathXHTMLTransform, ObjectReportPathTransform, ObjectReportXHTMLPathTransform, ObjectSelectorProjectBrowserTransform, ObjectSelectorTransform, ObjectSiblingsTransform, ObjectsPromptEditorTransform, OfficeTransform, OIVMToolbarTransform, OMDCreateFolderTransform, OtherConfigurationTransform, PageByTransform, PageSetupHTMLEditorTransform, PathTransform, PDFTransform, PreferencesDocumentTransform, PreferencesDrillTransform, PreferencesExcelHeaderFooterTransform, PreferencesExportAdminHeaderFooterTransform, PreferencesExportTransform, PreferencesFolderTransform, PreferencesGeneralTransform, PreferencesGenericTransform, PreferencesGraphTransform, PreferencesGridProjectLevelTransform, PreferencesGridTransform, PreferencesInboxTransform, PreferencesLogoutTransform, PreferencesNCTransform, PreferencesOfficeTransform, PreferencesPDFReportHeaderFooterTransform, PreferencesPDFTransform, PreferencesPrintHeaderFooterTransform, PreferencesPrintTransform, PreferencesProjectTransform, PreferencesPromptsLayoutTransform, PreferencesPromptsTransform, PreferencesScheduleTransform, PreferencesSecurityTransform, PreferencesToolbarTransform, PreferencesUserGroupsTransform, PrintTransform, ProjectBrowserTransform, ProjectStatusTransform, ProjectsTransform, PromptAnswerTransform, PromptConstantWidgetTransform, PromptDetailsTransform, PromptDimtyWidgetTransform, PromptEditorJavaScriptBoneTransform, PromptEditorTabManagerTransform, PromptEditorTabTransform, PromptElementsWidgetTransform, PromptExpressionWidgetTransform, PromptHierarchyWidgetTransform, PromptObjectWidgetTransform, PromptPathTransform, PromptsClassicTransform, PromptsContainerTransform, PromptsCreateReportContainerTransform, PromptsCreateReportTransform, PromptsIFrameTransform, PromptsSubscriptionTransform, PromptsSummaryTransform, ReportAjaxMojoVisualizationTransform, ReportAjaxVisualizationTransform, ReportDesignModeTransformImpl, ReportDetailsPanelTransform, ReportDetailsTransform, ReportDetailsXHTMLTransform, ReportErrorVisualizationTransform, ReportExportExcelFormattingTransform, ReportExportExcelFormatTransform, ReportExportHTMLFormatTransform, ReportExportHTMLTransform, ReportExportIServerTransform, ReportExportPlainTextTransform, ReportFlashTransform, ReportFrameClassicTransform, ReportFrameGenericTransform, ReportGoogleGraphVisualizationTransform, ReportGraphDesignTransform, ReportGraphImageTransform, ReportGraphTransformImpl, ReportGridExcelTransform, ReportGridGraphTransformImpl, ReportGridHTMLTransform, ReportGridPrintTransform, ReportGridToolbarBlockLoaderTransform, ReportGridTransformImpl, ReportHomeExportMenuBlockTransform, ReportIncrementalFetchTransform, ReportLastUpdateTransform, ReportOptionsTransform, ReportOutlineModeExcelTransform, ReportOutlineModeHTMLTransform, ReportOutlineModeTransformImpl, ReportPageByInfoTransform, ReportPageByTransform, ReportPathTransform, ReportQuickLinksTransform, ReportSavePropertiesTransform, ReportTimelineVisualizationTransform, ReportToolbarTransform, ResizeEditorTransform, RestrictedFolderObjectExplorerTransform, ResultSetFrameTransform, RibbonToolbarTransform, RWActionControlEditorTransform, RWDColorGradientEditorTransform, RWDetailsTransform, RWDocPropertiesEditorTransform, RWExportTransform, RWFlashDashboardTransform, RWFlashTransform, RWFrameGenericTransform, RWGraphDropZonesEditorTransform, RWGridTransform, RWIncrementalFetchTransform, RWLastUpdateTransform, RWLayoutTabStripTransform, RWLayoutTransform, RWOutlineViewTransform, RWPathTransform, RWPDFTransform, RWPromptsPathTransform, RWPropertiesEditorTransform, RWReportGraphDesignDropZoneTransformImpl, RWReportGraphDropZoneTransformImpl, RWSavePropertiesTransform, RWXMLTransform, SaveAsReportTransform, SaveAsRWTransform, SaveAsTransform, SaveObjectAsDialogTransform, ScheduleEditTransform, ScheduleOverwriteTransform, SchedulesBulletTransform, SchedulesFilteredListTransform, SchedulesFilteredListXHTMLTransform, SchedulesIconTransform, SchedulesIconXHTMLTransform, SchedulesListTransform, SchedulesListXHTMLTransform, SearchSimpleTransform, SearchSuggestTransform, SecondaryDataSourcesEditorTransform, SecurityFilterExpressionTransform, SecurityFilterFrameTransform, SecurityFilterTransform, SecurityRoleEditorTransform, SecurityRolePathTransform, SecurityRoleUserEntitiesSelectorTransform, SecurityTransform, ServerPropertiesTransform, ShareURLTransform, SimpleThresholdsEditorTransform, SingleObjectSelectorTransform, SortEditorTransform, SortGeneralTransform, SortTabBeanTransform, SubscriptionConfirmSendNowTransform, SubscriptionConfirmTransform, SubscriptionContactsBrowserTransform, SubscriptionEditCacheTransform, SubscriptionEditFileTransform, SubscriptionEditFTPTransform, SubscriptionEditInboxTransform, SubscriptionEditMobileTransform, SubscriptionEditPrintTransform, SubscriptionEditTransform, SubscriptionFrameTransform, SubscriptionPersonalViewTransform, SubscriptionsBulletTransform, SubscriptionsEditorHistoryListTransform, SubscriptionsEditorMobileTransform, SubscriptionsEditorNCCacheTransform, SubscriptionsEditorNCFileTransform, SubscriptionsEditorNCFTPTransform, SubscriptionsEditorNCPrintTransform, SubscriptionsEditorNCSendNowTransform, SubscriptionsEditorNCTransform, SubscriptionsEditorPersonalViewTransform, SubscriptionsEditorTransform, SubscriptionSendNowTransform, SubscriptionsFilteredListTransform, SubscriptionsFilteredListXHTMLTransform, SubscriptionsIconTransform, SubscriptionsIconXHTMLTransform, SubscriptionsListTransform, SubscriptionsListXHTMLTransform, SubsetViewLimitElementDialogTransform, SubsetViewLimitElementTransform, SubtotalsDHTMLTransform, SubtotalsEditorTabManagerTransform, SubtotalsEditorTransform, SurveyVisualizationPropertiesTransform, TabBeanTransform, TabDocumentAdvancedTransform, TabDocumentExportTransform, TabDocumentOtherTransform, TabDocumentTableOfContentsTransform, TabDocumentWatermarkTransform, TabGraphAdvancedTransform, TabGraphAxesTransform, TabGraphGeneralTransform, TabGraphNumberTransform, TabGraphOptionsTransform, TabGraphTitlesTransform, TabLayoutTransform, TabManagerTransform, TabPageMarginTransform, TabPageOutputTransform, TabPageSetupTransform, TabPropertiesAdvancedTransform, TabPropertiesDeliveryTransform, TabPropertiesFlashTransform, TabPropertiesGeneralTransform, TabPropertiesGridTransform, TabPropertiesLayoutTransform, TabPropertiesLineTransform, TabPropertiesOtherGridTransform, TabPropertiesPictureTransform, TabPropertiesSelectorTransform, TabSectionsTransform, TemplateFilterExecTransform, TemplateFilterExecXHTMLTransform, ThresholdExpressionTransform, ThresholdsEditorTransform, ThresholdsFormatEditorTransform, ToolbarSetTransform, ToolbarTransform, TreePickerVisualizationPropertiesTransform, TreeTabManagerTransform, TrustRelationshipTransform, UnconnectedServersTransform, UserAddressListTransform, UserAnalysisQuotaEditorTransform, UserContactsBrowserCartTransform, UserEntitiesSelectorTreeCartTransform, UserEntitiesTransform, UserEntityEditorTransform, UserEntityPrivilegesTransform, UserGroupTransform, UsherConfigTransform, ViewFilterEditorRWTransform, ViewFilterElementPanelTransform, ViewFilterElementRWTransform, ViewFilterElementTransform, VIMojoAttributeFormTransform, VisualizationPropertiesEditorTransform, VisualizationPropertiesTransform, VisualizationsEditorTransform, WebHyperLinkEditorTransform, WizardStepTransform, WizardTransform, XDADataExplorerTransform

public interface AppTransform
extends Transform

Since:

MicroStrategy Web 9.0.0

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDisplayMode()	get the display mode used when the GuiComponent renders itself
void	initializeTransform(Transformable data)	This method initialize the private and protected fields of the transform, such as width and height.
void	initializeWebComponent(Transformable data)	Initialize the web component to be used by the transform.
boolean	isDormant()
boolean	isIFrameDisplayMode()
void	setDisplayMode(java.lang.String newValue)	set the display mode used when the GuiComponent renders itself
void	setIFrameDisplayMode(boolean value)	Determines if the display mode should consider iframe request or not.
void	setIsDormant(boolean isDormant)	Tells the transform whether the bone is dormant or not, in which case it should not receive event notification.

Methods inherited from interface com.microstrategy.web.transform.Transform

canTransform, getDescription, getFormalParams, getID, getPreview, getSupportedBeanType, isPreviewAvailable, isResolved, supports, supports, transform

Method Detail

initializeTransform

void initializeTransform(Transformable data)

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.

This method is automatically called from the 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.

Parameters:

data - the bean to transform.

initializeWebComponent

void initializeWebComponent(Transformable data)

Initialize the web component to be used by the transform.

Parameters:

data - the bean to transform.

setIsDormant

void setIsDormant(boolean isDormant)

Tells the transform whether the bone is dormant or not, in which case it should not receive event notification.

Parameters:

isDormant - boolean

isDormant

boolean isDormant()

setIFrameDisplayMode

void setIFrameDisplayMode(boolean value)

Determines if the display mode should consider iframe request or not. A sample application of this logic will be to determine if the COMMENT HTML tags have to be generated in order for the response to be processed correctly by the iframe in the page.

Parameters:

value - boolean indicating if the display mode of this transform should be generated for iframe manipulation or not

isIFrameDisplayMode

boolean isIFrameDisplayMode()

setDisplayMode

void setDisplayMode(java.lang.String newValue)

set the display mode used when the GuiComponent renders itself

Parameters:

newValue - String the display mode: AppContext.DISPLAY_MODE_HTML - plain HTML AppContext.DISPLAY_MODE_JSON - the output will be wrapped up in a json structure in form of {id: id of the component, content: html content to be updated} or {id: if of the component, components: sub json blocks}

getDisplayMode

java.lang.String getDisplayMode()

get the display mode used when the GuiComponent renders itself