Class ObjectInfoTransform
- java.lang.Object
-
- com.microstrategy.web.transform.AbstractTransform
-
- com.microstrategy.web.transform.AbstractLayoutTransform
-
- com.microstrategy.web.app.transforms.AbstractAppTransform
-
- com.microstrategy.web.app.transforms.ObjectInfoTransform
-
- All Implemented Interfaces:
AppTransform
,Transform
public class ObjectInfoTransform 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
_levelFlag
Property for holding the value specified to the levelFlag formal parameterFormalParameter
datamartImage
Deprecated.The image is now defined by css class nameFormalParameter
documentImage
Deprecated.The image is now defined by css class nameFormalParameter
filterImage
Deprecated.The image is now specified by css class nameFormalParameter
folderImage
Deprecated.The image is now specified by css class namestatic java.lang.String
FP_FILTER_IMAGE
Constant specifying the name of the formal parameter for defining the filter image.static java.lang.String
FP_FOLDER_IMAGE
Constant specifying the name of the formal parameter for defining the folder image.static java.lang.String
FP_IMAGE_HEIGTH
Constant specifying the name of the formal parameter for defining the image height.static java.lang.String
FP_IMAGE_WIDTH
Constant specifying the name of the formal parameter for defining the image width.static java.lang.String
FP_IMG_DATAMART
Constant specifying the name of the formal parameter for defining the datamart report image.static java.lang.String
FP_IMG_DOCUMENT
Constant specifying the name of the formal parameter for defining the document image.static java.lang.String
FP_IMG_GRAPH
Constant specifying the name of the formal parameter for defining the graph image.static java.lang.String
FP_IMG_GRID
Constant specifying the name of the formal parameter for defining the grid report image.static java.lang.String
FP_IMG_GRID_GRAPH
Constant specifying the name of the formal parameter for defining the grid-graph report image.static java.lang.String
FP_IMG_RWDOCUMENT
Constant specifying the name of the formal parameter for defining the report writing document image.static java.lang.String
FP_LEVEL_FLAG
Constant specifying the name of the formal parameter for defining the level flag.static java.lang.String
FP_TEMPLATE_IMAGE
Constant specifying the name of the formal parameter for defining the template image.FormalParameter
graphImage
Deprecated.The image is now defined by css class nameFormalParameter
gridGraphImage
Deprecated.The image is now defined by css class nameFormalParameter
gridImage
Deprecated.The image is now defined by css class nameFormalParameter
imageHeight
Deprecated.The images are now defined with css class nameFormalParameter
imageWidth
Deprecated.The images are now defined with css class name.static int
LEVEL_ALL
Allowed value for thelevelFlag
formal parameter.static int
LEVEL_DESCRIPTION
Allowed value for thelevelFlag
formal parameter.static int
LEVEL_ICON
Allowed value for thelevelFlag
formal parameter.static int
LEVEL_MODIFIED
Allowed value for thelevelFlag
formal parameter.static int
LEVEL_NAME
Allowed value for thelevelFlag
formal parameter.static int
LEVEL_OWNER
Allowed value for thelevelFlag
formal parameter.FormalParameter
levelFlag
Indicates the level of information to use when displaying each object.FormalParameter
rwDocumentImage
Deprecated.The image is now defined by css class nameFormalParameter
templateImage
Deprecated.The image is now specified by css class name-
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 ObjectInfoTransform()
Default no-arg constructor, initialize formal parameters
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected java.lang.String
getCssName(WebObjectInfo object)
Utility method that helps giving the CSS class to use based on the the object type of theWebObjectInfo
instance.java.lang.String
getDescription()
Returns the description to use in the Style catalog.ObjectBean
getObjectBean()
java.lang.Class
getSupportedBeanType()
Returns the supported bean type.void
initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.void
renderDescriptionInfo(MarkupOutput out)
Renders the object's descriptionvoid
renderDescriptionInfo(MarkupOutput out, WebObjectInfo info)
Renders the object's descriptionvoid
renderIconInfo(MarkupOutput out)
Renders the object's iconvoid
renderIconInfo(MarkupOutput out, WebObjectInfo info)
Renders the object's iconvoid
renderLayeredIconInfo(MarkupOutput out)
Renders the object's icon as a layered imagevoid
renderLayeredIconInfo(MarkupOutput out, WebObjectInfo info)
Similar torenderIconInfo(com.microstrategy.web.beans.MarkupOutput)
, but nstead of generating an IMG tag, having a transparent image as its source and a background image assigned via the CSS style, it will now generate a SPAN tag which will have the same css class defined (where the background image is indicated) and an inner SPAN for the layering effect, in case an additional image has to be included, on top of the original (for example, a shortcut arrow, a red error sign, etc).void
renderModifiedInfo(MarkupOutput out)
Renders the object's last modification time.void
renderModifiedInfo(MarkupOutput out, WebObjectInfo info)
Renders the object's last modification time.void
renderNameInfo(MarkupOutput out)
Renders the object's namevoid
renderNameInfo(MarkupOutput out, WebObjectInfo info)
Renders the object's namevoid
renderObject(MarkupOutput out, WebObjectInfo object)
Renders the ObjectInfovoid
renderOwnerInfo(MarkupOutput out)
Renders the object's owner name.void
renderOwnerInfo(MarkupOutput out, WebObjectInfo info)
Renders the object's owner name.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, 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, 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.Transform
canTransform, getFormalParams, getPreview, isPreviewAvailable, isResolved, supports, supports
-
-
-
-
Field Detail
-
LEVEL_ICON
public static final int LEVEL_ICON
Allowed value for thelevelFlag
formal parameter. Specifies that the transform will display object's related image icon.
Value =ObjectInfoWidget.FIELD_ICON
- See Also:
- Constant Field Values
-
LEVEL_NAME
public static final int LEVEL_NAME
Allowed value for thelevelFlag
formal parameter. Specifies that the transform will display object's name.
Value =ObjectInfoWidget.FIELD_NAME
- See Also:
- Constant Field Values
-
LEVEL_DESCRIPTION
public static final int LEVEL_DESCRIPTION
Allowed value for thelevelFlag
formal parameter. Specifies that the transform will display object's description.
Value =ObjectInfoWidget.FIELD_DESCRIPTION
- See Also:
- Constant Field Values
-
LEVEL_MODIFIED
public static final int LEVEL_MODIFIED
Allowed value for thelevelFlag
formal parameter. Specifies that the transform will display object's modification information.
Value =ObjectInfoWidget.FIELD_MODIFIED
- See Also:
- Constant Field Values
-
LEVEL_OWNER
public static final int LEVEL_OWNER
Allowed value for thelevelFlag
formal parameter. Specifies that the transform will display object's owner information.
Value =ObjectInfoWidget.FIELD_OWNER
- See Also:
- Constant Field Values
-
LEVEL_ALL
public static final int LEVEL_ALL
Allowed value for thelevelFlag
formal parameter. Convenience flag for selecting all the possible level flag values defined on this class.
Value =ObjectInfoWidget.LEVEL_ALL
- See Also:
- Constant Field Values
-
graphImage
public FormalParameter graphImage
Deprecated.The image is now defined by css class nameIndicates the image to use when displaying a graph.
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
gridImage
public FormalParameter gridImage
Deprecated.The image is now defined by css class nameIndicates the image to use when displaying a grid report.
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
datamartImage
public FormalParameter datamartImage
Deprecated.The image is now defined by css class nameIndicates the image to use when displaying a datamart report.
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.- Since:
- MicroStrategy Web 7.5.0
-
gridGraphImage
public FormalParameter gridGraphImage
Deprecated.The image is now defined by css class nameIndicates the image to use when displaying a grid-graph report.
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
documentImage
public FormalParameter documentImage
Deprecated.The image is now defined by css class nameIndicates the image to use when displaying a document.
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
rwDocumentImage
public FormalParameter rwDocumentImage
Deprecated.The image is now defined by css class nameIndicates the image to use when displaying a report writing document.
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.- Since:
- MicroStrategy Web 7.5.0
-
folderImage
public FormalParameter folderImage
Deprecated.The image is now specified by css class nameIndicates the image to use when displaying a folder.
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
filterImage
public FormalParameter filterImage
Deprecated.The image is now specified by css class nameIndicates the image to use when displaying a filter.
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
templateImage
public FormalParameter templateImage
Deprecated.The image is now specified by css class nameIndicates the image to use when displaying a template.
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
imageWidth
public FormalParameter imageWidth
Deprecated.The images are now defined with css class name.Indicates the width of the images to be rendered next to the objects when displayed.
The value indicated will be used for the images of all object types. If the default image formal parameters values are changed, chances are this value will have to be updated as well.
-
imageHeight
public FormalParameter imageHeight
Deprecated.The images are now defined with css class nameIndicates the height of the images to be rendered next to the objects when displayed.
The value indicated will be used for the images of all object types. If the default image formal parameters values are changed, chances are this value will have to be updated as well.
-
levelFlag
public FormalParameter levelFlag
Indicates the level of information to use when displaying each object.
The information may include object name, description and other information. Multiple fields might be rendered at the same time. For indicating which fields to show, the value to assign to this formal parameter should be a bitwise flag combining constants such asLEVEL_NAME
,LEVEL_DESCRIPTION
,LEVEL_OWNER
, etc. For a complete list, refer toObjectInfoTransform
.
Usage: If name, description and owner should be displayed, the value to assign to the formal parameter would be 38 (2 + 4 + 32). Default value isLEVEL_ALL
-
_levelFlag
protected int _levelFlag
Property for holding the value specified to the levelFlag formal parameter
-
FP_FOLDER_IMAGE
public static final java.lang.String FP_FOLDER_IMAGE
Constant specifying the name of the formal parameter for defining the folder image. Value is folderImage.- See Also:
- Constant Field Values
-
FP_IMG_GRAPH
public static final java.lang.String FP_IMG_GRAPH
Constant specifying the name of the formal parameter for defining the graph image. Value is graphImage.- See Also:
- Constant Field Values
-
FP_IMG_GRID
public static final java.lang.String FP_IMG_GRID
Constant specifying the name of the formal parameter for defining the grid report image. Value is gridImage.- See Also:
- Constant Field Values
-
FP_IMG_DATAMART
public static final java.lang.String FP_IMG_DATAMART
Constant specifying the name of the formal parameter for defining the datamart report image. Value is datamartImage.- 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
Constant specifying the name of the formal parameter for defining the grid-graph report image. Value is gridGraphImage.- See Also:
- Constant Field Values
-
FP_IMG_DOCUMENT
public static final java.lang.String FP_IMG_DOCUMENT
Constant specifying the name of the formal parameter for defining the document image. Value is documentImage.- See Also:
- Constant Field Values
-
FP_IMG_RWDOCUMENT
public static final java.lang.String FP_IMG_RWDOCUMENT
Constant specifying the name of the formal parameter for defining the report writing document image. Value is rwDocumentImage.- Since:
- MicroStrategy Web 7.5.0
- See Also:
- Constant Field Values
-
FP_FILTER_IMAGE
public static final java.lang.String FP_FILTER_IMAGE
Constant specifying the name of the formal parameter for defining the filter image. Value is filterImage.- See Also:
- Constant Field Values
-
FP_TEMPLATE_IMAGE
public static final java.lang.String FP_TEMPLATE_IMAGE
Constant specifying the name of the formal parameter for defining the template image. Value is templateImage.- See Also:
- Constant Field Values
-
FP_IMAGE_WIDTH
public static final java.lang.String FP_IMAGE_WIDTH
Constant specifying the name of the formal parameter for defining the image width. Value is imageWidth.- See Also:
- Constant Field Values
-
FP_IMAGE_HEIGTH
public static final java.lang.String FP_IMAGE_HEIGTH
Constant specifying the name of the formal parameter for defining the image height. Value is imageHeight.- See Also:
- Constant Field Values
-
FP_LEVEL_FLAG
public static final java.lang.String FP_LEVEL_FLAG
Constant specifying the name of the formal parameter for defining the level flag. Value is levelFlag.- See Also:
- Constant Field Values
-
-
Method Detail
-
getDescription
public java.lang.String getDescription()
Returns the description to use in the Style catalog.- Returns:
- Renders the ObjectInfo of an ObjectBean.
-
initializeTransform
public void initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.- Specified by:
initializeTransform
in interfaceAppTransform
- Overrides:
initializeTransform
in classAbstractAppTransform
- Parameters:
data
- the bean to transform.
-
getCssName
protected java.lang.String getCssName(WebObjectInfo object)
Utility method that helps giving the CSS class to use based on the the object type of theWebObjectInfo
instance.- Parameters:
object
- TheWebObjectInfo
for which it's image name is required.- Returns:
- a
String
with the name of the CSS class that should be associated with theWebObjectInfo
information to display. If the type specified does not match the predefined list of styles, then it returns an empty string. - Since:
- MicroStrategy Web 8.0.0
-
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)
-
renderObject
public void renderObject(MarkupOutput out, WebObjectInfo object)
Renders the ObjectInfo- Parameters:
out
- the transform's outputobject
- the object info
-
renderIconInfo
public void renderIconInfo(MarkupOutput out)
Renders the object's icon- Parameters:
out
- the transform's output- Since:
- MicroStrategy Web 8.0.0
-
renderLayeredIconInfo
public void renderLayeredIconInfo(MarkupOutput out)
Renders the object's icon as a layered image- Parameters:
out
- the transform's output- Since:
- MicroStrategy Web 9.0.0
-
renderIconInfo
public void renderIconInfo(MarkupOutput out, WebObjectInfo info)
Renders the object's icon- Parameters:
out
- the transform's outputinfo
- the object info
-
renderLayeredIconInfo
public void renderLayeredIconInfo(MarkupOutput out, WebObjectInfo info)
Similar torenderIconInfo(com.microstrategy.web.beans.MarkupOutput)
, but nstead of generating an IMG tag, having a transparent image as its source and a background image assigned via the CSS style, it will now generate a SPAN tag which will have the same css class defined (where the background image is indicated) and an inner SPAN for the layering effect, in case an additional image has to be included, on top of the original (for example, a shortcut arrow, a red error sign, etc).- Parameters:
out
- the transform's outputinfo
- the object info- Since:
- MicroStrategy Web 9.0.0
-
renderNameInfo
public void renderNameInfo(MarkupOutput out)
Renders the object's name- Parameters:
out
- the transform's output- Since:
- MicroStrategy Web 8.0.0
-
renderNameInfo
public void renderNameInfo(MarkupOutput out, WebObjectInfo info)
Renders the object's name- Parameters:
out
- the transform's outputinfo
- the object info
-
renderDescriptionInfo
public void renderDescriptionInfo(MarkupOutput out)
Renders the object's description- Parameters:
out
- the transform's output- Since:
- MicroStrategy Web 8.0.0
-
renderDescriptionInfo
public void renderDescriptionInfo(MarkupOutput out, WebObjectInfo info)
Renders the object's description- Parameters:
out
- the transform's outputinfo
- the object info
-
renderOwnerInfo
public void renderOwnerInfo(MarkupOutput out)
Renders the object's owner name.- Parameters:
out
- the transform's output- Since:
- MicroStrategy Web 8.0.0
-
renderOwnerInfo
public void renderOwnerInfo(MarkupOutput out, WebObjectInfo info)
Renders the object's owner name.- Parameters:
out
- the transform's outputinfo
- the object info
-
renderModifiedInfo
public void renderModifiedInfo(MarkupOutput out)
Renders the object's last modification time.- Parameters:
out
- the transform's output- Since:
- MicroStrategy Web 8.0.0
-
renderModifiedInfo
public void renderModifiedInfo(MarkupOutput out, WebObjectInfo info)
Renders the object's last modification time.- Parameters:
out
- the transform's outputinfo
- the object info
-
getObjectBean
public ObjectBean getObjectBean()
- Returns:
- the ObjectBean being transformed.
-
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
-
-