Class PathTransform
- java.lang.Object
-
- com.microstrategy.web.transform.AbstractTransform
-
- com.microstrategy.web.transform.AbstractLayoutTransform
-
- com.microstrategy.web.app.transforms.AbstractAppTransform
-
- com.microstrategy.web.app.transforms.PathTransform
-
- All Implemented Interfaces:
AppTransform
,LayoutTransform
,Transform
- Direct Known Subclasses:
AdminPathTransform
,CurrentItemTransform
,DesktopPathTransform
,DialogPathTransform
,MojoPathTransform
,PromptPathTransform
,ReportPathTransform
,RWPathTransform
public class PathTransform extends AbstractAppTransform implements LayoutTransform
This class is used to render the path section of a page.
It renders the Back/Forward buttons as well as links and information about the object being displayed in the current page.This class implements
LayoutTransform
which enables building the layout through an external xml configuration file.- Since:
- MicroStrategy Web 9.0.0
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
AbstractAppTransform.Context
-
-
Field Summary
Fields Modifier and Type Field Description protected WebEvent
_event
protected java.lang.String
_hiddenFolderCharacters
protected java.lang.String
_objectName
protected PathBean
_pathBean
protected boolean
_showLink
protected java.lang.String
cssItemNameCache
protected java.lang.String
cssUnselectedItemNameCache
FormalParameter
dividerCharacters
Indicates the character(s) to be used for separating each one of the different elements when displaying the path.static java.lang.String
FP_CHARS_FOR_DIVIDER
Constant specifying the name of the formal parameter for defining the dividing characters in between objects in the path.static java.lang.String
FP_CHARS_FOR_HIDDEN_FOLDERS
Constant specifying the name of the formal parameter for defining the characters to use instead of the names of folders that are hidden for the user.static java.lang.String
FP_IS_SELF_CONTAINED
Constant specifying the name of the formal parameter for defining if the object is self contained or not.static java.lang.String
FP_OPEN_DESKTOP_EVENT
static java.lang.String
FP_OPEN_FOLDER_IMAGE
Constant specifying the name of the formal parameter for defining the image to render before the current object is displayed.static java.lang.String
FP_SHOW_LINK
Constant specifying the name of the formal parameter for defining the showLink.FormalParameter
hiddenFolderCharacters
Indicates the character(s) to be used as placeholders when displaying a hidden folder inside the path.FormalParameter
isSelfContained
Indicates if the target bean of the current object being transformed should be used when generating the events that will be used for creating the links for accessing other folders.FormalParameter
openDesktopEvent
FormalParameter
openFolderImage
Indicates the image to use before displaying the current object on the path (if requested on thelevelFlag
formal parameter).FormalParameter
showLink
Indicates whether the object path contains a hyperlink to that object
Default value is booleanTRUE
which indicates the hyperlinks will be generated for each object path.-
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 PathTransform()
Default constructor, initialize formal parameters.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected boolean
canRenderHomeButtton()
protected boolean
canRenderParentUpButton()
protected AnchorTag
generateAnchor(WebEvent event)
Overwrites the parent method by setting the right event element value according to the formal parameters available on the transformWebFolder
getAncestorFolder()
Return theWebFolder
or the ancestor of the current object.
For instance: the folder that contains the current report.SimpleList
getAncestors()
Retrieves the ObjectBean's parent FolderBean.protected WebEvent
getBackButtonEvent()
Returns the open history page event used for the back button.protected WebEvent
getBrowseFolderEvent(WebFolder folder)
Returns the browser folder event.protected OMDCreateFolderBean
getCreateFolderBean()
java.lang.String
getDescription()
Return description for this Transformprotected WebEvent
getForwardButtonEvent()
Returns the open history page event used for the forward button.boolean
getHasAncestors()
Whether the current object has ancestorsprotected java.lang.String
getImageSrc(java.lang.String imgId)
Get the image source to display as part of the object path content.protected ObjectBean
getObjectBean()
Get the objectBean target of this transformprotected java.util.Map<java.lang.String,java.lang.Object>
getObjectNameAndEvent(boolean useObjectName, boolean showLink)
java.util.List
getObjectPathFolderAncestors(int rootIndex)
Returns all the ancestors of the current objectjava.util.List
getObjectPathFolderAncestors(int rootIndex, boolean order, boolean excludeParent)
Returns all the ancestors of the current objectprotected WebObjectsFactory
getObjectsFactory()
protected WebEvent
getOpenCreateFolderEvent()
protected WebEvent
getOpenDesktopEvent()
Returns the open desktop event.protected WebEvent
getOpenHistoryPage(java.lang.String relativePageNumber)
protected WebEvent
getOpenHomeEvent()
Returns the open home event.protected java.util.Map<java.lang.String,java.lang.Object>
getParentEventAndDesc()
Get the WebEvent and descption of parent folder.FolderBean
getParentFolderBean()
Retrieves the ObjectBean's parent FolderBean.protected ServletWebComponent
getServletWebComponent()
protected java.lang.String
getSpecialFolderName(WebFolder folder)
Check for special folders, if found one, return the descriptor.java.lang.String
getStyleShellDiv()
Overwrites the parent method by changin the default style's display to be "inline".java.lang.Class
getSupportedBeanType()
Returns the supported bean type.protected int
getSysFolderID()
Returns the system folder ID (NamedFolder) that is in the hierarchy of the object beanvoid
initializeCss()
Initialize the css class used by this transform.void
initializeImages()
Initialize images, basically it prefix them with the global folderNamevoid
initializeTransform(Transformable data)
Transform the Folder Bean and append the output to MarkupOutputprotected boolean
isAncestorNamedFolder(int folderName)
protected boolean
isFolderRoot(WebFolder folder)
protected boolean
isNewObject()
boolean
isSpecialFolder()
Checks if the current object is a special folderprotected boolean
isTemplateFolder(WebFolder parentFolder)
Check whether the parent folder of current object is one of the templates folders.void
renderAncestor(MarkupOutput out, WebFolder folder)
Renders the WebFolder object name w/o the hyperlink to that foldervoid
renderAncestors(MarkupOutput out, int rootIndex)
Renders the folder ancestors as pathvoid
renderBackButton(MarkupOutput out)
Renders a Back button link, it uses the openHistoryPage event for this.void
renderCreateFolderButton(MarkupOutput out)
Renders the button to create a foldervoid
renderCurrentItem(MarkupOutput out)
Renders the curent itemvoid
renderFolder(MarkupOutput out, WebFolder folder, SimpleList ancestors, int currentAncestor, boolean showLink)
Render a specific folder.void
renderFolder(MarkupOutput out, WebFolder folder, SimpleList ancestors, int currentAncestor, boolean showLink, boolean showDivider)
Render a specific folder.void
renderForwardButton(MarkupOutput out)
Renders a Forward button link, it uses the openHistoryPage event for this.void
renderHomeButton(MarkupOutput out)
Renders a button link to Home, it uses the openDesktopEvent for this.void
renderLinkForDesktop(MarkupOutput out)
Renders the link the Desktop (start) page.void
renderLinkForHome(MarkupOutput out)
Renders the link to Home, it uses the openHomeEvent for this.void
renderNewLine(MarkupOutput out)
Renders a new list before the item's name.void
renderObjectName(MarkupOutput out)
Renders the current objects name (i.e.void
renderOpenFolderImage(MarkupOutput out)
Renders the open folder image.void
renderParent(MarkupOutput out)
Renders the parent foldervoid
renderParentFolderDelimiter(MarkupOutput out)
Renders the delimiter between the folder names The divider character is set through Formal Parametervoid
renderParentUpButton(MarkupOutput out)
Renders a button link to the parent folders.protected void
renderSimpleButton(MarkupOutput out, WebEvent event, java.lang.String descriptor, java.lang.String id)
protected void
renderSimpleButton(MarkupOutput out, WebEvent event, java.lang.String descriptor, java.lang.String id, java.lang.String src)
protected void
renderSimpleLink(MarkupOutput out, WebEvent event, java.lang.String descriptor, java.lang.String css, boolean showLink)
Renders a link based on the event.protected void
renderSimpleLink(MarkupOutput out, WebEvent event, java.lang.String descriptor, java.lang.String css, boolean showLink, boolean showDivider)
Renders a link based on the event.void
renderTitle(MarkupOutput out)
Renders the title, uses descriptor 51: You are here:protected void
setBoneProperties(JsonGenerator boneProps)
Sets the necessary properties to the bone assigned to this transform (based on theAbstractAppTransform.scriptClass
formal parameter)
Usually called byAbstractAppTransform.renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.void
setHasAncestors(boolean value)
Sets whether the current object has ancestorsprotected boolean
shouldDisableBackButton()
void
transformForRequestInError(MarkupOutput out)
Overwrites by ignoring the state and rendering as the status was succesful.void
transformForRequestProcessing(MarkupOutput out)
Overwrites by ignoring the state and rendering as the status was succesful.void
transformForRequestSuccessful(MarkupOutput out)
Transform when the status is "Successful".void
transformForRequestWaitingForUserInput(MarkupOutput out)
Overwrites by ignoring the state and rendering as the status was succesful.protected boolean
useParentAncestors()
-
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, 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, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, 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, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, shouldDisplay, transform, transformForRequestCanceled, transformForRequestNotInited
-
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
-
showLink
public FormalParameter showLink
Indicates whether the object path contains a hyperlink to that object
Default value is booleanTRUE
which indicates the hyperlinks will be generated for each object path.
-
dividerCharacters
public FormalParameter dividerCharacters
Indicates the character(s) to be used for separating each one of the different elements when displaying the path.
These characters will be displayed after each element except the last one, for indicating a hierarchy between the folders shown.
Usage: Default value is >. The value to assign to this formal parameter has to be HTML compatible for it to be displayed correctly on the final HTML page.
-
hiddenFolderCharacters
public FormalParameter hiddenFolderCharacters
Indicates the character(s) to be used as placeholders when displaying a hidden folder inside the path.
These characters will be displayed instead of the hidden folder name without link associated with it since the user does not have enough privileges for accessing it. If there are two or more hidden folders one after the other, these characters will be displayed only once. Usage: Default value is [ ...]. The value to assign to this formal parameter has to be HTML compatible for it to be displayed correctly on the final HTML page.
-
_hiddenFolderCharacters
protected java.lang.String _hiddenFolderCharacters
-
isSelfContained
public FormalParameter isSelfContained
Indicates if the target bean of the current object being transformed should be used when generating the events that will be used for creating the links for accessing other folders.
Default value is booleanTRUE
which indicates this object will be the source for the links to render.
-
openFolderImage
public FormalParameter openFolderImage
Indicates the image to use before displaying the current object on the path (if requested on thelevelFlag
formal parameter).
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
openDesktopEvent
public FormalParameter openDesktopEvent
-
FP_SHOW_LINK
public static final java.lang.String FP_SHOW_LINK
Constant specifying the name of the formal parameter for defining the showLink. Value is showLink .- See Also:
- Constant Field Values
-
FP_CHARS_FOR_DIVIDER
public static final java.lang.String FP_CHARS_FOR_DIVIDER
Constant specifying the name of the formal parameter for defining the dividing characters in between objects in the path. Value is dividerCharacters.- See Also:
- Constant Field Values
-
FP_CHARS_FOR_HIDDEN_FOLDERS
public static final java.lang.String FP_CHARS_FOR_HIDDEN_FOLDERS
Constant specifying the name of the formal parameter for defining the characters to use instead of the names of folders that are hidden for the user. Value is hiddenFolderCharacters.- See Also:
- Constant Field Values
-
FP_OPEN_FOLDER_IMAGE
public static final java.lang.String FP_OPEN_FOLDER_IMAGE
Constant specifying the name of the formal parameter for defining the image to render before the current object is displayed. Value is openFolderImage.- See Also:
- Constant Field Values
-
FP_IS_SELF_CONTAINED
public static final java.lang.String FP_IS_SELF_CONTAINED
Constant specifying the name of the formal parameter for defining if the object is self contained or not. Value is isSelfContained.- See Also:
- Constant Field Values
-
FP_OPEN_DESKTOP_EVENT
public static final java.lang.String FP_OPEN_DESKTOP_EVENT
- See Also:
- Constant Field Values
-
cssItemNameCache
protected java.lang.String cssItemNameCache
-
cssUnselectedItemNameCache
protected java.lang.String cssUnselectedItemNameCache
-
_showLink
protected boolean _showLink
-
_objectName
protected java.lang.String _objectName
-
_event
protected WebEvent _event
-
_pathBean
protected PathBean _pathBean
-
-
Method Detail
-
initializeTransform
public void initializeTransform(Transformable data)
Transform the Folder Bean and append the output to MarkupOutput- Specified by:
initializeTransform
in interfaceAppTransform
- Overrides:
initializeTransform
in classAbstractAppTransform
- Parameters:
data
- the folder bean to transform
-
transformForRequestProcessing
public void transformForRequestProcessing(MarkupOutput out)
Overwrites by ignoring the state and rendering as the status was succesful. ObjectBeans, even when their processing, should already have their path info.- Overrides:
transformForRequestProcessing
in classAbstractAppTransform
- Parameters:
out
-MarkupOutput
instance that will be the output by this transform- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
transformForRequestWaitingForUserInput
public void transformForRequestWaitingForUserInput(MarkupOutput out)
Overwrites by ignoring the state and rendering as the status was succesful. ObjectBeans, even when their processing, should already have their path info.- Overrides:
transformForRequestWaitingForUserInput
in classAbstractAppTransform
- Parameters:
out
-MarkupOutput
instance that will be the output by this transform- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
transformForRequestInError
public void transformForRequestInError(MarkupOutput out)
Overwrites by ignoring the state and rendering as the status was succesful. ObjectBeans, even when their processing, should already have their path info.- Overrides:
transformForRequestInError
in classAbstractAppTransform
- Parameters:
out
-MarkupOutput
instance that will be the output by this transform- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
getDescription
public java.lang.String getDescription()
Return description for this Transform- Specified by:
getDescription
in interfaceTransform
- Returns:
- description for the transform
-
transformForRequestSuccessful
public void transformForRequestSuccessful(MarkupOutput out)
Transform when the status is "Successful". If a Layout is specified, it delegates execution to the layout-pareser, otherwise, otherwise it callsrenderContent
.- Specified by:
transformForRequestSuccessful
in classAbstractAppTransform
- Parameters:
out
- aMarkupOutput
instance with the HTML output by this transform- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
setBoneProperties
protected void setBoneProperties(JsonGenerator boneProps)
Description copied from class:AbstractAppTransform
Sets the necessary properties to the bone assigned to this transform (based on theAbstractAppTransform.scriptClass
formal parameter)
Usually called byAbstractAppTransform.renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.- Overrides:
setBoneProperties
in classAbstractAppTransform
- Parameters:
boneProps
- the JsonGenerator object that contains the collection of bone properties.
-
renderTitle
public void renderTitle(MarkupOutput out)
Renders the title, uses descriptor 51: You are here:- Parameters:
out
- the transform's output
-
renderLinkForHome
public void renderLinkForHome(MarkupOutput out)
Renders the link to Home, it uses the openHomeEvent for this.- Parameters:
out
- the transform's output
-
renderLinkForDesktop
public void renderLinkForDesktop(MarkupOutput out)
Renders the link the Desktop (start) page.- Parameters:
out
- the transform's output
-
getAncestorFolder
public WebFolder getAncestorFolder()
Return theWebFolder
or the ancestor of the current object.
For instance: the folder that contains the current report.- Returns:
- the
WebFolder
or the ancestor of the current object.
-
renderCurrentItem
public void renderCurrentItem(MarkupOutput out)
Renders the curent item- Parameters:
out
- the transform's output
-
renderObjectName
public void renderObjectName(MarkupOutput out)
Renders the current objects name (i.e. report name)- Parameters:
out
- the transform's output
-
getObjectNameAndEvent
protected java.util.Map<java.lang.String,java.lang.Object> getObjectNameAndEvent(boolean useObjectName, boolean showLink)
-
initializeImages
public void initializeImages()
Initialize images, basically it prefix them with the global folderName- Overrides:
initializeImages
in classAbstractAppTransform
-
initializeCss
public void initializeCss()
Initialize the css class used by this transform.- Overrides:
initializeCss
in classAbstractAppTransform
-
getParentFolderBean
public FolderBean getParentFolderBean()
Retrieves the ObjectBean's parent FolderBean. This is the Bean from where we need to get the ancestors from.- Returns:
- the parent's folder bean
-
getAncestors
public SimpleList getAncestors()
Retrieves the ObjectBean's parent FolderBean. This is the Bean from where we need to get the ancestors from.- Returns:
- the parent's folder bean
-
isNewObject
protected boolean isNewObject()
-
isTemplateFolder
protected boolean isTemplateFolder(WebFolder parentFolder)
Check whether the parent folder of current object is one of the templates folders.- Parameters:
folderId
-- Returns:
-
getObjectsFactory
protected WebObjectsFactory getObjectsFactory()
-
getSupportedBeanType
public java.lang.Class getSupportedBeanType()
Description copied from class:AbstractAppTransform
Returns the supported bean type. This abstract Transform supports allWebComponents
so every sub-class should override this method to return the class of theBean
the Transform is expecting, for example:public class CustomReportClass extends AbstractAppTransform { public Class getSupportedBeanType() { //This Transform is expected to work only with a ReportBean, //therefore this method needs to return this class: return ReportBean.class; } }
- Specified by:
getSupportedBeanType
in interfaceTransform
- Overrides:
getSupportedBeanType
in classAbstractAppTransform
- Returns:
- a root class/interface supported by this transform.
-
getHasAncestors
public boolean getHasAncestors()
Whether the current object has ancestors- Returns:
- whether the current object has ancestors
-
setHasAncestors
public void setHasAncestors(boolean value)
Sets whether the current object has ancestors- Parameters:
value
-
-
getOpenHomeEvent
protected WebEvent getOpenHomeEvent()
Returns the open home event.- Returns:
- The
EnumServletEvents.WebEventOpenHome
event.
-
getBackButtonEvent
protected WebEvent getBackButtonEvent()
Returns the open history page event used for the back button.- Returns:
- The
EnumServletEvents.WebEventOpenHistoryPage
event.
-
getForwardButtonEvent
protected WebEvent getForwardButtonEvent()
Returns the open history page event used for the forward button.- Returns:
- The
EnumServletEvents.WebEventOpenHistoryPage
event.
-
getOpenHistoryPage
protected WebEvent getOpenHistoryPage(java.lang.String relativePageNumber)
-
getOpenDesktopEvent
protected WebEvent getOpenDesktopEvent()
Returns the open desktop event.- Returns:
- The
EnumServletEvents.WebEventOpenDefaultDesktop
event.
-
getBrowseFolderEvent
protected WebEvent getBrowseFolderEvent(WebFolder folder)
Returns the browser folder event.- Parameters:
folder
- the folder to browse- Returns:
- The
EnumFolderBeanEvents.FOLDER_EVENT_BROWSE
event.
-
getSysFolderID
protected int getSysFolderID()
Returns the system folder ID (NamedFolder) that is in the hierarchy of the object bean- Returns:
- String EnumDSSXMLFolderNames value.
-
isAncestorNamedFolder
protected boolean isAncestorNamedFolder(int folderName) throws WebObjectsException, java.lang.UnsupportedOperationException
- Throws:
WebObjectsException
java.lang.UnsupportedOperationException
-
renderFolder
public void renderFolder(MarkupOutput out, WebFolder folder, SimpleList ancestors, int currentAncestor, boolean showLink)
Render a specific folder. This is a recursive function that calls itself to render the parent.
It calls recursively until it finds the root folder. If theLEVEL_DESKTOP_LINK
level is set, instead of stopping in the root folder, it stops in its first child.- Parameters:
out
- the transform's outputfolder
- the current folderancestors
- the list of ancestorscurrentAncestor
- the index of this folder in the list of ancestorsshowLink
- whether to render a link for the folder.
-
renderFolder
public void renderFolder(MarkupOutput out, WebFolder folder, SimpleList ancestors, int currentAncestor, boolean showLink, boolean showDivider)
Render a specific folder. This is a recursive function that calls itself to render the parent.
It calls recursively until it finds the root folder. If theLEVEL_DESKTOP_LINK
level is set, instead of stopping in the root folder, it stops in its first child.- Parameters:
out
- the transform's outputfolder
- the current folderancestors
- the list of ancestorscurrentAncestor
- the index of this folder in the list of ancestorsshowLink
- whether to render a link for the folder.
-
getObjectBean
protected ObjectBean getObjectBean()
Get the objectBean target of this transform- Returns:
- the
FolderBean
instance used with this transform
-
useParentAncestors
protected boolean useParentAncestors()
-
renderNewLine
public void renderNewLine(MarkupOutput out)
Renders a new list before the item's name. This might be controlled through a formal parameter- Parameters:
out
- the transform's output
-
renderOpenFolderImage
public void renderOpenFolderImage(MarkupOutput out)
Renders the open folder image.- Parameters:
out
- the transform's output
-
isFolderRoot
protected boolean isFolderRoot(WebFolder folder)
-
getSpecialFolderName
protected java.lang.String getSpecialFolderName(WebFolder folder)
Check for special folders, if found one, return the descriptor. It also checks if the Shared Reports folder, using preferences, has been specified as other folder.- Parameters:
folder
- the folder to check- Returns:
- a String with the descriptor to use if it's a special folder, null otherwise.
-
getServletWebComponent
protected ServletWebComponent getServletWebComponent()
-
getStyleShellDiv
public java.lang.String getStyleShellDiv()
Overwrites the parent method by changin the default style's display to be "inline".- Overrides:
getStyleShellDiv
in classAbstractAppTransform
- See Also:
AbstractAppTransform.renderShell(com.microstrategy.web.beans.MarkupOutput)
-
getImageSrc
protected java.lang.String getImageSrc(java.lang.String imgId)
Get the image source to display as part of the object path content. This method is called only when the user has turned on Accessibility mode under Preferences.- Parameters:
imgId
- String indicating the ID of the image from where the source should be calculated. For example, values liketbHome
ortbReturn
are expected- Returns:
- String with the source to use for the image to display.
-
renderHomeButton
public void renderHomeButton(MarkupOutput out)
Renders a button link to Home, it uses the openDesktopEvent for this.- Parameters:
out
- the transform's output
-
shouldDisableBackButton
protected boolean shouldDisableBackButton()
-
renderBackButton
public void renderBackButton(MarkupOutput out)
Renders a Back button link, it uses the openHistoryPage event for this.- Parameters:
out
- the transform's output
-
renderForwardButton
public void renderForwardButton(MarkupOutput out)
Renders a Forward button link, it uses the openHistoryPage event for this.- Parameters:
out
- the transform's output
-
canRenderHomeButtton
protected boolean canRenderHomeButtton()
-
canRenderParentUpButton
protected boolean canRenderParentUpButton()
-
renderParentUpButton
public void renderParentUpButton(MarkupOutput out)
Renders a button link to the parent folders.- Parameters:
out
- the transform's output
-
getParentEventAndDesc
protected java.util.Map<java.lang.String,java.lang.Object> getParentEventAndDesc()
Get the WebEvent and descption of parent folder.- Returns:
- a map contains upEvent and desc
-
renderCreateFolderButton
public void renderCreateFolderButton(MarkupOutput out)
Renders the button to create a folder- Parameters:
out
- the transform's output
-
renderAncestors
public void renderAncestors(MarkupOutput out, int rootIndex)
Renders the folder ancestors as path- Parameters:
out
- the transform's outputrootIndex
- , indicates the starting index of the ancestors For example, desktop link is the highest ancestor with index of 0; by specifying rootIndex=1, the desktop link won't be rendered
-
isSpecialFolder
public boolean isSpecialFolder() throws WebBeanException
Checks if the current object is a special folder- Returns:
- boolean indicating whether it is a sepcial folder.
- Throws:
WebBeanException
-
getObjectPathFolderAncestors
public java.util.List getObjectPathFolderAncestors(int rootIndex)
Returns all the ancestors of the current object- Parameters:
rootIndex
- , indicates the starting index of the ancestor- Returns:
- a list of ancestors, the order is top down, the first ancestor (index 0) is the the highest ancestor (i.e, server, project)
-
getObjectPathFolderAncestors
public java.util.List getObjectPathFolderAncestors(int rootIndex, boolean order, boolean excludeParent)
Returns all the ancestors of the current object- Parameters:
rootIndex
- , indicates the starting index of the ancestororder
- , specifies the order in which the ancestors should be returned. false - highest to lowest true - lowest to highestexludeParent
- , specifies if Parent Name should be excluded in the ancestors- Returns:
- a list of ancestors, in the order specified
-
getOpenCreateFolderEvent
protected WebEvent getOpenCreateFolderEvent()
-
getCreateFolderBean
protected OMDCreateFolderBean getCreateFolderBean()
-
generateAnchor
protected AnchorTag generateAnchor(WebEvent event)
Overwrites the parent method by setting the right event element value according to the formal parameters available on the transform- Overrides:
generateAnchor
in classAbstractAppTransform
- Parameters:
event
-WebEvent
instance from where the anchor will be constructed- Returns:
AnchorTag
initialized instance with the information as provided by the arguments.
-
renderSimpleButton
protected void renderSimpleButton(MarkupOutput out, WebEvent event, java.lang.String descriptor, java.lang.String id)
-
renderSimpleButton
protected void renderSimpleButton(MarkupOutput out, WebEvent event, java.lang.String descriptor, java.lang.String id, java.lang.String src)
-
renderParentFolderDelimiter
public void renderParentFolderDelimiter(MarkupOutput out)
Renders the delimiter between the folder names The divider character is set through Formal Parameter- Parameters:
out
- the transform's output
-
renderAncestor
public void renderAncestor(MarkupOutput out, WebFolder folder)
Renders the WebFolder object name w/o the hyperlink to that folder- Parameters:
out
- the transform's outputfolder
- , the folder to be rendered
-
renderSimpleLink
protected void renderSimpleLink(MarkupOutput out, WebEvent event, java.lang.String descriptor, java.lang.String css, boolean showLink)
Renders a link based on the event.- Parameters:
out
- the transform's outputevent
- the event associated witht he linkdescriptor
- the content of the linkcss
- the class to useshowLink
- whether to render to link or not (if false, the descriptor will be simply rendered within a SPAN tag).
-
renderSimpleLink
protected void renderSimpleLink(MarkupOutput out, WebEvent event, java.lang.String descriptor, java.lang.String css, boolean showLink, boolean showDivider)
Renders a link based on the event.- Parameters:
out
- the transform's outputevent
- the event associated with the linkdescriptor
- the content of the linkcss
- the class to useshowLink
- whether to render to link or not (if false, the descriptor will be simply rendered within a SPAN tag).
-
renderParent
public void renderParent(MarkupOutput out)
Renders the parent folder- Parameters:
out
- the transform's output
-
-