Class UserGroupTransform
- java.lang.Object
-
- All Implemented Interfaces:
AppTransform
,LayoutTransform
,Transform
public class UserGroupTransform extends UserEntitiesTransform
- Since:
- MicroStrategy Web 9.0.0
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.UserEntitiesTransform
UserEntitiesTransform.Context
-
-
Field Summary
-
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 UserGroupTransform()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
canCreateGroup()
protected int
getBlockPosition()
protected int
getBlockSize()
protected int
getChildCount()
int
getGoToArgument()
WebEvent
getGoToEvent()
protected IncrementalFetch
getIncrementalFetchComponent()
Generate and initialize theIncrementalFetch
component that will enable navigating the different elements of the full list of results in case it is not displayed all together at the same time.WebEvent
getNewGroupEvent()
WebEvent
getNewUserEvent()
java.lang.Class
getSupportedBeanType()
Returns the supported bean type.protected UserGroupBean
getUserGroupBean()
void
initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform, such as width and height.-
Methods inherited from class com.microstrategy.web.app.transforms.UserEntitiesTransform
canCreate, canCreateUser, canDelete, canEdit, getContext, getContextMenu, getContextMenuAttributes, getDeleteEvent, getDescription, getEditEvent, getEvent, getObjectAbbreviation, getSortedList, getUserEntitiesBean, isEmptyList, isObjectNotNull, newContext, renderDeleteInfo, renderEditInfo, renderEmptyCellForActions
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
addCSSForObjectType, getCssName, getDereferenceShortcuts, getImageName, getImageTooltip, getListItemAttributes, getNameWrapperTag, getObjectDescription, getObjectModificationTime, getObjectName, getOwnerName, getPathTransform, getVisualizationMode, getVisualizationMode, initializeImages, isUserEnabled, isVisualizationObject, isVisualizationObject, renderAbbreviationInfo, renderAbbreviationInfo, renderDescriptionInfo, renderDescriptionInfo, renderEmptyList, renderIconInfo, renderIncrementalFetch, renderIsUserEnabled, renderIsUserEnabled, renderLayeredIconInfo, renderLayeredIconInfo, renderList, renderLocationInfo, renderModifiedInfo, renderNameInfo, renderObject, renderOwnerInfo, transformForRequestSuccessful
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
addContactInfo, addDynamicScriptClass, addDynamicScriptFile, addFormalParameter, checkLevel, checkProcessingButtonsFlag, checkProcessingInfoFlag, checkStatus, displayError, displayError, displayError, emptyCell, excludeStaticTags, generateAnchor, generateAnchorForExport, generateHiddenInputsForEvent, generateIFrameTag, getAppContext, getArgumentName, getAttributesShellDiv, getBeanPath, getBoneId, getCancelEvent, getClientSideHelper, getContainerServices, 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, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameEnabled, isIFrameRequest, isJobExpired, isModal, isOpen, isPortlet, isTrue, localIsIFrameDisplayMode, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, redirectToDisplayError, renderBean, renderBean, renderBean, renderBean, renderCancelButton, renderContextMenus, renderCssLink, renderDescriptor, renderDescriptor, renderErrorButton, renderHiddenInputFromRequest, renderImage, renderLayout, renderProcessingButton, renderProcessingButton, renderProcessingButton, renderProcessingButtonForGet, renderProcessingButtonForGet, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoData, renderProcessingInfoImage, renderProcessingInfoSubtitle, renderProcessingInfoTitle, renderProcessingObjectName, renderRefreshButton, renderRegisterBone, renderSelf, renderShell, renderSubBlock, renderUserHelpAnchor, setBoneProperties, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, shouldDisplay, transform, transformForRequestCanceled, 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
-
-
-
-
Method Detail
-
initializeTransform
public void initializeTransform(Transformable data)
Description copied from class:AbstractAppTransform
This method initialize the private and protected fields of the transform, such as width and height. It also invokes the
This method is automatically called from theinitializeWebComponent
,initializeImages
andinitializeCss
methods.transform
method. Transforms which would like to invoke other methods in this instance directly (for example, to invoke some render methods), need first to call this method to guarantee that the Transform is ready to generate output.- Specified by:
initializeTransform
in interfaceAppTransform
- Overrides:
initializeTransform
in classUserEntitiesTransform
- Parameters:
data
- the bean to transform.
-
getUserGroupBean
protected UserGroupBean getUserGroupBean()
-
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 classUserEntitiesTransform
- Returns:
- a root class/interface supported by this transform.
-
canCreateGroup
public boolean canCreateGroup()
- Overrides:
canCreateGroup
in classUserEntitiesTransform
-
getNewGroupEvent
public WebEvent getNewGroupEvent()
- Overrides:
getNewGroupEvent
in classUserEntitiesTransform
-
getNewUserEvent
public WebEvent getNewUserEvent()
- Overrides:
getNewUserEvent
in classUserEntitiesTransform
-
getGoToEvent
public WebEvent getGoToEvent()
- Overrides:
getGoToEvent
in classUserEntitiesTransform
- Returns:
WebEvent
instance with the information for handling incremental fetch requests on the list of objects being rendered by this transform. If not supported, it will returnnull
-
getGoToArgument
public int getGoToArgument()
- Overrides:
getGoToArgument
in classUserEntitiesTransform
- Returns:
- the identifier of the argument on the
AbstractObjectInfoListTransform.getGoToEvent()
event where the element to navigate to will be specified.
-
getBlockPosition
protected int getBlockPosition()
- Overrides:
getBlockPosition
in classUserEntitiesTransform
- Returns:
- value of the property indicating the index of the first element currently being viewed as part of the list output. Used for incremental fetch purposes.
-
getBlockSize
protected int getBlockSize()
- Overrides:
getBlockSize
in classUserEntitiesTransform
- Returns:
- value of the property indicating the number of elements included on a single 'page' of the list output. Used for incremental fetch purposes.
-
getChildCount
protected int getChildCount()
- Overrides:
getChildCount
in classUserEntitiesTransform
- Returns:
- the total number of elements that are included on the list that could be rendered by this transform. Used for incremental fetch purposes.
-
getIncrementalFetchComponent
protected IncrementalFetch getIncrementalFetchComponent()
Description copied from class:AbstractObjectInfoListTransform
Generate and initialize theIncrementalFetch
component that will enable navigating the different elements of the full list of results in case it is not displayed all together at the same time.- Overrides:
getIncrementalFetchComponent
in classAbstractObjectInfoListTransform
- Returns:
IncrementalFetch
initialized instance
-
-