Class FrameGenericTransform
- java.lang.Object
-
- com.microstrategy.web.transform.AbstractTransform
-
- com.microstrategy.web.transform.AbstractLayoutTransform
-
- com.microstrategy.web.app.transforms.AbstractAppTransform
-
- com.microstrategy.web.app.transforms.FrameGenericTransform
-
- All Implemented Interfaces:
AppTransform
,LayoutTransform
,Transform
- Direct Known Subclasses:
ReportFrameGenericTransform
,RWFrameGenericTransform
public class FrameGenericTransform extends AbstractAppTransform implements LayoutTransform
This transforms renders a FrameBean using a LayoutBuilder. It's iFrame aware, so it provides methods to render elements as iFrame components.- Since:
- MicroStrategy Web 8.0.0
-
-
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 org.w3c.dom.Document
_defaultLayout
protected FormalParameter
customJavaScriptFeatures
name for the formal parameter "customJavaScriptFeatures".static java.lang.String
FP_CUSTOM_JS_FEATURES
Constant specifying any extra features that will be send down to the client.-
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 FrameGenericTransform()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
appendCustomFeatures(JsonGenerator features)
protected void
displayComponent(MarkupOutput out, java.lang.String name, MarkupOutput value, boolean canComment)
protected void
displayComponent(MarkupOutput out, java.lang.String name, java.lang.String value)
Display a string as an iFrame component.protected void
displayComponent(MarkupOutput out, java.lang.String name, java.lang.String value, boolean canComment)
Display a string as an iFrame component.protected void
generateSimpleMode(MarkupOutput out)
java.lang.String
getCustomColorDescriptor(java.lang.String c)
java.lang.String
getDecimalSeparator()
java.lang.String
getDescription()
The description of this transform for the Style Catalogjava.lang.Class
getSupportedBeanType()
Returns the supported bean type.int
getUserDpi()
java.util.ArrayList<java.lang.String>
getUserPalette()
void
initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform, such as width and height.void
renderCurrentEditor(MarkupOutput out)
void
renderData(MarkupOutput out)
void
renderEditorMessage(MarkupOutput out)
void
renderIFrameComponent(MarkupOutput out, java.lang.String name)
void
renderObjectBrowser(MarkupOutput out, java.lang.String name, java.lang.String style)
this method renders the object browser bean with is-container set to true NOTE: the reason we need this method for now is because of the need to do partial update when expanding a node of the object browser tree view TODO need to get rid of this method and the corresponding layout file hack once the is-container attribute is controlled by individual web-beanvoid
transformForRequestCanceled(MarkupOutput out)
Transform when the status isCanceled
.void
transformForRequestInError(MarkupOutput out)
Transform when the status isIn Error
.void
transformForRequestNotInited(MarkupOutput out)
Transform when the status isNot initialized
.void
transformForRequestProcessing(MarkupOutput out)
Transform when the status isProcessing
.void
transformForRequestSuccessful(MarkupOutput out)
Method that generates the output when the bean is Successful.void
transformForRequestWaitingForUserInput(MarkupOutput out)
Transform when the status isWaiting for user input
.-
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, getStyleShellDiv, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, initializeCss, initializeImages, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameEnabled, isIFrameRequest, isJobExpired, isModal, isOpen, 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, setBoneProperties, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, shouldDisplay, transform
-
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, isPreviewAvailable, isResolved, supports, supports, transform
-
-
-
-
Field Detail
-
FP_CUSTOM_JS_FEATURES
public static final java.lang.String FP_CUSTOM_JS_FEATURES
Constant specifying any extra features that will be send down to the client.- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
customJavaScriptFeatures
protected FormalParameter customJavaScriptFeatures
name for the formal parameter "customJavaScriptFeatures".- Since:
- MicroStrategy Web 9.0.0
-
_defaultLayout
protected org.w3c.dom.Document _defaultLayout
-
-
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.
-
transformForRequestInError
public void transformForRequestInError(MarkupOutput out)
Transform when the status isIn Error
.- Overrides:
transformForRequestInError
in classAbstractAppTransform
- Parameters:
out
- output by this transform- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
transformForRequestNotInited
public void transformForRequestNotInited(MarkupOutput out)
Transform when the status isNot initialized
.- Overrides:
transformForRequestNotInited
in classAbstractAppTransform
- Parameters:
out
- output by this transform- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
transformForRequestCanceled
public void transformForRequestCanceled(MarkupOutput out)
Transform when the status isCanceled
.- Overrides:
transformForRequestCanceled
in classAbstractAppTransform
- Parameters:
out
- output by this transform- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
transformForRequestProcessing
public void transformForRequestProcessing(MarkupOutput out)
Transform when the status isProcessing
.- Overrides:
transformForRequestProcessing
in classAbstractAppTransform
- Parameters:
out
- output by this transform- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
transformForRequestWaitingForUserInput
public void transformForRequestWaitingForUserInput(MarkupOutput out)
Transform when the status isWaiting for user input
.- Overrides:
transformForRequestWaitingForUserInput
in classAbstractAppTransform
- Parameters:
out
- output by this transform- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
generateSimpleMode
protected void generateSimpleMode(MarkupOutput out)
-
appendCustomFeatures
protected void appendCustomFeatures(JsonGenerator features)
- Since:
- MicroStrategy Web 9.0.0
-
transformForRequestSuccessful
public void transformForRequestSuccessful(MarkupOutput out)
Method that generates the output when the bean is Successful.- Specified by:
transformForRequestSuccessful
in classAbstractAppTransform
- Parameters:
out
- where to write the output of the method.- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
renderData
public void renderData(MarkupOutput out)
-
renderCurrentEditor
public void renderCurrentEditor(MarkupOutput out)
-
renderEditorMessage
public void renderEditorMessage(MarkupOutput out)
-
renderIFrameComponent
public void renderIFrameComponent(MarkupOutput out, java.lang.String name)
-
displayComponent
protected void displayComponent(MarkupOutput out, java.lang.String name, MarkupOutput value, boolean canComment)
- Since:
- MicroStrategy Web 9.0.0
-
displayComponent
protected void displayComponent(MarkupOutput out, java.lang.String name, java.lang.String value)
Display a string as an iFrame component.- Parameters:
out
- The HTML outputname
- the Component namevalue
- the String to render.
-
displayComponent
protected void displayComponent(MarkupOutput out, java.lang.String name, java.lang.String value, boolean canComment)
Display a string as an iFrame component.- Parameters:
out
- The HTML outputname
- the Component namevalue
- the String to render.canComment
- if true contents will be displayed inside aCOMMENT tag
-
getDescription
public java.lang.String getDescription()
The description of this transform for the Style Catalog- Specified by:
getDescription
in interfaceTransform
- Returns:
- This is the generic Transform for a FrameBean. It uses the LayoutBuilder to generate its layout
-
getSupportedBeanType
public java.lang.Class getSupportedBeanType()
Description copied from class:AbstractAppTransform
Returns the supported bean type. This abstract Transform supports allWebComponents
so every sub-class should override this method to return the class of theBean
the Transform is expecting, for example:public class CustomReportClass extends AbstractAppTransform { public Class getSupportedBeanType() { //This Transform is expected to work only with a ReportBean, //therefore this method needs to return this class: return ReportBean.class; } }
- Specified by:
getSupportedBeanType
in interfaceTransform
- Overrides:
getSupportedBeanType
in classAbstractAppTransform
- Returns:
- a root class/interface supported by this transform.
-
renderObjectBrowser
public void renderObjectBrowser(MarkupOutput out, java.lang.String name, java.lang.String style)
this method renders the object browser bean with is-container set to true NOTE: the reason we need this method for now is because of the need to do partial update when expanding a node of the object browser tree view TODO need to get rid of this method and the corresponding layout file hack once the is-container attribute is controlled by individual web-bean- Since:
- MicroStrategy Web 9.0.0
-
getUserPalette
public java.util.ArrayList<java.lang.String> getUserPalette()
- Since:
- MicroStrategy Web 9.0.0
-
getCustomColorDescriptor
public java.lang.String getCustomColorDescriptor(java.lang.String c)
- Since:
- MicroStrategy Web 9.0.0
-
getUserDpi
public int getUserDpi()
- Since:
- MicroStrategy Web 9.0.0
-
getDecimalSeparator
public java.lang.String getDecimalSeparator()
- Since:
- MicroStrategy Web 9.0.0
-
-