Class GroupPathTransform
- java.lang.Object
-
- com.microstrategy.web.transform.AbstractTransform
-
- com.microstrategy.web.transform.AbstractLayoutTransform
-
- com.microstrategy.web.app.transforms.AbstractAppTransform
-
- com.microstrategy.web.app.transforms.AbstractAdminPathTransform
-
- com.microstrategy.web.app.transforms.GroupPathTransform
-
- All Implemented Interfaces:
AppTransform,LayoutTransform,Transform
public class GroupPathTransform extends AbstractAdminPathTransform
- 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 inherited from class com.microstrategy.web.app.transforms.AbstractAdminPathTransform
_divideCharacters, dividerCharacters, FP_CHARS_FOR_DIVIDER, FP_SHOW_LINK, showLink
-
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 GroupPathTransform()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intgetAncestorIndex(WebObjectInfo ancestor)Performs a search within the ancestors list for the given ancestor object and return its corresponding index.java.util.ListgetAncestorsList()java.lang.StringgetDescription()Return description for this Transformprotected WebEventgetGoParentPageEvent()protected java.lang.StringgetGoParentPageTooltip()protected WebEventgetGoUserManagerEvent()protected GroupPathBeangetGroupPathBean()protected WebEventgetOpenAncestorEvent(WebObjectInfo ancestor)protected WebEventgetOpenEveryoneGroupEvent()java.lang.ClassgetSupportedBeanType()Returns the supported bean type.voidrenderAncestor(MarkupOutput out, WebObjectInfo ancestor)voidrenderAncestors(MarkupOutput out)Renders the list of ancestors.voidrenderCurrentItem(MarkupOutput out)Renders the curent itemvoidrenderEveryoneAsAncestor(MarkupOutput out)voidrenderGoOneUp(MarkupOutput out)Renders the Up One level button.voidrenderGoUserManager(MarkupOutput out)voidrenderPathTooltip(MarkupOutput out)Renders the path tooltipbooleanshouldRenderEveryoneAsParent()-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractAdminPathTransform
canRenderHomeButtton, canRenderParentUpButton, getGoServerPageEvent, getOpenDefaultDesktopEvent, initializeTransform, renderContent, renderDelimiter, renderGoHome, renderGoServer, renderLink, renderSimpleButton, transformForRequestInError, transformForRequestSuccessful, transformForRequestWaitingForUserInput
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
addContactInfo, addDynamicScriptClass, addDynamicScriptFile, addFormalParameter, checkLevel, checkProcessingButtonsFlag, checkProcessingInfoFlag, checkStatus, displayError, displayError, displayError, emptyCell, excludeStaticTags, generateAnchor, generateAnchorForExport, generateHiddenInputsForEvent, generateIFrameTag, getAppContext, getArgumentName, getAttributesShellDiv, getBeanPath, getBoneId, getCancelEvent, getClientSideHelper, getContainerServices, getContext, getContextMenu, getContextMenuManager, getContextMenuManagerName, getContextMenusDefinition, getCssPrefix, getDateFormat, getDebugOut, getDescriptor, getDescriptor, getDescriptor, getDescriptor, getDisplayMode, getDisplayName, getErrorMessage, getErrorMessage, getErrorTitle, getErrorTitle, getEventManager, getFirstDayOfWeek, getFloatValue, getHelpPath, getID, getIntValue, getJSNameSpace, getLayoutContext, getLocale, getLocale, getPreferenceValue, getProjectID, getRefreshEvent, getRequestKeys, getResourcesFolder, getScriptClass, getStringValue, getStyleRequestContext, getStyleShellDiv, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, initializeCss, initializeImages, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameEnabled, isIFrameRequest, isJobExpired, isModal, isOpen, isPortlet, isTrue, localIsIFrameDisplayMode, newContext, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, redirectToDisplayError, 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
-
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
-
-
-
-
Method Detail
-
getDescription
public java.lang.String getDescription()
Return description for this Transform- Specified by:
getDescriptionin interfaceTransform- Overrides:
getDescriptionin classAbstractAdminPathTransform- Returns:
- description for the transform
-
getGoUserManagerEvent
protected WebEvent getGoUserManagerEvent()
-
renderGoUserManager
public void renderGoUserManager(MarkupOutput out)
-
getOpenAncestorEvent
protected WebEvent getOpenAncestorEvent(WebObjectInfo ancestor)
-
getOpenEveryoneGroupEvent
protected WebEvent getOpenEveryoneGroupEvent()
-
renderGoOneUp
public void renderGoOneUp(MarkupOutput out)
Description copied from class:AbstractAdminPathTransformRenders the Up One level button.- Overrides:
renderGoOneUpin classAbstractAdminPathTransform- Parameters:
out- Markupoutput
-
getAncestorIndex
public int getAncestorIndex(WebObjectInfo ancestor)
Performs a search within the ancestors list for the given ancestor object and return its corresponding index.
-
getGoParentPageEvent
protected WebEvent getGoParentPageEvent()
- Specified by:
getGoParentPageEventin classAbstractAdminPathTransform
-
getGoParentPageTooltip
protected java.lang.String getGoParentPageTooltip()
- Specified by:
getGoParentPageTooltipin classAbstractAdminPathTransform
-
renderAncestor
public void renderAncestor(MarkupOutput out, WebObjectInfo ancestor)
-
renderEveryoneAsAncestor
public void renderEveryoneAsAncestor(MarkupOutput out)
-
renderAncestors
public void renderAncestors(MarkupOutput out)
Renders the list of ancestors.- Parameters:
out- the transform's output
-
shouldRenderEveryoneAsParent
public boolean shouldRenderEveryoneAsParent()
-
renderCurrentItem
public void renderCurrentItem(MarkupOutput out)
Renders the curent item- Specified by:
renderCurrentItemin classAbstractAdminPathTransform- Parameters:
out- the transform's output
-
renderPathTooltip
public void renderPathTooltip(MarkupOutput out)
Renders the path tooltip- Parameters:
out- the transform's output
-
getAncestorsList
public java.util.List getAncestorsList()
-
getSupportedBeanType
public java.lang.Class getSupportedBeanType()
Description copied from class:AbstractAppTransformReturns the supported bean type. This abstract Transform supports allWebComponentsso every sub-class should override this method to return the class of theBeanthe 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:
getSupportedBeanTypein interfaceTransform- Overrides:
getSupportedBeanTypein classAbstractAppTransform- Returns:
- a root class/interface supported by this transform.
-
getGroupPathBean
protected GroupPathBean getGroupPathBean()
-
-