Class AbstractObjectExplorerTransform
- 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.AbstractObjectExplorerTransform
-
- All Implemented Interfaces:
AppTransform
,LayoutTransform
,Transform
- Direct Known Subclasses:
AbstractObjectExplorerTreeTransform
,DerivedElementsBrowserTransform
,XDADataExplorerTransform
public abstract class AbstractObjectExplorerTransform extends AbstractEditorTransform implements LayoutTransform
- Since:
- MicroStrategy Web 8.0.2
-
-
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
_imgCheck
protected ObjectExplorerBean
_oeBean
ObjectExplorerBean
being transformed by this classFormalParameter
checkImage
Formal parameter: The icon to use to submit the parent folders select box in HTML mode.FormalParameter
displayFormatPickerName
Indicates the id of a system picker that contains the possible display options for the data resultstatic java.lang.String
FP_CHECK_IMAGE
Name for the formal parameter:checkImage
static java.lang.String
FP_DISPLAY_FORMAT_PICKER_NAME
Constant specifying the name of the formal parameter for defining the id of a system picker that contains the possible display options.static java.lang.String
FP_INCREMENTAL_FETCH_NAV_TYPE
Constant specifying the name of the formal parameter for defining the navigation type for incremental fetch.static java.lang.String
FP_INCREMENTAL_FETCH_PAGE_BLOCK
Name for the formal parameter:incrementalFetchPageBlock
static java.lang.String
FP_SHOW_CURRENT_IN_ANCESTORS_LIST
Name for the formal parameter:showCurrentInAncestorsList
protected static java.lang.String
ID_POSTFIX
protected FormalParameter
incrementalFetchNavigationType
Formal parameter that specifies which type of incremental fetch navigation will be enabled.FormalParameter
incrementalFetchPageBlock
Formal parameter: Indicates the number of pages to show per block for incremental fetchFormalParameter
showCurrentInAncestorsList
Formal parameter: Inidcates whether to show the current item in the ancestors list-
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 AbstractObjectExplorerTransform()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected java.lang.StringBuffer
addAncestorsOptionsToSelectTag(SelectTag tag)
protected void
addCurrentFolderToAncestorList(SelectTag tag, java.lang.StringBuffer indentBuffer)
protected void
addOpenParentImg(Tag tag)
protected void
addOpenParentImg(Tag tag, boolean enabled)
protected java.util.ArrayList
getAncestorsOptionTags(java.lang.StringBuffer indentBuffer)
protected SelectTag
getAncestorsSelectTag()
Returns a >select<Tag
instance object containing the list\ of the object's ancestorsprotected int
getBlockPosition()
protected int
getBlockSize()
protected WebEvent
getBrowseEvent()
Returns a new instance of the event use for browsing across objectsprotected WebEvent
getChangeDisplayFormatEvent()
Returns a new instance of the event use to toggle the display formatprotected int
getChildCount()
protected abstract java.lang.String
getCssName(WebDisplayUnit du)
Retruns the css class to use on the container of the object presented in the list of contents.java.lang.String
getDescription()
Return description for this Transform.protected ClientSideHelper
getExplorerClientSideHelper()
Returns a the client side helper object that will be associated with the list ob objects to display.protected java.lang.String
getExplorerScriptClass()
Returns the javaScript class (bone) associated with the content's list.protected Tag
getForm(Tag content)
The method will check if the renderFOrm formal parameter is set to true, and if so it will create a new form tag, insert the contents passed as parameter and return the form.int
getGoToArgument()
protected java.util.ArrayList
getHiddenInputsEventList()
Returns the list of events that will be included in the hidden inputs section.java.lang.String
getID()
This method overwrites its super implementation so that when assigning different styles to the same transform we get the same unique ID as long as the base bean stays the sameprotected IncrementalFetch
getIncrementalFetchComponent()
Generate and initialize theIncrementalFetch
component that will enable navigating the different elements of the full list of results in case it is not displayed all together at the same time.protected WebEvent
getOKEvent()
Returns a new instance of the event use for the ok buttonprotected WebEvent
getOpenParentEvent()
Returns a new instance of the event use to go to open the object's parentprotected Tag
getOption(WebDisplayUnit du, java.lang.String indent)
Returns an option Tag containing the display unit provided.protected Tag
getSearchBox()
Returns the search box for the project browser MarkupOutputprotected Tag
getSearchButton()
Returns a Magnifier image as the search/filter button of the browser MarkupOutputprotected WebEvent
getSearchEvent()
Returns a new instance of the event use for searching objects in the Explorerprotected AnchorTag
getUnitAnchor(WebDisplayUnit du)
Returns an >a<Tag
instance that will allow th euser to "open" the given unit in the component.java.util.Map
getUnitAttributes(WebDisplayUnit du)
Returns a map containing the attributes to add to the container of every object in the list of contents.protected java.lang.String
getUnitDesc(WebDisplayUnit du)
Get theprotected java.lang.String
getUnitName(WebDisplayUnit du)
Renders only the name of the object passed as a parametervoid
initializeImages()
Initializes the name of the images to use on this transform's output.void
initializeTransform(Transformable data)
Initializes transform formal parametersboolean
isUseOptionTitle()
void
renderAncestors(MarkupOutput out)
Renders a select box containing a list of the folder's ancestorsvoid
renderChangeFormatDropDown(MarkupOutput out)
Method that renders the "show as" display optionvoid
renderDisplayFormatPickers(MarkupOutput out)
Method that renders the display format pickersvoid
renderEditorContents(MarkupOutput out)
Method that renders the editor contents corresponding to this Wizard.void
renderErrorMessage(MarkupOutput out)
void
renderHiddenInputs(MarkupOutput out)
Renders the hidden inputs of the events that can be handled by the beanvoid
renderIncrementalFetch(MarkupOutput out)
Renders the incremental fetch section of the componentvoid
renderLayeredIconInfo(MarkupOutput out, WebDisplayUnit unit)
generate a SPAN tag which host background image and an inner SPAN for the layering effect in case an additional image has to be included on top of the original (for example, a shortcut arrow, a red error sign, etc).void
renderObjectCount(MarkupOutput out)
Renders the total number of objects contianed by the component, regardless of any incremental fetch functionalityvoid
renderOpenParent(MarkupOutput out)
Renders a link to the folder's parentvoid
renderSearch(MarkupOutput out)
Renders the search section of the componentvoid
renderSearchBox(MarkupOutput out)
Renders the search box for the project browservoid
renderSearchButton(MarkupOutput out)
Renders a Magnifier image as the search/filter button of the browserprotected void
renderSearchEventArgs(MarkupOutput out)
Render hidden inputs for Search event argumentsvoid
renderUnit(MarkupOutput out, WebDisplayUnit du)
Returns the give unit in the component's contents list.void
setUseOptionTitle(boolean useTitle)
boolean
shouldDisplayErrorMessage()
protected boolean
shouldGenerateNewForm()
protected boolean
shouldShowDummyFolderOption()
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractEditorTransform
generateForm, getDivTagAroundContents, getEditorTitle, getOnSubmitJS, getWebBeanErrorInfo, initEditor, initHelp, renderEditor, renderEditorElement, renderJavascript, 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, getIntValue, getJSNameSpace, getLayoutContext, getLocale, getLocale, getPreferenceValue, getProjectID, getRefreshEvent, getRequestKeys, getResourcesFolder, getScriptClass, getStringValue, getStyleRequestContext, getStyleShellDiv, getSupportedBeanType, getTagsFactory, getTimeFormat, getUnitsLabel, hasSubBlock, initHeightAndWidthFromPreferences, initializeCss, 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, getPreview, getSupportedBeanType, isPreviewAvailable, isResolved, supports, supports, transform
-
-
-
-
Field Detail
-
ID_POSTFIX
protected static final java.lang.String ID_POSTFIX
- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
incrementalFetchNavigationType
protected FormalParameter incrementalFetchNavigationType
Formal parameter that specifies which type of incremental fetch navigation will be enabled. Allowed values: a valid bitwise combination ofEnumIncrementalFetchProperties.NAVIGATION_BUTTONS_FIRST_LAST
and/orEnumIncrementalFetchProperties.NAVIGATION_BUTTONS_PREVIOUS_NEXT
- Since:
- MicroStrategy Web 9.0.0
-
showCurrentInAncestorsList
public FormalParameter showCurrentInAncestorsList
Formal parameter: Inidcates whether to show the current item in the ancestors list
-
incrementalFetchPageBlock
public FormalParameter incrementalFetchPageBlock
Formal parameter: Indicates the number of pages to show per block for incremental fetch
-
displayFormatPickerName
public FormalParameter displayFormatPickerName
Indicates the id of a system picker that contains the possible display options for the data result- Since:
- MicroStrategy Web 9.0.0
-
checkImage
public FormalParameter checkImage
Formal parameter: The icon to use to submit the parent folders select box in HTML mode. Used only in HTML mode. For DHTML mode, the CSS contains the image- Since:
- MicroStrategy Web 9.0.0
-
FP_CHECK_IMAGE
public static final java.lang.String FP_CHECK_IMAGE
Name for the formal parameter:checkImage
- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
FP_DISPLAY_FORMAT_PICKER_NAME
public static final java.lang.String FP_DISPLAY_FORMAT_PICKER_NAME
Constant specifying the name of the formal parameter for defining the id of a system picker that contains the possible display options. Value is displayFormatPickerId.- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
FP_SHOW_CURRENT_IN_ANCESTORS_LIST
public static final java.lang.String FP_SHOW_CURRENT_IN_ANCESTORS_LIST
Name for the formal parameter:showCurrentInAncestorsList
- See Also:
- Constant Field Values
-
FP_INCREMENTAL_FETCH_PAGE_BLOCK
public static final java.lang.String FP_INCREMENTAL_FETCH_PAGE_BLOCK
Name for the formal parameter:incrementalFetchPageBlock
- See Also:
- Constant Field Values
-
FP_INCREMENTAL_FETCH_NAV_TYPE
public static final java.lang.String FP_INCREMENTAL_FETCH_NAV_TYPE
Constant specifying the name of the formal parameter for defining the navigation type for incremental fetch. Value is incrementalFetchNavigationType.- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
_oeBean
protected ObjectExplorerBean _oeBean
ObjectExplorerBean
being transformed by this class
-
_imgCheck
protected java.lang.String _imgCheck
- Since:
- MicroStrategy Web 9.0.0
-
-
Method Detail
-
isUseOptionTitle
public boolean isUseOptionTitle()
-
setUseOptionTitle
public void setUseOptionTitle(boolean useTitle)
-
initializeTransform
public void initializeTransform(Transformable data)
Initializes transform formal parameters- Specified by:
initializeTransform
in interfaceAppTransform
- Overrides:
initializeTransform
in classAbstractEditorTransform
- Parameters:
data
-Transformable
instance to be associated with this transform.
-
initializeImages
public void initializeImages()
Initializes the name of the images to use on this transform's output. For each one of the images defined to be displayed, the resource folder information is added to its path and file name as specified on the formal parameters for the images.- Overrides:
initializeImages
in classAbstractAppTransform
- Since:
- MicroStrategy Web 9.0.0
-
getDescription
public java.lang.String getDescription()
Return description for this Transform.- Specified by:
getDescription
in interfaceTransform
- Returns:
- description text.
-
renderAncestors
public void renderAncestors(MarkupOutput out)
Renders a select box containing a list of the folder's ancestors- Parameters:
out
- MarkupOutput
-
renderSearch
public void renderSearch(MarkupOutput out)
Renders the search section of the component- Parameters:
out
- MarkupOutput
-
renderSearchBox
public void renderSearchBox(MarkupOutput out)
Renders the search box for the project browser- Parameters:
out
- MarkupOutput
-
renderSearchButton
public void renderSearchButton(MarkupOutput out)
Renders a Magnifier image as the search/filter button of the browser- Parameters:
out
- MarkupOutput
-
renderSearchEventArgs
protected void renderSearchEventArgs(MarkupOutput out)
Render hidden inputs for Search event arguments
-
getUnitAttributes
public java.util.Map getUnitAttributes(WebDisplayUnit du)
Returns a map containing the attributes to add to the container of every object in the list of contents.- Parameters:
du
- WebDisplayUnit- Returns:
- Map
-
renderUnit
public void renderUnit(MarkupOutput out, WebDisplayUnit du)
Returns the give unit in the component's contents list.- Parameters:
out
- MarkupOutputdu
- WebDisplayUnit
-
renderObjectCount
public void renderObjectCount(MarkupOutput out)
Renders the total number of objects contianed by the component, regardless of any incremental fetch functionality- Parameters:
out
- MarkupOutput
-
renderOpenParent
public void renderOpenParent(MarkupOutput out)
Renders a link to the folder's parent- Parameters:
out
- MarkupOutput
-
addOpenParentImg
protected void addOpenParentImg(Tag tag)
- Since:
- MicroStrategy Web 9.0.0
-
addOpenParentImg
protected void addOpenParentImg(Tag tag, boolean enabled)
- Since:
- MicroStrategy Web 9.0.0
-
renderHiddenInputs
public void renderHiddenInputs(MarkupOutput out)
Renders the hidden inputs of the events that can be handled by the bean- Parameters:
out
- MarkupOutput
-
getIncrementalFetchComponent
protected IncrementalFetch getIncrementalFetchComponent()
Generate and initialize theIncrementalFetch
component that will enable navigating the different elements of the full list of results in case it is not displayed all together at the same time.- Returns:
IncrementalFetch
initialized instance- Since:
- MicroStrategy Web 9.0.0
-
getGoToArgument
public int getGoToArgument()
- Since:
- MicroStrategy Web 9.0.0
-
getBlockPosition
protected int getBlockPosition()
- Since:
- MicroStrategy Web 9.0.0
-
getBlockSize
protected int getBlockSize()
- Since:
- MicroStrategy Web 9.0.0
-
getChildCount
protected int getChildCount()
- Since:
- MicroStrategy Web 9.0.0
-
renderIncrementalFetch
public void renderIncrementalFetch(MarkupOutput out)
Renders the incremental fetch section of the component- Parameters:
out
- MarkupOutput
-
getExplorerClientSideHelper
protected ClientSideHelper getExplorerClientSideHelper()
Returns a the client side helper object that will be associated with the list ob objects to display. Note this is different from the getClientSideHelper() method which returns the ClientSideHelper instance for the entire component object.- Returns:
- ClientSideHelper
-
getOption
protected Tag getOption(WebDisplayUnit du, java.lang.String indent)
Returns an option Tag containing the display unit provided.- Parameters:
du
- WebDisplayUnit to openindent
- String
-
getUnitName
protected java.lang.String getUnitName(WebDisplayUnit du)
Renders only the name of the object passed as a parameter- Parameters:
du
- WebDisplayUnit
-
getUnitDesc
protected java.lang.String getUnitDesc(WebDisplayUnit du)
Get the- Parameters:
du
- WebDisplayUnit
-
getAncestorsSelectTag
protected SelectTag getAncestorsSelectTag()
Returns a >select<Tag
instance object containing the list\ of the object's ancestors- Returns:
- SelectTag
-
shouldShowDummyFolderOption
protected boolean shouldShowDummyFolderOption()
-
addCurrentFolderToAncestorList
protected void addCurrentFolderToAncestorList(SelectTag tag, java.lang.StringBuffer indentBuffer)
-
addAncestorsOptionsToSelectTag
protected java.lang.StringBuffer addAncestorsOptionsToSelectTag(SelectTag tag)
-
getAncestorsOptionTags
protected java.util.ArrayList getAncestorsOptionTags(java.lang.StringBuffer indentBuffer)
-
getSearchBox
protected Tag getSearchBox()
Returns the search box for the project browser MarkupOutput
-
getSearchButton
protected Tag getSearchButton()
Returns a Magnifier image as the search/filter button of the browser MarkupOutput
-
getBrowseEvent
protected WebEvent getBrowseEvent()
Returns a new instance of the event use for browsing across objects- Returns:
- WebEvent
-
getOKEvent
protected WebEvent getOKEvent()
Returns a new instance of the event use for the ok button- Returns:
- WebEvent
-
getOpenParentEvent
protected WebEvent getOpenParentEvent()
Returns a new instance of the event use to go to open the object's parent- Returns:
- WebEvent
-
getChangeDisplayFormatEvent
protected WebEvent getChangeDisplayFormatEvent()
Returns a new instance of the event use to toggle the display format- Returns:
- WebEvent
- Since:
- MicroStrategy Web 9.0.0
-
getSearchEvent
protected WebEvent getSearchEvent()
Returns a new instance of the event use for searching objects in the Explorer- Returns:
- WebEvent
-
getCssName
protected abstract java.lang.String getCssName(WebDisplayUnit du)
Retruns the css class to use on the container of the object presented in the list of contents.- Parameters:
du
- WebDisplayUnit- Returns:
- String
-
getExplorerScriptClass
protected java.lang.String getExplorerScriptClass()
Returns the javaScript class (bone) associated with the content's list.- Returns:
- String
-
getUnitAnchor
protected AnchorTag getUnitAnchor(WebDisplayUnit du)
Returns an >a<Tag
instance that will allow th euser to "open" the given unit in the component. This method is used in the component's contents list.- Parameters:
du
- WebDisplayUnit- Returns:
- AnchorTag
-
getHiddenInputsEventList
protected java.util.ArrayList getHiddenInputsEventList()
Returns the list of events that will be included in the hidden inputs section.- Returns:
- ArrayList
-
renderEditorContents
public void renderEditorContents(MarkupOutput out)
Method that renders the editor contents corresponding to this Wizard.- Specified by:
renderEditorContents
in classAbstractEditorTransform
- Parameters:
out
-MarkupOutput
instance where the HTML contents to render are to be saved.
-
renderDisplayFormatPickers
public void renderDisplayFormatPickers(MarkupOutput out)
Method that renders the display format pickers- Parameters:
out
-MarkupOutput
instance where the HTML contents to render are to be saved.- Since:
- MicroStrategy Web 9.0.0
-
renderChangeFormatDropDown
public void renderChangeFormatDropDown(MarkupOutput out)
Method that renders the "show as" display option- Parameters:
out
-MarkupOutput
instance where the HTML contents to render are to be saved.- Since:
- MicroStrategy Web 9.0.0
-
getForm
protected Tag getForm(Tag content)
The method will check if the renderFOrm formal parameter is set to true, and if so it will create a new form tag, insert the contents passed as parameter and return the form. If the formal parameter is set to false, the method return the same tag passed as parameter.- Parameters:
content
- Tag- Returns:
- Tag
- Since:
- MicroStrategy Web 9.0.0
-
shouldGenerateNewForm
protected boolean shouldGenerateNewForm()
- Since:
- MicroStrategy Web 9.0.0
-
shouldDisplayErrorMessage
public boolean shouldDisplayErrorMessage()
- Since:
- MicroStrategy Web 9.0.0
-
renderErrorMessage
public void renderErrorMessage(MarkupOutput out)
- Since:
- MicroStrategy Web 9.0.0
-
getID
public java.lang.String getID()
This method overwrites its super implementation so that when assigning different styles to the same transform we get the same unique ID as long as the base bean stays the same- Specified by:
getID
in interfaceTransform
- Overrides:
getID
in classAbstractAppTransform
- Returns:
- String the unqiue ID used by the place-holder DIV when doing iframe update.
- Since:
- MicroStrategy Web 9.0.0
-
renderLayeredIconInfo
public void renderLayeredIconInfo(MarkupOutput out, WebDisplayUnit unit)
generate a SPAN tag which host background image and an inner SPAN for the layering effect in case an additional image has to be included on top of the original (for example, a shortcut arrow, a red error sign, etc).- Parameters:
out
-MarkupOutput
instance where to save the contents to displayunit
-WebDisplayUnit
to be rendered.- Since:
- MicroStrategy Web 9.0.0
-
-