Package com.microstrategy.web.transform

Interface LayoutTransform

All Superinterfaces:

Transform

All Known Implementing Classes:

AbstractAdminPathTransform, AbstractAppWidgetTransform, AbstractFilterElementTransform, AbstractFolderTransform, AbstractHeaderFooterTransform, AbstractObjectExplorerTransform, AbstractObjectExplorerTreeTransform, AbstractObjectInfoListTransform, AbstractOptionsTransform, AbstractPreferencesTransform, AbstractPromptEditorTransform, AbstractPromptWidgetTransform, AbstractReportDataTransform, AbstractReportDataVisualizationTransform, AbstractReportExportTransform, AbstractReportGridExportTransform, AbstractReportGridTransform, AbstractReportOutlineModeExportTransform, AbstractUserEntitiesTreeCartTransform, AccordionTabBeanTransform, AccordionTabManagerTransform, AddressDeleteTransform, AdminFolderQuickSearchResultsTransform, AdminFolderSearchResultsTransform, AdminFolderViewTransform, AdminGenericTabTransform, AdminPathTransform, AdvancedThresholdsEditorTransform, AlertsEditorTransform, AlertsObjectExplorerTransform, AllObjectBrowserHTMLTransform, AllObjectBrowserTransform, AndroidMapTransformImpl, AnnotationsTransform, AttributeElementsWidgetTransform, AttributeFormsEditorTransform, BlockColorPickerTransform, ConfirmOverwriteDialogTransform, ConnectedServersTransform, ConstantPromptEditorTransform, ControlToolbarTransform, CubeExplorerForViewReportTransform, CurrentItemTransform, DataExplorerElementsWidgetTransform, DataExplorerFolderWidgetTransform, DataExplorerWidgetTransform, DatasetObjectExplorerTransform, DerivedElementCalculationTransform, DerivedElementFilterTransform, DerivedElementFormatEditorTransform, DerivedElementListTransform, DerivedElementsBrowserTransform, DerivedElementsConvertDialogTransform, DerivedElementsEditorTransform, DerivedElementTransform, DesktopPathTransform, DialogPathTransform, DocumentGridToolbarBlockLoaderTransform, DrillFilterEditorTransform, EditorToolbarTransform, ElementsPromptEditorTransform, ESRIMapTransform, ESRIVisualizationPropertiesTransform, ExpressionGenericTransform, ExpressionPromptEditorTransform, FilterAllObjectBrowserTransform, FilterDetailsEditorTransform, FilterDetailsFormattingEditorTransform, FilterElementRWTransform, FilterElementTransform, FilterExpressionTransform, FilterObjectBrowserTransform, 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, GoogleMapTransform, GoogleMapVisualizationDataTransformImpl, GridAutoStylesTransform, GroupPathTransform, GuiElementsBlockTransform, HelpOnCBTabManagerTransform, HyperLinkObjectExplorerTransform, ImageLayoutVisualizationPropertiesTransform, ImageMapVisualizationDataTransform, ImageViewerVisualizationPropertiesTransform, ImportDerivedElementsTransform, InboxClearTransform, InboxListXHTMLTransform, InboxToolbarTransform, InsertLayoutBlockTransform, InsertMenuBlockTransform, InteractiveGridVisualizationDataTransform, IPadTimeLineVisualizationPropertiesTransform, IPhoneGridVisualizationPropertiesTransform, IPhoneImageMapPropertiesTransform, IPhoneMapVisualizationPropertiesTransform, IPhoneMarkerMashupVisualizationPropertiesTransform, IPhoneReportGridTransformImpl, IPhoneTimeSeriesEditorTransform, LimitElementTransform, LoginXHTMLTransform, LogoutTransform, MDXReportLimitElementTransform, MenuBlockTransform, MojoMapTransform, MojoPathTransform, MojoServerJsonVisualizationDataTransform, MojoTemplateTransformImpl, MojoToolbarTransform, MojoVisualizationDataTransform, MojoVisualizationDateSelectionTransform, MojoVisualizationSimplifiedDataTransform, MojoXtabTransformImpl, MultiMediaVisualizationPropertiesTransform, MultipleObjectSelectorTransform, ObjectBrowserManagerTransform, ObjectExplorerBlockTransform, ObjectManipulationDialogTransform, ObjectPathTransform, ObjectPathXHTMLTransform, ObjectReportPathTransform, ObjectReportXHTMLPathTransform, ObjectSelectorProjectBrowserTransform, ObjectSelectorTransform, ObjectsPromptEditorTransform, OIVMToolbarTransform, OMDCreateFolderTransform, PageByTransform, PathTransform, PreferencesDocumentTransform, PreferencesDrillTransform, PreferencesExcelHeaderFooterTransform, PreferencesExportAdminHeaderFooterTransform, PreferencesExportTransform, PreferencesFolderTransform, PreferencesGeneralTransform, PreferencesGenericTransform, PreferencesGraphTransform, PreferencesGridProjectLevelTransform, PreferencesGridTransform, PreferencesInboxTransform, PreferencesLogoutTransform, PreferencesNCTransform, PreferencesOfficeTransform, PreferencesPDFReportHeaderFooterTransform, PreferencesPDFTransform, PreferencesPrintHeaderFooterTransform, PreferencesPrintTransform, PreferencesProjectTransform, PreferencesPromptsLayoutTransform, PreferencesPromptsTransform, PreferencesScheduleTransform, PreferencesSecurityTransform, ProjectsTransform, PromptAnswerTransform, PromptCartXHTMLTransform, PromptCheckboxTransform, PromptConstantTransform, PromptConstantWidgetTransform, PromptDimtyWidgetTransform, PromptEditorJavaScriptBoneTransform, PromptEditorTabManagerTransform, PromptEditorTabTransform, PromptElementsWidgetTransform, PromptExpressionCartWithPickerTransform, PromptExpressionCartXHTMLTransform, PromptExpressionListTransform, PromptExpressionNonCartTransform, PromptExpressionTextboxTransform, PromptExpressionWidgetTransform, PromptHierarchicalCartXHTMLTransform, PromptHierarchicalTreeXHTMLTransform, PromptHierarchyWidgetTransform, PromptListboxTransform, PromptObjectBrowsingXHTMLTransform, PromptObjectWidgetTransform, PromptPathTransform, PromptRadioTransform, PromptsClassicTransform, PromptsContainerTransform, PromptsCreateReportContainerTransform, PromptsCreateReportTransform, PromptsIFrameTransform, PromptsSubscriptionTransform, PromptsSummaryTransform, ReportAjaxMojoVisualizationTransform, ReportAjaxVisualizationTransform, ReportDesignModeTransformImpl, ReportDetailsXHTMLTransform, ReportErrorVisualizationTransform, ReportExportExcelFormatTransform, ReportExportHTMLFormatTransform, ReportExportHTMLTransform, ReportExportPlainTextTransform, ReportFlashTransform, ReportFrameGenericTransform, ReportGoogleGraphVisualizationTransform, ReportGraphDesignTransform, ReportGraphTransformImpl, ReportGridExcelTransform, ReportGridGraphTransformImpl, ReportGridHTMLTransform, ReportGridPrintTransform, ReportGridToolbarBlockLoaderTransform, ReportGridTransformImpl, ReportHomeExportMenuBlockTransform, ReportLastUpdateTransform, ReportOutlineModeExcelTransform, ReportOutlineModeHTMLTransform, ReportOutlineModeTransformImpl, ReportPageByTransform, ReportPathTransform, ReportTimelineVisualizationTransform, ReportToolbarTransform, ResizeEditorTransform, RestrictedFolderObjectExplorerTransform, ResultSetStatusTransform, RibbonToolbarTransform, RWDetailsTransform, RWDocPropertiesEditorTransform, RWFrameGenericTransform, RWLastUpdateTransform, RWPathTransform, RWPromptsPathTransform, RWPropertiesEditorTransform, RWReportGraphDesignDropZoneTransformImpl, RWReportGraphDropZoneTransformImpl, SaveAsReportTransform, SaveAsRWTransform, SaveAsTransform, SaveObjectAsDialogTransform, SearchSimpleTransform, SearchSuggestTransform, SecondaryDataSourcesEditorTransform, SecurityFilterExpressionTransform, SecurityFilterFrameTransform, SecurityRoleEditorTransform, SecurityRolePathTransform, SecurityRoleUserEntitiesSelectorTransform, SimpleThresholdsEditorTransform, SingleObjectSelectorTransform, SortEditorTransform, SortGeneralTransform, SortTabBeanTransform, SubscriptionsFilteredListXHTMLTransform, SubscriptionsIconXHTMLTransform, 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, TemplateFilterExecTransform, TemplateFilterExecXHTMLTransform, ThresholdExpressionTransform, ThresholdsEditorTransform, ThresholdsFormatEditorTransform, ToolbarSetTransform, ToolbarTransform, TreePickerVisualizationPropertiesTransform, TreeTabManagerTransform, UserAnalysisQuotaEditorTransform, UserEntitiesSelectorTreeCartTransform, UserEntitiesTransform, UserEntityEditorTransform, UserEntityPrivilegesTransform, UserGroupTransform, ViewFilterEditorRWTransform, ViewFilterElementPanelTransform, ViewFilterElementRWTransform, ViewFilterElementTransform, VisualizationPropertiesTransform, VisualizationsEditorTransform, WebHyperLinkEditorTransform, XDADataExplorerTransform

public interface LayoutTransform
extends Transform

The LayoutTransform interface defines a special class of MicroStrategy Transform objects that are "layout aware". To be layout aware, a transform must allow its structural definition to be exposed externally and controlled by the user. Dynamic elements can be interspersed with static tags in the associated layout definition.

Since:

MicroStrategy Web 8.0.0

Method Summary

Modifier and Type	Method	Description
LayoutTag	getLayoutDefinition()	Gets the in-memory layout definition associated with this transform instance.
void	setLayoutDefinition(LayoutTag layoutDefn)	Sets the in-memory layout defintion object to use with this transform instance.

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

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

Method Detail

getLayoutDefinition

LayoutTag getLayoutDefinition()

Gets the in-memory layout definition associated with this transform instance.

Returns:

The in-memory layout definition (as a LayoutTag object).

setLayoutDefinition

void setLayoutDefinition(LayoutTag layoutDefn)

Sets the in-memory layout defintion object to use with this transform instance.

Parameters:

layoutDefn - The in-memory layout definition (as a LayoutTag object).