Class FunctionEditorTransform
- java.lang.Object
-
- com.microstrategy.web.transform.AbstractTransform
-
- com.microstrategy.web.transform.AbstractLayoutTransform
-
- com.microstrategy.web.app.transforms.AbstractAppTransform
-
- com.microstrategy.web.app.transforms.AbstractEditorTransform
-
- com.microstrategy.web.app.transforms.FunctionEditorTransform
-
- All Implemented Interfaces:
AppTransform
,LayoutTransform
,Transform
public class FunctionEditorTransform extends AbstractEditorTransform implements LayoutTransform
Transform which renders the Function Editor.- Since:
- MicroStrategy Web 9.0.0
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
AbstractAppTransform.Context
-
-
Field Summary
-
Fields inherited from class com.microstrategy.web.app.transforms.AbstractEditorTransform
_helpTopic, _helpType, applyJS, applyLabel, applyLabelID, canAutoSize, cancelJS, cancelLabel, cancelLabelID, closeEvent, closeImage, closeJS, closeLabel, closeLabelID, dhtmlClose, disableOKButton, editorContentsStyle, editorElements, editorLayoutFile, editorSubType, FP_APPLY_JS, FP_APPLY_LABEL, FP_APPLY_LABEL_ID, FP_CAN_AUTO_SIZE, FP_CANCEL_JS, FP_CANCEL_LABEL, FP_CANCEL_LABEL_ID, FP_CLOSE_EVENT, FP_CLOSE_IMAGE, FP_CLOSE_JS, FP_CLOSE_LABEL, FP_CLOSE_LABEL_ID, FP_DHTML_CLOSE, FP_DISABLE_OK_BUTTON, FP_EDITOR_CONTENTS_STYLE, FP_EDITOR_ELEMENTS, FP_EDITOR_LAYOUT_FILE, FP_EDITOR_SUBTYPE, FP_HELP_PAGE, FP_HELP_TOPIC, FP_HELP_TYPE, FP_INCLUDE_DYNAMIC_SCRIPT, FP_NAVIGATE_ON_SUBMIT, FP_OK_JS, FP_OK_LABEL, FP_OK_LABEL_ID, FP_RENDER_FORM, FP_TITLE_LABEL, FP_TITLE_LABEL_ID, FP_USE_JS_IN_BONE, helpPage, helpTopic, helpType, includeDynamicScript, navigateOnSubmit, okJS, okLabel, okLabelID, renderForm, titleLabel, titleLabelID
-
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 FunctionEditorTransform()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getDescription()
Returns a textual description of the transform.protected java.lang.String
getEditorTitle()
java.util.Iterator<WebFunctionProperty>
getFunctionExposedPropertyList()
java.util.Iterator
getFunctionParameterList()
java.util.Iterator
getFunctionPropertyList()
java.lang.Class
getSupportedBeanType()
Returns the supported bean type.boolean
hasBreakBySection()
boolean
hasSortBySection()
void
initializeTransform(Transformable data)
This method initializes the private and protected fields of the transform.boolean
isStepOne()
boolean
isStepTwo()
void
populateTemplateUnitsPulldown(SelectTag pulldown)
void
renderAttrFormOption(SelectTag pulldown, BeanContext context, java.util.ArrayList<RWDataSetItem> list, WebWorkingSet wrkSet)
Render the attribute form which is from all the datasetsvoid
renderAttrMetricOption(SelectTag pulldown, java.util.ArrayList<RWDataSetItem> list, boolean hideDatasetPrefix)
Render the given attribute/metric list from all datasets in ordervoid
renderAvailableCategory(MarkupOutput out)
Render methods***void
renderAvailableFunction(MarkupOutput out)
void
renderBreakBySectionInput(MarkupOutput out)
void
renderBreakBySectionName(MarkupOutput out)
void
renderEditorContents(MarkupOutput out)
Generates the graphical output for the Editorvoid
renderFunctionDescription(MarkupOutput out)
void
renderFunctionName(MarkupOutput out)
protected void
renderJavascript(MarkupOutput out)
This method should be used by the Editor transforms to generate any javascript necessary.void
renderParamInput(MarkupOutput out, WebFunctionParameter param)
void
renderParamName(MarkupOutput out, WebFunctionParameter param)
void
renderPropInput(MarkupOutput out, WebFunctionProperty prop)
void
renderPropName(MarkupOutput out, WebFunctionProperty prop)
void
renderSortByDirectionAsRadioButtons(MarkupOutput out)
void
renderSortBySectionInput(MarkupOutput out)
void
renderSortBySectionName(MarkupOutput out)
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractEditorTransform
generateForm, getDivTagAroundContents, getOnSubmitJS, getWebBeanErrorInfo, initEditor, initHelp, renderEditor, renderEditorElement, setFocusFieldId, transformForRequestInError, transformForRequestSuccessful
-
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, 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, transformForRequestCanceled, 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, isPreviewAvailable, isResolved, supports, supports, transform
-
-
-
-
Method Detail
-
initializeTransform
public void initializeTransform(Transformable data)
Description copied from class:AbstractEditorTransform
This method initializes the private and protected fields of the transform.- Specified by:
initializeTransform
in interfaceAppTransform
- Overrides:
initializeTransform
in classAbstractEditorTransform
- Parameters:
data
- bean that will be transformed- See Also:
AbstractEditorTransform.initializeTransform(com.microstrategy.web.beans.Transformable)
-
renderJavascript
protected void renderJavascript(MarkupOutput out)
This method should be used by the Editor transforms to generate any javascript necessary.
The default implementation includes a call to theClientSideHelper
to render the dynamic scrips and the registerBone call.- Overrides:
renderJavascript
in classAbstractEditorTransform
- Parameters:
out
-MarkupOutput
where the output should be rendered.
-
renderEditorContents
public void renderEditorContents(MarkupOutput out)
Description copied from class:AbstractEditorTransform
Generates the graphical output for the Editor- Specified by:
renderEditorContents
in classAbstractEditorTransform
- Parameters:
out
-MarkupOutput
instance where to create the HTML output
-
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.
-
isStepOne
public boolean isStepOne()
-
isStepTwo
public boolean isStepTwo()
-
getEditorTitle
protected java.lang.String getEditorTitle()
- Overrides:
getEditorTitle
in classAbstractEditorTransform
-
renderAvailableCategory
public void renderAvailableCategory(MarkupOutput out)
Render methods***
-
renderAvailableFunction
public void renderAvailableFunction(MarkupOutput out)
-
renderFunctionName
public void renderFunctionName(MarkupOutput out)
-
renderSortByDirectionAsRadioButtons
public void renderSortByDirectionAsRadioButtons(MarkupOutput out)
-
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.
-
populateTemplateUnitsPulldown
public void populateTemplateUnitsPulldown(SelectTag pulldown) throws WebObjectsException, WebBeanException
- Throws:
WebObjectsException
WebBeanException
-
renderFunctionDescription
public void renderFunctionDescription(MarkupOutput out)
-
getFunctionParameterList
public java.util.Iterator getFunctionParameterList()
-
getFunctionPropertyList
public java.util.Iterator getFunctionPropertyList()
-
getFunctionExposedPropertyList
public java.util.Iterator<WebFunctionProperty> getFunctionExposedPropertyList()
-
renderParamName
public void renderParamName(MarkupOutput out, WebFunctionParameter param)
-
renderPropName
public void renderPropName(MarkupOutput out, WebFunctionProperty prop)
-
renderParamInput
public void renderParamInput(MarkupOutput out, WebFunctionParameter param)
-
renderPropInput
public void renderPropInput(MarkupOutput out, WebFunctionProperty prop)
-
hasBreakBySection
public boolean hasBreakBySection()
-
hasSortBySection
public boolean hasSortBySection()
-
renderBreakBySectionName
public void renderBreakBySectionName(MarkupOutput out)
-
renderBreakBySectionInput
public void renderBreakBySectionInput(MarkupOutput out)
-
renderSortBySectionName
public void renderSortBySectionName(MarkupOutput out)
-
renderSortBySectionInput
public void renderSortBySectionInput(MarkupOutput out)
-
renderAttrFormOption
public void renderAttrFormOption(SelectTag pulldown, BeanContext context, java.util.ArrayList<RWDataSetItem> list, WebWorkingSet wrkSet)
Render the attribute form which is from all the datasets
-
renderAttrMetricOption
public void renderAttrMetricOption(SelectTag pulldown, java.util.ArrayList<RWDataSetItem> list, boolean hideDatasetPrefix)
Render the given attribute/metric list from all datasets in order- Parameters:
pulldown
-list
- is the given attribute/metric listhideDatasetPrefix
- specify if the dataset name as a prefix should be hidden
-
-