Class AbstractEditorTransform
- 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
-
- All Implemented Interfaces:
AppTransform
,Transform
- Direct Known Subclasses:
AbstractColorGradientEditorTransform
,AbstractObjectBrowserTabTransform
,AbstractObjectExplorerTransform
,AbstractSubscriptionsEditorTransform
,AttributeFormsEditorTransform
,AttributeFormsQualificationTransform
,ColorPickerEditorTransform
,ConfirmOverwriteDialogTransform
,DerivedElementsConvertDialogTransform
,DerivedElementsEditorTransform
,DrillFilterEditorTransform
,ExportOptionsEditorTransform
,FilterDetailsFormattingEditorTransform
,FormulaBarTransform
,FunctionEditorTransform
,GenericEditorTransform
,GroupbyPropertiesEditorTransform
,MetricQualLevelEditorTransform
,MultipleObjectSelectorTransform
,OMDCreateFolderTransform
,PageSetupHTMLEditorTransform
,ResizeEditorTransform
,RWActionControlEditorTransform
,RWGraphDropZonesEditorTransform
,SaveObjectAsDialogTransform
,SecondaryDataSourcesEditorTransform
,SingleObjectSelectorTransform
,SortEditorTransform
,SubtotalsEditorTransform
,TabManagerTransform
,ThresholdsEditorTransform
,VisualizationPropertiesEditorTransform
,VisualizationsEditorTransform
,WebHyperLinkEditorTransform
,WizardTransform
public abstract class AbstractEditorTransform extends AbstractAppTransform
This abstract transform class is used as a base object that provides common and convenience methods used to render a bean as an editor. The class uses theEditor
to present the user with a window-like dialog. This dialog can contain a title, action buttons, and can be dragged and closed just like any window dialog in a non-web environment.This class is provided to make the construction of such dialogs easier. If one wants to display a bean as an editor, a transform class must extend this class and implement renderEditorContents, method responsible for generating the contents of the dialog. The other elements in the dialog, i.e. title, buttons, can be controlled by the use of formal parameters.
Notice that this class does not implement the LayoutTransform; subclasses might decide to do so, though, in these cases the layout will only be applied to the content of the editor.
- 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 java.lang.String
_helpTopic
protected java.lang.String
_helpType
FormalParameter
applyJS
Indicates JavaScript functionality to be invoked when 'Apply' buttons is pressed.FormalParameter
applyLabel
Indicates the apply label when no title id is provided.FormalParameter
applyLabelID
Indicates the apply label id according to the application's resource buldles.FormalParameter
canAutoSize
Indicates if editor should auto-size to show the contents.FormalParameter
cancelJS
Indicates JavaScript functionality to be invoked when 'Cancel' buttons is pressed.FormalParameter
cancelLabel
Indicates the cancel label when no title id is provided.FormalParameter
cancelLabelID
Indicates the cancel label id according to the application's resource buldles.FormalParameter
closeEvent
Indicates the close event to use by the close button.FormalParameter
closeImage
Indicates the image to use in the close button.FormalParameter
closeJS
Indicates JavaScript functionality to be invoked when 'Close' buttons is pressed.FormalParameter
closeLabel
Indicates the close label when no title id is provided.FormalParameter
closeLabelID
Indicates the close label id according to the application's resource buldles.FormalParameter
dhtmlClose
Indicates if the close action will be executed using dhtml.FormalParameter
disableOKButton
Indicates whether to disable the OK buttonFormalParameter
editorContentsStyle
Indicates the style name to be used for the div containing the editor contentsFormalParameter
editorElements
Indicates the elements to display by the editor.FormalParameter
editorLayoutFile
Indicates the name of the definition file associated with the editor.FormalParameter
editorSubType
Indicates the subtype to be used for the STY attribute for the editor containerstatic java.lang.String
FP_APPLY_JS
static java.lang.String
FP_APPLY_LABEL
static java.lang.String
FP_APPLY_LABEL_ID
static java.lang.String
FP_CAN_AUTO_SIZE
static java.lang.String
FP_CANCEL_JS
static java.lang.String
FP_CANCEL_LABEL
static java.lang.String
FP_CANCEL_LABEL_ID
static java.lang.String
FP_CLOSE_EVENT
static java.lang.String
FP_CLOSE_IMAGE
static java.lang.String
FP_CLOSE_JS
static java.lang.String
FP_CLOSE_LABEL
static java.lang.String
FP_CLOSE_LABEL_ID
static java.lang.String
FP_DHTML_CLOSE
static java.lang.String
FP_DISABLE_OK_BUTTON
static java.lang.String
FP_EDITOR_CONTENTS_STYLE
static java.lang.String
FP_EDITOR_ELEMENTS
static java.lang.String
FP_EDITOR_LAYOUT_FILE
static java.lang.String
FP_EDITOR_SUBTYPE
static java.lang.String
FP_HELP_PAGE
Deprecated.useuseFP_HELP_TYPE
static java.lang.String
FP_HELP_TOPIC
Constant specifying the name of the formal parameter for specifying the help topic for the help of the editorstatic java.lang.String
FP_HELP_TYPE
Constant specifying the type of the help file this editor should point tostatic java.lang.String
FP_INCLUDE_DYNAMIC_SCRIPT
static java.lang.String
FP_NAVIGATE_ON_SUBMIT
static java.lang.String
FP_OK_JS
static java.lang.String
FP_OK_LABEL
static java.lang.String
FP_OK_LABEL_ID
static java.lang.String
FP_RENDER_FORM
static java.lang.String
FP_TITLE_LABEL
static java.lang.String
FP_TITLE_LABEL_ID
static java.lang.String
FP_USE_JS_IN_BONE
FormalParameter
helpPage
Deprecated.usehelpType
FormalParameter
helpTopic
Indicates the help topic for the help page of the editor.FormalParameter
helpType
Indicates the type of help topic this editor uses.FormalParameter
includeDynamicScript
Indicates whether dynamic scripts will be included while rendering the page.FormalParameter
navigateOnSubmit
Indicates if the editor will move to a new page after the user clicks on the OK buttonFormalParameter
okJS
Indicates JavaScript functionality to be invoked when 'OK' buttons is pressed.FormalParameter
okLabel
Indicates the OK label when no title id is provided.FormalParameter
okLabelID
Indicates the OK label id according to the application's resource buldles.FormalParameter
renderForm
Indicates whether the editor will create its own form.FormalParameter
titleLabel
Indicates the title when no title id is provided.FormalParameter
titleLabelID
Indicates the title id according to the application's resource buldles.-
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 AbstractEditorTransform()
Default no-args constructor, initialize formal parameters.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected Tag
generateForm()
Tag
getDivTagAroundContents()
Wrap around the contents of an editor with a div that can set the overflow, style and subtype propertiesprotected java.lang.String
getEditorTitle()
protected java.lang.String
getOnSubmitJS()
Provides JS code to be executed on the "onsubmit" event of the HTML form.WebBeanError
getWebBeanErrorInfo()
protected void
initEditor(Editor editor)
Initializes the editor with the global settings.protected void
initHelp(Editor editor)
void
initializeTransform(Transformable data)
This method initializes the private and protected fields of the transform.void
renderEditor(MarkupOutput out)
Main method to render the output of an editorabstract void
renderEditorContents(MarkupOutput out)
Generates the graphical output for the Editorprotected MarkupOutput
renderEditorElement(Editor editor)
protected void
renderJavascript(MarkupOutput out)
This method should be used by the Editor transforms to generate any javascript necessary.protected void
setFocusFieldId(java.lang.String value)
void
transformForRequestInError(MarkupOutput out)
Transform when the status isIn Error
.void
transformForRequestSuccessful(MarkupOutput out)
Generates the graphical output for the Projects Bean-
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, getSupportedBeanType, 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.Transform
canTransform, getDescription, getFormalParams, getPreview, isPreviewAvailable, isResolved, supports, supports
-
-
-
-
Field Detail
-
FP_EDITOR_ELEMENTS
public static final java.lang.String FP_EDITOR_ELEMENTS
- See Also:
- Constant Field Values
-
FP_TITLE_LABEL_ID
public static final java.lang.String FP_TITLE_LABEL_ID
- See Also:
- Constant Field Values
-
FP_TITLE_LABEL
public static final java.lang.String FP_TITLE_LABEL
- See Also:
- Constant Field Values
-
FP_APPLY_LABEL_ID
public static final java.lang.String FP_APPLY_LABEL_ID
- See Also:
- Constant Field Values
-
FP_APPLY_LABEL
public static final java.lang.String FP_APPLY_LABEL
- See Also:
- Constant Field Values
-
FP_OK_LABEL_ID
public static final java.lang.String FP_OK_LABEL_ID
- See Also:
- Constant Field Values
-
FP_OK_LABEL
public static final java.lang.String FP_OK_LABEL
- See Also:
- Constant Field Values
-
FP_NAVIGATE_ON_SUBMIT
public static final java.lang.String FP_NAVIGATE_ON_SUBMIT
- Since:
- MicroStrategy Web 8.0.2
- See Also:
- Constant Field Values
-
FP_CANCEL_LABEL_ID
public static final java.lang.String FP_CANCEL_LABEL_ID
- See Also:
- Constant Field Values
-
FP_CANCEL_LABEL
public static final java.lang.String FP_CANCEL_LABEL
- See Also:
- Constant Field Values
-
FP_CLOSE_LABEL_ID
public static final java.lang.String FP_CLOSE_LABEL_ID
- See Also:
- Constant Field Values
-
FP_CLOSE_LABEL
public static final java.lang.String FP_CLOSE_LABEL
- See Also:
- Constant Field Values
-
FP_APPLY_JS
public static final java.lang.String FP_APPLY_JS
- See Also:
- Constant Field Values
-
FP_OK_JS
public static final java.lang.String FP_OK_JS
- See Also:
- Constant Field Values
-
FP_CANCEL_JS
public static final java.lang.String FP_CANCEL_JS
- See Also:
- Constant Field Values
-
FP_CLOSE_JS
public static final java.lang.String FP_CLOSE_JS
- See Also:
- Constant Field Values
-
FP_CLOSE_EVENT
public static final java.lang.String FP_CLOSE_EVENT
- See Also:
- Constant Field Values
-
FP_DHTML_CLOSE
public static final java.lang.String FP_DHTML_CLOSE
- See Also:
- Constant Field Values
-
FP_CLOSE_IMAGE
public static final java.lang.String FP_CLOSE_IMAGE
- See Also:
- Constant Field Values
-
FP_RENDER_FORM
public static final java.lang.String FP_RENDER_FORM
- See Also:
- Constant Field Values
-
FP_USE_JS_IN_BONE
public static final java.lang.String FP_USE_JS_IN_BONE
- See Also:
- Constant Field Values
-
FP_CAN_AUTO_SIZE
public static final java.lang.String FP_CAN_AUTO_SIZE
- See Also:
- Constant Field Values
-
FP_EDITOR_CONTENTS_STYLE
public static final java.lang.String FP_EDITOR_CONTENTS_STYLE
- See Also:
- Constant Field Values
-
FP_EDITOR_SUBTYPE
public static final java.lang.String FP_EDITOR_SUBTYPE
- See Also:
- Constant Field Values
-
FP_EDITOR_LAYOUT_FILE
public static final java.lang.String FP_EDITOR_LAYOUT_FILE
- See Also:
- Constant Field Values
-
FP_INCLUDE_DYNAMIC_SCRIPT
public static final java.lang.String FP_INCLUDE_DYNAMIC_SCRIPT
- See Also:
- Constant Field Values
-
FP_DISABLE_OK_BUTTON
public static final java.lang.String FP_DISABLE_OK_BUTTON
- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
editorElements
public FormalParameter editorElements
Indicates the elements to display by the editor. The flags are taken from theEnumEditorDisplayFlags
enumeration.
-
titleLabelID
public FormalParameter titleLabelID
Indicates the title id according to the application's resource buldles.
-
applyLabelID
public FormalParameter applyLabelID
Indicates the apply label id according to the application's resource buldles.
-
okLabelID
public FormalParameter okLabelID
Indicates the OK label id according to the application's resource buldles.
-
cancelLabelID
public FormalParameter cancelLabelID
Indicates the cancel label id according to the application's resource buldles.
-
closeLabelID
public FormalParameter closeLabelID
Indicates the close label id according to the application's resource buldles.
-
titleLabel
public FormalParameter titleLabel
Indicates the title when no title id is provided.
-
applyLabel
public FormalParameter applyLabel
Indicates the apply label when no title id is provided.
-
okLabel
public FormalParameter okLabel
Indicates the OK label when no title id is provided.
-
cancelLabel
public FormalParameter cancelLabel
Indicates the cancel label when no title id is provided.
-
closeLabel
public FormalParameter closeLabel
Indicates the close label when no title id is provided.
-
renderForm
public FormalParameter renderForm
Indicates whether the editor will create its own form.
-
editorLayoutFile
public FormalParameter editorLayoutFile
Indicates the name of the definition file associated with the editor.
-
applyJS
public FormalParameter applyJS
Indicates JavaScript functionality to be invoked when 'Apply' buttons is pressed.
-
okJS
public FormalParameter okJS
Indicates JavaScript functionality to be invoked when 'OK' buttons is pressed.
JS functions set on this parameter are expected to be defined on the JS bone rendered by this editor (defined byAbstractAppTransform.getScriptClass()
).
If the function set is not on the appropriate editor bone, it must be called as: "customJS('alert(\'in\');"
-
navigateOnSubmit
public FormalParameter navigateOnSubmit
Indicates if the editor will move to a new page after the user clicks on the OK button- Since:
- MicroStrategy Web 8.0.2
-
cancelJS
public FormalParameter cancelJS
Indicates JavaScript functionality to be invoked when 'Cancel' buttons is pressed.
JS functions set on this parameter are expected to be defined on the JS bone rendered by this editor (defined byAbstractAppTransform.getScriptClass()
).
If the function set is not on the appropriate editor bone, it must be called as: "customJS('alert(\'in\');"
-
closeJS
public FormalParameter closeJS
Indicates JavaScript functionality to be invoked when 'Close' buttons is pressed.
JS functions set on this parameter are expected to be defined on the JS bone rendered by this editor (defined byAbstractAppTransform.getScriptClass()
).
If the function set is not on the appropriate editor bone, it must be called as: "customJS('alert(\'in\');"
-
closeEvent
public FormalParameter closeEvent
Indicates the close event to use by the close button.
-
dhtmlClose
public FormalParameter dhtmlClose
Indicates if the close action will be executed using dhtml.
-
canAutoSize
public FormalParameter canAutoSize
Indicates if editor should auto-size to show the contents.
-
editorContentsStyle
public FormalParameter editorContentsStyle
Indicates the style name to be used for the div containing the editor contents
-
editorSubType
public FormalParameter editorSubType
Indicates the subtype to be used for the STY attribute for the editor container
-
closeImage
public FormalParameter closeImage
Indicates the image to use in the close button.
-
includeDynamicScript
public FormalParameter includeDynamicScript
Indicates whether dynamic scripts will be included while rendering the page.
Usage:
This is a Boolean formal parameter, where true indicates that the dynamic javascripts will be included, false otherwise.
-
disableOKButton
public FormalParameter disableOKButton
Indicates whether to disable the OK button- Since:
- MicroStrategy Web 9.0.0
-
_helpTopic
protected java.lang.String _helpTopic
- Since:
- MicroStrategy Web 9.0.0
-
_helpType
protected java.lang.String _helpType
- Since:
- MicroStrategy Web 9.0.0
-
helpPage
public FormalParameter helpPage
Deprecated.usehelpType
Indicates the sub-page for the help for the editor.- Since:
- MicroStrategy Web 8.0.2
-
helpType
public FormalParameter helpType
Indicates the type of help topic this editor uses.- Since:
- MicroStrategy Web 9.0.0
-
helpTopic
public FormalParameter helpTopic
Indicates the help topic for the help page of the editor.- Since:
- MicroStrategy Web 8.0.2
-
FP_HELP_PAGE
public static final java.lang.String FP_HELP_PAGE
Deprecated.useuseFP_HELP_TYPE
Constant specifying the name of the formal parameter for specifying the sub-page of the help for the editor- Since:
- MicroStrategy Web 8.0.2
- See Also:
- Constant Field Values
-
FP_HELP_TYPE
public static final java.lang.String FP_HELP_TYPE
Constant specifying the type of the help file this editor should point to- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
FP_HELP_TOPIC
public static final java.lang.String FP_HELP_TOPIC
Constant specifying the name of the formal parameter for specifying the help topic for the help of the editor- Since:
- MicroStrategy Web 8.0.2
- See Also:
- Constant Field Values
-
-
Method Detail
-
initializeTransform
public void initializeTransform(Transformable data)
This method initializes the private and protected fields of the transform.- Specified by:
initializeTransform
in interfaceAppTransform
- Overrides:
initializeTransform
in classAbstractAppTransform
- Parameters:
data
- bean that will be transformed
-
renderEditorContents
public abstract void renderEditorContents(MarkupOutput out)
Generates the graphical output for the Editor- Parameters:
out
-MarkupOutput
instance where to create the HTML output
-
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)
-
getWebBeanErrorInfo
public WebBeanError getWebBeanErrorInfo()
- Overrides:
getWebBeanErrorInfo
in classAbstractAppTransform
- Returns:
- the error info
- Since:
- MicroStrategy Web 8.0.1
- See Also:
AbstractAppTransform.getWebBeanErrorInfo()
-
transformForRequestSuccessful
public void transformForRequestSuccessful(MarkupOutput out)
Generates the graphical output for the Projects Bean- Specified by:
transformForRequestSuccessful
in classAbstractAppTransform
- Parameters:
out
-MarkupOutput
instance where to create the HTML output- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
renderEditor
public void renderEditor(MarkupOutput out)
Main method to render the output of an editor- Parameters:
out
-MarkupOutput
instance where to create the HTML output
-
generateForm
protected Tag generateForm()
- Since:
- MicroStrategy Web 9.0.0
-
getOnSubmitJS
protected java.lang.String getOnSubmitJS()
Provides JS code to be executed on the "onsubmit" event of the HTML form.
Used for customizations where an action is needed before the form is submitted.
Note: this is only used when the editor uses an event and not JS on the OK/Apply buttons. For those cases use the "okJS" or "applyJS" formal parameters- Returns:
- JS code to be executed on the "onsubmit" event of the HTML form.
- Since:
- MicroStrategy Web 8.1.2
-
initEditor
protected void initEditor(Editor editor)
Initializes the editor with the global settings.- Parameters:
editor
- theEditor
to modify.
-
initHelp
protected void initHelp(Editor editor)
- Since:
- MicroStrategy Web 9.0.0
-
getEditorTitle
protected java.lang.String getEditorTitle()
-
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.- Parameters:
out
-MarkupOutput
where the output should be rendered.
-
renderEditorElement
protected MarkupOutput renderEditorElement(Editor editor)
-
getDivTagAroundContents
public Tag getDivTagAroundContents()
Wrap around the contents of an editor with a div that can set the overflow, style and subtype properties- Returns:
Tag
DivTag instance that can be used to wrap around the contents
-
setFocusFieldId
protected void setFocusFieldId(java.lang.String value)
- Since:
- MicroStrategy Web 8.0.1
-
-