Class FolderIconRadioButtonTransform
- java.lang.Object
-
- com.microstrategy.web.transform.AbstractTransform
-
- com.microstrategy.web.transform.AbstractLayoutTransform
-
- com.microstrategy.web.app.transforms.AbstractAppTransform
-
- com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
-
- com.microstrategy.web.app.transforms.AbstractFolderTransform
-
- com.microstrategy.web.app.transforms.FolderIconRadioButtonTransform
-
- All Implemented Interfaces:
AppTransform
,LayoutTransform
,Transform
- Direct Known Subclasses:
FolderCreateReportXHTMLTransform
public class FolderIconRadioButtonTransform extends AbstractFolderTransform
This transform renders the contents of a folder as a list of objects with icons and radio buttons. The Radio button is only presented, though, if an eventId has been set to open the selected item.- Since:
- MicroStrategy Web 8.0.0
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractFolderTransform
AbstractFolderTransform.Context
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
FP_IMG_ANCHOR_JS_FLAG
Constant specifying the name of the formal parameter for defining the JS function to be invoked when selecting object image.static java.lang.String
FP_LABEL_ANCHOR_JS_FLAG
Constant specifying the name of the formal parameter for defining the JS function to be invoked when selecting object label name.static java.lang.String
FP_RENDER_FORM_TAG
FormalParameter
imgAnchorJS
Indicates whether or not to render an HTML anchor (JS method) surrounding object's image.FormalParameter
labelAnchorJS
Indicates whether or not to render an HTML anchor (JS method) surrounding object name.FormalParameter
renderFormTag
Indicates whether to render the form surrounding the folder contents.-
Fields inherited from class com.microstrategy.web.app.transforms.AbstractFolderTransform
_bandingIndex, _imgHeight, _imgWidth, _sortedChildUnits, datamartImage, documentImage, execTarget, filterImage, folderImage, FP_CREATE_REPORT_DISPLAY_SECTION, FP_DATAMART_IMAGE, FP_DOCUMENT_IMAGE, FP_EXEC_TARGET, FP_FILTER_IMAGE, FP_FOLDER_IMAGE, FP_GRAPH_IMAGE, FP_GRID_GRAPH_IMAGE, FP_IMAGE_HEIGTH, FP_IMAGE_WIDTH, FP_LEVEL_FLAG, FP_MAX_OBJECT_TYPE_COUNT, FP_REPORT_IMAGE, FP_RW_DOCUMENT_IMAGE, FP_SORT_ASCENDING, FP_SORT_FIELD, FP_TABLE_ID, FP_TEMPLATE_IMAGE, graphImage, gridGraphImage, imageHeight, imageWidth, LEVEL_ALL, LEVEL_CONFIRM_DELETE, LEVEL_DELETE, LEVEL_DESCRIPTION, LEVEL_DISPLAY_HEADERS, LEVEL_EDIT, LEVEL_EMPTY_FOLDER_MESSAGE, LEVEL_EXPORT_EXCEL, LEVEL_EXPORT_PDF, LEVEL_FOLDER_INFORMATION, LEVEL_INCREMENTAL_FETCH, LEVEL_LOCATION, LEVEL_MODIFIED, LEVEL_NAME, LEVEL_OWNER, LEVEL_SEND_NOW, LEVEL_SUBSCRIPTION, levelFlag, maxObjectTypeCount, reportImage, rwDocumentImage, sortAscending, sortField, tableId, templateImage
-
Fields inherited from class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
FP_INCREMENTAL_FETCH_NAV_TYPE, FP_INCREMENTAL_FETCH_PAGE_BLOCK, imgBlank, incrementalFetchNavigationType, incrementalFetchPageBlock
-
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 FolderIconRadioButtonTransform()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected AnchorTag
generateAnchor(WebEvent event)
Overwrites the parent method by setting special attributes if the event is not providedprotected Tag
generateRadioButtonForObject(WebEvent openEvent, WebObjectInfo object, boolean selected)
Generates the radio button for theWebObjectInfo
specified, according with theWebEvent
specified.java.lang.String
getDescription()
Return the description for this Transformprotected WebEvent
getOpenObjectEvent()
Creates and initializes aWebEvent
for having the object opened or run.void
renderDescriptionInfo(MarkupOutput out, WebObjectInfo object)
Renders the description information of the given object.protected void
renderFormInputInfo(MarkupOutput out, WebEvent openEvent)
Render any hidden input information that has to be added while displaying the contents in the folder, according with theWebEvent
specified.void
renderIconInfo(MarkupOutput out, WebObjectInfo object)
Renders the HTML code for displaying the image sthat will be associated with the object to show to the user.void
renderItems(MarkupOutput out)
Renders the contents of the provided foldervoid
renderList(MarkupOutput out, WebDisplayUnits list)
Deprecated.please use and customizeAbstractFolderTransform.renderList(MarkupOutput out)
instead since this method will not be called on future releases.void
renderNameInfo(MarkupOutput out, WebObjectInfo object)
Renders the name information of the given object.void
renderNextButton(MarkupOutput out)
Renders a button for allowing the selected object in the radio button list to be executed.void
renderObject(MarkupOutput out, WebObjectInfo object)
Renders theWebObjectInfo
object requested according to the specifications of this transform.void
renderObjectDescription(MarkupOutput out, WebObjectInfo object)
Deprecated.void
renderObjectImage(MarkupOutput out, WebObjectInfo object)
Deprecated.void
renderObjectName(MarkupOutput out, WebObjectInfo object)
Deprecated.void
transformForRequestSuccessful(MarkupOutput out)
Transforms the assosciatedWebBean
when its status isEnumRequestStatus.WebBeanRequestSuccessful
.boolean
wereItemsRendered()
Indicates if elements were rendered as part of this transform.-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractFolderTransform
addScriptDependency, canCreateSubscription, canDelete, canEdit, canExecute, canExport, canExportToPDF, canSendNow, checkLevel, getBlockPosition, getBlockSize, getChildCount, getContext, getContextMenu, getContextMenuAttributes, getDeleteEvent, getDeleteEvent, getEditEvent, getEvent, getExportEvent, getExportEvent, getFeatures, getFlashExportEvent, getFolderBean, getFolderChildCount, getGoToArgument, getGoToEvent, getHtmlExportEvent, getImageName, getImageSrc, getListComparator, getMstrExportEvent, getOringalChildCount, getPDFExportEvent, getSendNowEvent, getSortedChildUnits, getSortedList, getSubscriptionsEvent, getSupportedBeanType, getViewMediaReportEvent, getViewMediaRWEvent, initializeCss, initializeImages, initializeSelectedItemsList, initializeTransform, isEmptyList, isFeatureAvailable, isFolderEmpty, isObjectRunableinPauseMode, isObjectSelected, isObjectVisible, isViewableReport, newContext, renderEmptyList, renderEmptyList, renderImage, renderJavaScript, renderList, renderObjectCount, setBoneProperties
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
addCSSForObjectType, getCssName, getDereferenceShortcuts, getImageTooltip, getIncrementalFetchComponent, getListItemAttributes, getNameWrapperTag, getObjectAbbreviation, getObjectDescription, getObjectModificationTime, getObjectName, getOwnerName, getPathTransform, getVisualizationMode, getVisualizationMode, isUserEnabled, isVisualizationObject, isVisualizationObject, renderAbbreviationInfo, renderAbbreviationInfo, renderDescriptionInfo, renderIncrementalFetch, renderIsUserEnabled, renderIsUserEnabled, renderLayeredIconInfo, renderLayeredIconInfo, renderLocationInfo, renderModifiedInfo, renderOwnerInfo
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
addContactInfo, addDynamicScriptClass, addDynamicScriptFile, addFormalParameter, checkLevel, checkProcessingButtonsFlag, checkProcessingInfoFlag, checkStatus, displayError, displayError, displayError, emptyCell, excludeStaticTags, generateAnchorForExport, generateHiddenInputsForEvent, generateIFrameTag, getAppContext, getArgumentName, getAttributesShellDiv, getBeanPath, getBoneId, getCancelEvent, getClientSideHelper, getContainerServices, 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, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isIFrameDisplayMode, isIFrameEnabled, isIFrameRequest, isJobExpired, isModal, isOpen, isPortlet, isTrue, localIsIFrameDisplayMode, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, redirectToDisplayError, renderBean, renderBean, renderBean, renderBean, renderCancelButton, renderContextMenus, renderCssLink, renderDescriptor, renderDescriptor, renderErrorButton, renderHiddenInputFromRequest, renderLayout, renderProcessingButton, renderProcessingButton, renderProcessingButton, renderProcessingButtonForGet, renderProcessingButtonForGet, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoData, renderProcessingInfoImage, renderProcessingInfoSubtitle, renderProcessingInfoTitle, renderProcessingObjectName, renderRefreshButton, renderRegisterBone, renderSelf, renderShell, renderSubBlock, renderUserHelpAnchor, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, shouldDisplay, transform, transformForRequestCanceled, transformForRequestInError, 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
-
-
-
-
Field Detail
-
labelAnchorJS
public FormalParameter labelAnchorJS
Indicates whether or not to render an HTML anchor (JS method) surrounding object name.
This formal parameter will indicate a JS function name to be invoked when object link name is selected. It'll affect renderObjectName() function behavior. Default value is empty String
-
FP_LABEL_ANCHOR_JS_FLAG
public static final java.lang.String FP_LABEL_ANCHOR_JS_FLAG
Constant specifying the name of the formal parameter for defining the JS function to be invoked when selecting object label name.- See Also:
- Constant Field Values
-
imgAnchorJS
public FormalParameter imgAnchorJS
Indicates whether or not to render an HTML anchor (JS method) surrounding object's image.
This formal parameter will indicate a JS function name to be invoked when object's image is selected. It'll affect renderObjectImage() function behavior. Default value is empty String
-
renderFormTag
public FormalParameter renderFormTag
Indicates whether to render the form surrounding the folder contents.- Since:
- MicroStrategy Web 9.0.0
-
FP_IMG_ANCHOR_JS_FLAG
public static final java.lang.String FP_IMG_ANCHOR_JS_FLAG
Constant specifying the name of the formal parameter for defining the JS function to be invoked when selecting object image.- See Also:
- Constant Field Values
-
FP_RENDER_FORM_TAG
public static final java.lang.String FP_RENDER_FORM_TAG
- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
-
Method Detail
-
transformForRequestSuccessful
public void transformForRequestSuccessful(MarkupOutput out)
Description copied from class:AbstractFolderTransform
Transforms the assosciatedWebBean
when its status isEnumRequestStatus.WebBeanRequestSuccessful
.- Overrides:
transformForRequestSuccessful
in classAbstractFolderTransform
- Parameters:
out
-MarkupOutput
instance where the contents of this transform will be saved.- Since:
- MicroStrategy Web 8.0.1
- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
renderList
public void renderList(MarkupOutput out, WebDisplayUnits list)
Deprecated.please use and customizeAbstractFolderTransform.renderList(MarkupOutput out)
instead since this method will not be called on future releases.Renders the folder contents in a radio list button format with icons, consisting on a series ofDIV
HTML tags. All the objects will belong to a main FORM, which event specification is given by thegetOpenObjectEvent()
method. For submitting this FORM, a button will be displayed at the end of the list, specified by therenderNextButton()
method.- Specified by:
renderList
in classAbstractFolderTransform
- Parameters:
out
-MarkupOutput
instance to modify with the transform's output.list
-WebDisplayUnits
instance with the list of objects that will be rendered by this transform, as contents of the folder being analyzed.
-
wereItemsRendered
public boolean wereItemsRendered()
Indicates if elements were rendered as part of this transform.- Returns:
- boolean value indicating if elements were already rendered by this transform. For this
condition to be true, the
renderObjectName
method should have been already called and successfully generate a radio button for it. If overwritting therenderObjectName
method then this other method should also be updated.
-
renderItems
public void renderItems(MarkupOutput out)
Renders the contents of the provided folder- Parameters:
out
-MarkupOutput
instance to modify with the transform's output.
-
renderNextButton
public void renderNextButton(MarkupOutput out)
Renders a button for allowing the selected object in the radio button list to be executed.- Parameters:
out
-MarkupOutput
instance to modify with the transform's output.
-
getDescription
public java.lang.String getDescription()
Return the description for this Transform- Returns:
String
with the description for the transform.
-
renderObjectImage
public void renderObjectImage(MarkupOutput out, WebObjectInfo object)
Deprecated.Renders the HTML code for displaying the image sthat will be associated with the object to show to the user.
If imgAnchorJS formal parameter's value is different to empty String and DHTML is on, then label will be consisted of an HTML anchor that will invoke a JS function denoted by this formal parameter.- Parameters:
out
-MarkupOutput
instance to modify with the transform's output.object
-WebObjectInfo
instance being analyzed
-
renderIconInfo
public void renderIconInfo(MarkupOutput out, WebObjectInfo object)
Renders the HTML code for displaying the image sthat will be associated with the object to show to the user.
If imgAnchorJS formal parameter's value is different to empty String and DHTML is on, then label will be consisted of an HTML anchor that will invoke a JS function denoted by this formal parameter.- Overrides:
renderIconInfo
in classAbstractObjectInfoListTransform
- Parameters:
out
-MarkupOutput
instance to modify with the transform's output.object
-WebObjectInfo
instance being analyzed- Since:
- MicroStrategy Web 9.0.0
-
generateAnchor
protected AnchorTag generateAnchor(WebEvent event)
Overwrites the parent method by setting special attributes if the event is not provided- Overrides:
generateAnchor
in classAbstractAppTransform
- Parameters:
event
- WebEvent- Returns:
- AnchorTag
-
renderObjectName
public void renderObjectName(MarkupOutput out, WebObjectInfo object)
Deprecated.Renders the name information of the given object. Since it's a radio button transform, it will associate a radio button with the name label.
If labelAnchorJS formal parameter's value is different to empty String and DHTML is on, then label will be consisted of an HTML anchor that will invoke a JS function denoted by this formal parameter.- Parameters:
out
-MarkupOutput
instance to modify with the transform's output.object
-WebObjectInfo
instance being displayed
-
renderNameInfo
public void renderNameInfo(MarkupOutput out, WebObjectInfo object)
Renders the name information of the given object. Since it's a radio button transform, it will associate a radio button with the name label.
If labelAnchorJS formal parameter's value is different to empty String and DHTML is on, then label will be consisted of an HTML anchor that will invoke a JS function denoted by this formal parameter.- Overrides:
renderNameInfo
in classAbstractObjectInfoListTransform
- Parameters:
out
-MarkupOutput
instance to modify with the transform's output.object
-WebObjectInfo
instance being displayed- Since:
- MicroStrategy Web 9.0.0
-
renderObjectDescription
public void renderObjectDescription(MarkupOutput out, WebObjectInfo object)
Deprecated.Renders the description information of the given object.- Parameters:
out
-MarkupOutput
instance to modify with the transform's output.object
-WebObjectInfo
instance being displayed
-
renderDescriptionInfo
public void renderDescriptionInfo(MarkupOutput out, WebObjectInfo object)
Renders the description information of the given object.- Overrides:
renderDescriptionInfo
in classAbstractObjectInfoListTransform
- Parameters:
out
-MarkupOutput
instance to modify with the transform's output.object
-WebObjectInfo
instance being displayed- Since:
- MicroStrategy Web 9.0.0
-
renderObject
public void renderObject(MarkupOutput out, WebObjectInfo object)
Renders theWebObjectInfo
object requested according to the specifications of this transform.
Builds a series ofDIV
tags where the information coming from therenderObjectImage(com.microstrategy.web.beans.MarkupOutput, com.microstrategy.web.objects.WebObjectInfo)
,renderObjectName(com.microstrategy.web.beans.MarkupOutput, com.microstrategy.web.objects.WebObjectInfo)
andrenderObjectDescription(com.microstrategy.web.beans.MarkupOutput, com.microstrategy.web.objects.WebObjectInfo)
methods generate.- Overrides:
renderObject
in classAbstractObjectInfoListTransform
- Parameters:
out
-MarkupOutput
instance where to save the contents to displayobject
-WebObjectInfo
to be rendered.
-
getOpenObjectEvent
protected WebEvent getOpenObjectEvent()
Creates and initializes aWebEvent
for having the object opened or run.- Returns:
- a
WebEvent
instance initialized associated with theEnumReportBeanEvents.REPORT_EVENT_EXECUTE
event. Returnsnull
if the application does not support the event.
-
generateRadioButtonForObject
protected Tag generateRadioButtonForObject(WebEvent openEvent, WebObjectInfo object, boolean selected)
Generates the radio button for theWebObjectInfo
specified, according with theWebEvent
specified. If the event has been customized, then this method should also be overwritten for the event argument identifiers to be correct.- Parameters:
openEvent
-WebEvent
representing the action to do with the given objectobject
-WebObjectInfo
currently being processedselected
-boolean
indicating if the radio button should be selected or not- Returns:
- the
Tag
initialized instance corresponding to the radio button generated.
-
renderFormInputInfo
protected void renderFormInputInfo(MarkupOutput out, WebEvent openEvent)
Render any hidden input information that has to be added while displaying the contents in the folder, according with theWebEvent
specified. If the event has been customized, then this method should also be overwritten for the event argument identifiers to be correct.- Parameters:
out
-MarkupOutput
where the HTML output will be savedopenEvent
-WebEvent
representing the action to do with the given object
-
-