Class AbstractSubscriptionFolderBeanTransform
- java.lang.Object
-
- com.microstrategy.web.transform.AbstractTransform
-
- com.microstrategy.web.transform.AbstractLayoutTransform
-
- com.microstrategy.web.app.transforms.AbstractAppTransform
-
- com.microstrategy.web.app.transforms.AbstractSubscriptionFolderBeanTransform
-
- All Implemented Interfaces:
AppTransform
,Transform
- Direct Known Subclasses:
AbstractScheduleListTransform
,AbstractSubscriptionListTransform
public abstract class AbstractSubscriptionFolderBeanTransform extends AbstractAppTransform
This transform renders the list of Narrowcast Subscriptions from a SubscriptionFolderBean.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
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 int
_deliveryMode
protected java.lang.String
_imgActiveSortAscending
Deprecated.We no longer use these images.protected java.lang.String
_imgActiveSortDescending
Deprecated.We no longer use these images.protected java.lang.String
_imgDatamart
Deprecated.We no longer use these images.protected java.lang.String
_imgDocument
Deprecated.We no longer use these images.protected java.lang.String
_imgGraph
Deprecated.We no longer use these images.protected java.lang.String
_imgGrid
Deprecated.We no longer use these images.protected java.lang.String
_imgGridGraph
Deprecated.We no longer use these images.protected java.lang.String
_imgRwDocument
Deprecated.We no longer use these images.protected java.lang.String
_imgSortAscending
Deprecated.We no longer use these images.protected java.lang.String
_imgSortDescending
Deprecated.We no longer use these images.protected int
_levelFlag
protected int
_maxItemCount
protected SubscriptionFolderBean
_sfb
FormalParameter
activeSortAscendingImage
Deprecated.We no longer use these images.FormalParameter
activeSortDescendingImage
Deprecated.We no longer use these images.FormalParameter
datamartImage
Deprecated.We no longer use these images.FormalParameter
deliveryMode
Indicates which subscriptions this transform will be displaying based on delivery mode.FormalParameter
documentImage
Deprecated.We no longer use these images.static java.lang.String
FP_DELIVERY_MODE
static java.lang.String
FP_IMG_DATAMART
Deprecated.We no longer use these images.static java.lang.String
FP_IMG_DOCUMENT
Deprecated.We no longer use these images.static java.lang.String
FP_IMG_GRAPH
Deprecated.We no longer use these images.static java.lang.String
FP_IMG_GRID
Deprecated.We no longer use these images.static java.lang.String
FP_IMG_GRID_GRAPH
Deprecated.We no longer use these images.static java.lang.String
FP_IMG_RW_DOCUMENT
Deprecated.We no longer use these images.static java.lang.String
FP_IMG_SORT_ASC
Deprecated.We no longer use these images.static java.lang.String
FP_IMG_SORT_ASC_ACTIVE
Deprecated.We no longer use these images.static java.lang.String
FP_IMG_SORT_DESC
Deprecated.We no longer use these images.static java.lang.String
FP_IMG_SORT_DESC_ACTIVE
Deprecated.We no longer use these images.static java.lang.String
FP_LEVEL_FLAG
static java.lang.String
FP_MAX_ITEMS_COUNT
FormalParameter
graphImage
Deprecated.We no longer use these images.FormalParameter
gridGraphImage
Deprecated.We no longer use these images.FormalParameter
gridImage
Deprecated.We no longer use these images.static int
LEVEL_ALL
A flag to show all LEVEL items.static int
LEVEL_EDIT
Indicates to show a link to edit the subscriptionstatic int
LEVEL_ICON
Indicates to show the icon for the subscription.static int
LEVEL_NAME
Indicates to show the name of the target of the subscription.static int
LEVEL_OWNER
Indicates to show the time for the schedule message executionstatic int
LEVEL_PERSONALIZED
Indicates to show if the subscription is personalized (i.e., it has prompts).static int
LEVEL_RECIPIENT
Indicates to show the time for the schedule message executionstatic int
LEVEL_REMOVE
Indicates to show a link to delete the subscriptionstatic int
LEVEL_SORT_ICONS
Indicates to show the sorting iconsstatic int
LEVEL_SUBSCRIPTION_NAME
Indicates to show the subscription namestatic int
LEVEL_TIME
Indicates to show the time for the schedule message executionFormalParameter
levelFlag
Specifies what information is displayed for each subscription.FormalParameter
maxItemCount
Indicates how many subscriptions will be displayed in the list.FormalParameter
rwDocumentImage
Deprecated.We no longer use these images.FormalParameter
sortAscendingImage
Deprecated.We no longer use these images.FormalParameter
sortDescendingImage
Deprecated.We no longer use these images.-
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 AbstractSubscriptionFolderBeanTransform()
Default no-arg constructor, initialize formal parameters
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected boolean
checkLevel(int level)
protected JsonGenerator
generateBoneProperties(SimpleList list)
protected int
getFieldCount()
protected java.lang.String
getImageTooltip(WebObjectInfo object)
protected JsonGenerator
getJSGenerator()
java.lang.String
getPreferenceValue(java.lang.String preferenceName)
Convenience method that returns the value of a preference.SubscriptionFolderBean
getSubscriptionFolderBean()
java.lang.Class
getSupportedBeanType()
Returns the supported bean type.boolean
hasSubscriptions()
void
initializeImages()
Initialize the images to be used by this transform.void
initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.protected boolean
isDisplayInfoAvailable(WebObjectInfo target)
protected boolean
isEmpty()
abstract void
renderEmptyList(MarkupOutput out)
renders an empty listvoid
renderFooter(MarkupOutput out)
Render a general footer associated with this transform.void
renderImage(MarkupOutput out, java.lang.String image)
Renders a transform's imagevoid
renderImage(MarkupOutput out, java.lang.String image, java.lang.String title)
Renders a transform's imageabstract void
renderList(MarkupOutput out, SimpleList list)
renders the list of components in the SubscriptionFolderBeanvoid
renderPersonalViewSubscriptions(MarkupOutput out, boolean isPublic)
Renders the subscriptions with delivery modes specified Formal parameterdeliveryMode
will be overwritten by this methodvoid
renderShowMessage(MarkupOutput out)
protected void
renderSort(MarkupOutput out, int field)
void
renderSubscriptionsByDeliveryMode(MarkupOutput out, int mode)
Renders the subscriptions with delivery modes specified Formal parameterdeliveryMode
will be overwritten by this methodboolean
shouldShowPersonalViewSubscriptionsList(boolean isPublic)
boolean
shouldShowSubscriptionsList(int delMode)
void
transformForRequestSuccessful(MarkupOutput out)
Transform when the status isSuccessful
.-
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, getProjectID, getRefreshEvent, getRequestKeys, getResourcesFolder, getScriptClass, getStringValue, getStyleRequestContext, getStyleShellDiv, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, 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, 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, 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.Transform
canTransform, getDescription, getFormalParams, getPreview, isPreviewAvailable, isResolved, supports, supports
-
-
-
-
Field Detail
-
_sfb
protected SubscriptionFolderBean _sfb
- Since:
- MicroStrategy Web 8.0.0
-
LEVEL_ICON
public static final int LEVEL_ICON
Indicates to show the icon for the subscription.- See Also:
- Constant Field Values
-
LEVEL_NAME
public static final int LEVEL_NAME
Indicates to show the name of the target of the subscription.- See Also:
- Constant Field Values
-
LEVEL_PERSONALIZED
public static final int LEVEL_PERSONALIZED
Indicates to show if the subscription is personalized (i.e., it has prompts).- See Also:
- Constant Field Values
-
LEVEL_REMOVE
public static final int LEVEL_REMOVE
Indicates to show a link to delete the subscription- See Also:
- Constant Field Values
-
LEVEL_EDIT
public static final int LEVEL_EDIT
Indicates to show a link to edit the subscription- See Also:
- Constant Field Values
-
LEVEL_SORT_ICONS
public static final int LEVEL_SORT_ICONS
Indicates to show the sorting icons- See Also:
- Constant Field Values
-
LEVEL_TIME
public static final int LEVEL_TIME
Indicates to show the time for the schedule message execution- See Also:
- Constant Field Values
-
LEVEL_OWNER
public static final int LEVEL_OWNER
Indicates to show the time for the schedule message execution- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
LEVEL_RECIPIENT
public static final int LEVEL_RECIPIENT
Indicates to show the time for the schedule message execution- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
LEVEL_SUBSCRIPTION_NAME
public static final int LEVEL_SUBSCRIPTION_NAME
Indicates to show the subscription name- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
LEVEL_ALL
public static final int LEVEL_ALL
A flag to show all LEVEL items.- See Also:
- Constant Field Values
-
FP_IMG_GRAPH
public static final java.lang.String FP_IMG_GRAPH
Deprecated.We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.- See Also:
- Constant Field Values
-
FP_IMG_GRID
public static final java.lang.String FP_IMG_GRID
Deprecated.We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.- See Also:
- Constant Field Values
-
FP_IMG_DATAMART
public static final java.lang.String FP_IMG_DATAMART
Deprecated.We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.- Since:
- MicroStrategy Web 7.5.0
- See Also:
- Constant Field Values
-
FP_IMG_GRID_GRAPH
public static final java.lang.String FP_IMG_GRID_GRAPH
Deprecated.We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.- See Also:
- Constant Field Values
-
FP_IMG_DOCUMENT
public static final java.lang.String FP_IMG_DOCUMENT
Deprecated.We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.- See Also:
- Constant Field Values
-
FP_IMG_RW_DOCUMENT
public static final java.lang.String FP_IMG_RW_DOCUMENT
Deprecated.We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.- Since:
- MicroStrategy Web 7.5.0
- See Also:
- Constant Field Values
-
FP_IMG_SORT_ASC
public static final java.lang.String FP_IMG_SORT_ASC
Deprecated.We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.- See Also:
- Constant Field Values
-
FP_IMG_SORT_DESC
public static final java.lang.String FP_IMG_SORT_DESC
Deprecated.We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.- See Also:
- Constant Field Values
-
FP_IMG_SORT_ASC_ACTIVE
public static final java.lang.String FP_IMG_SORT_ASC_ACTIVE
Deprecated.We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.- See Also:
- Constant Field Values
-
FP_IMG_SORT_DESC_ACTIVE
public static final java.lang.String FP_IMG_SORT_DESC_ACTIVE
Deprecated.We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.- See Also:
- Constant Field Values
-
FP_LEVEL_FLAG
public static final java.lang.String FP_LEVEL_FLAG
- See Also:
- Constant Field Values
-
FP_MAX_ITEMS_COUNT
public static final java.lang.String FP_MAX_ITEMS_COUNT
- See Also:
- Constant Field Values
-
FP_DELIVERY_MODE
public static final java.lang.String FP_DELIVERY_MODE
- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
graphImage
public FormalParameter graphImage
Deprecated.We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.Name of the image used to indicate a graph subscription.
-
_imgGraph
protected java.lang.String _imgGraph
Deprecated.We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
-
gridImage
public FormalParameter gridImage
Deprecated.We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.Name of the image used to indicate a grid subscription.
-
_imgGrid
protected java.lang.String _imgGrid
Deprecated.We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
-
datamartImage
public FormalParameter datamartImage
Deprecated.We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.Name of the image used to indicate a datamart subscription.- Since:
- MicroStrategy Web 7.5.0
-
_imgDatamart
protected java.lang.String _imgDatamart
Deprecated.We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.- Since:
- MicroStrategy Web 7.5.0
-
gridGraphImage
public FormalParameter gridGraphImage
Deprecated.We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.Name of the image used to indicate a grid-graph subscription.
-
_imgGridGraph
protected java.lang.String _imgGridGraph
Deprecated.We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
-
documentImage
public FormalParameter documentImage
Deprecated.We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.Name of the image used to indicate a document subscription.
-
_imgDocument
protected java.lang.String _imgDocument
Deprecated.We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
-
rwDocumentImage
public FormalParameter rwDocumentImage
Deprecated.We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.Name of the image used to indicate a report writing document subscription.- Since:
- MicroStrategy Web 7.5.0
-
_imgRwDocument
protected java.lang.String _imgRwDocument
Deprecated.We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.- Since:
- MicroStrategy Web 7.5.0
-
sortAscendingImage
public FormalParameter sortAscendingImage
Deprecated.We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.Name of the image used to allow the user to perform an ascending sort.
If a column is not sorted we will render this image next to the column to allow the user to perform a ascending sort when the user clicks on it.
-
_imgSortAscending
protected java.lang.String _imgSortAscending
Deprecated.We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
-
sortDescendingImage
public FormalParameter sortDescendingImage
Deprecated.We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.Name of the image used to allow the user to perform a descending sort.
If a column is not sorted we will render this image next to the column to allow the user to perform a descending sort when the user clicks on it.
-
_imgSortDescending
protected java.lang.String _imgSortDescending
Deprecated.We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
-
activeSortAscendingImage
public FormalParameter activeSortAscendingImage
Deprecated.We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.Name of the image used to indicate that the current column is sorted in the ascending order.
If a column is sorted in the ascending order, we will render this image next to the column. If this image is clickable, we will sort the column in descending order on clicking on the image.
-
_imgActiveSortAscending
protected java.lang.String _imgActiveSortAscending
Deprecated.We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
-
activeSortDescendingImage
public FormalParameter activeSortDescendingImage
Deprecated.We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.Name of the image used to indicate that the current column is sorted in the descending order.
If a column is sorted in the descending order, we will render this image next to the column. If this image is clickable, we will sort the column in ascending order on clicking on the image.
-
_imgActiveSortDescending
protected java.lang.String _imgActiveSortDescending
Deprecated.We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
-
levelFlag
public FormalParameter levelFlag
Specifies what information is displayed for each subscription.
The information may include subscription target, edit link, delete link and other information. Multiple fields may be displayed at the same time. Which fields to show is indicated by a bitwise flag.
Allowed Values:
- Subscription Icon (could be grid/graph/grid-graph/document) = 1
- Subscription Target (the name of the report/document for which the subscription is created) = 2
- Personalized (indicates a sign which tells that the subscription is created by answering prompts) = 4
- Delete Link = 16
- Edit Link = 32
- Show sort icons (applicable only for list views) = 64
- Show the time when the schedule is executed (applicable only for web subscriptions) = 128
- Show every thing = 65535
Usage:
For example, if you want to specify display icon and target name only, then you would specify (1 + 2 = 3).
-
_levelFlag
protected int _levelFlag
-
maxItemCount
public FormalParameter maxItemCount
Indicates how many subscriptions will be displayed in the list.
This value will determine the number of subscriptions rendered in the list. Any negative value would display the entire list of subscriptions.
-
_maxItemCount
protected int _maxItemCount
-
deliveryMode
public FormalParameter deliveryMode
Indicates which subscriptions this transform will be displaying based on delivery mode.- Since:
- MicroStrategy Web 9.0.0
-
_deliveryMode
protected int _deliveryMode
- Since:
- MicroStrategy Web 9.0.0
-
-
Method Detail
-
initializeTransform
public void initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform. Extends initializeTransform by initializing the cache of this transform's Formal parameters.- Specified by:
initializeTransform
in interfaceAppTransform
- Overrides:
initializeTransform
in classAbstractAppTransform
- Parameters:
data
- the bean to transform.
-
initializeImages
public void initializeImages()
Initialize the images to be used by this transform.- Overrides:
initializeImages
in classAbstractAppTransform
-
isEmpty
protected boolean isEmpty()
- Since:
- MicroStrategy Web 8.1.1
-
transformForRequestSuccessful
public void transformForRequestSuccessful(MarkupOutput out)
Transform when the status isSuccessful
.- Specified by:
transformForRequestSuccessful
in classAbstractAppTransform
- Parameters:
out
- output by this transform- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
getImageTooltip
protected java.lang.String getImageTooltip(WebObjectInfo object)
- Since:
- MicroStrategy Web 8.0.2
-
renderEmptyList
public abstract void renderEmptyList(MarkupOutput out)
renders an empty list- Parameters:
out
- output by this transform
-
renderList
public abstract void renderList(MarkupOutput out, SimpleList list)
renders the list of components in the SubscriptionFolderBean- Parameters:
out
- output by this transform.list
- the list of subscriptions to render.
-
checkLevel
protected boolean checkLevel(int level)
- Parameters:
level
- The ID of the column to use. This is determined by the levelFlag FormalParameter Possible values are the LEVEL_ fieds, i.e:LEVEL_ICON
- Returns:
- true if the given level is defined in the levelFlag
-
getFieldCount
protected int getFieldCount()
- Returns:
- the number fields this transform is displaying, this will depend on the fields that are enabled through the levelFlags formal parameter
-
renderImage
public void renderImage(MarkupOutput out, java.lang.String image, java.lang.String title)
Renders a transform's image- Parameters:
out
- where to write the output of the method.image
- the image nametitle
- the title to use as tooltip.- Since:
- MicroStrategy Web 7.5.0
-
renderImage
public void renderImage(MarkupOutput out, java.lang.String image)
Renders a transform's image- Overrides:
renderImage
in classAbstractAppTransform
- Parameters:
out
- where to write the output of the method.image
- the image name
-
renderFooter
public void renderFooter(MarkupOutput out)
Render a general footer associated with this transform.- Parameters:
out
-MarkupOutput
instance where the transform's output will be saved.- Since:
- MicroStrategy Web 9.0.0
-
renderSort
protected void renderSort(MarkupOutput out, int field)
-
isDisplayInfoAvailable
protected boolean isDisplayInfoAvailable(WebObjectInfo target)
- Since:
- MicroStrategy Web 8.0.0
-
getSubscriptionFolderBean
public SubscriptionFolderBean getSubscriptionFolderBean()
- Returns:
- the bean being transformed.
-
getPreferenceValue
public java.lang.String getPreferenceValue(java.lang.String preferenceName)
Description copied from class:AbstractAppTransform
Convenience method that returns the value of a preference. If preferences are not available (in case, for example, the Transform is used outside Microstrategy Web), it returns an empty string.- Overrides:
getPreferenceValue
in classAbstractAppTransform
- Parameters:
preferenceName
- name of the preference- Returns:
- the bean being transformed.
- Since:
- MicroStrategy Web 7.5.0
-
getSupportedBeanType
public java.lang.Class getSupportedBeanType()
Returns the supported bean type. This abstract Transform supports allWebComponents
- Specified by:
getSupportedBeanType
in interfaceTransform
- Overrides:
getSupportedBeanType
in classAbstractAppTransform
- Returns:
WebComponent.class
-
renderSubscriptionsByDeliveryMode
public void renderSubscriptionsByDeliveryMode(MarkupOutput out, int mode)
Renders the subscriptions with delivery modes specified Formal parameterdeliveryMode
will be overwritten by this method- Parameters:
out
-MarkupOutput
instance where the HTML output will be savedmode
- int containing delivery mode fromEnumDSSXMLSubscriptionDeliveryType
- Since:
- MicroStrategy Web 9.0.0
-
getJSGenerator
protected JsonGenerator getJSGenerator()
-
generateBoneProperties
protected JsonGenerator generateBoneProperties(SimpleList list)
-
shouldShowSubscriptionsList
public boolean shouldShowSubscriptionsList(int delMode)
-
renderPersonalViewSubscriptions
public void renderPersonalViewSubscriptions(MarkupOutput out, boolean isPublic)
Renders the subscriptions with delivery modes specified Formal parameterdeliveryMode
will be overwritten by this method- Parameters:
out
-MarkupOutput
instance where the HTML output will be savedmode
- int containing delivery mode fromEnumDSSXMLSubscriptionDeliveryType
- Since:
- MicroStrategy Web 9.0.0
-
shouldShowPersonalViewSubscriptionsList
public boolean shouldShowPersonalViewSubscriptionsList(boolean isPublic)
-
hasSubscriptions
public boolean hasSubscriptions()
-
renderShowMessage
public void renderShowMessage(MarkupOutput out)
-
-