Class AbstractObjectInfoListTransform
- java.lang.Object
-
- com.microstrategy.web.transform.AbstractTransform
-
- com.microstrategy.web.transform.AbstractLayoutTransform
-
- com.microstrategy.web.app.transforms.AbstractAppTransform
-
- com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
-
- All Implemented Interfaces:
AppTransform
,LayoutTransform
,Transform
- Direct Known Subclasses:
AbstractFolderTransform
,UserEntitiesTransform
public abstract class AbstractObjectInfoListTransform extends AbstractAppTransform implements LayoutTransform
AbstractObjectInfoListTransform is an abstract class that takes care of rendering a bean that holdsWebObjectInfo
instances on a list structure.- 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 static java.lang.String
FP_INCREMENTAL_FETCH_NAV_TYPE
Constant specifying the name of the formal parameter for defining the navigation type for incremental fetch.static java.lang.String
FP_INCREMENTAL_FETCH_PAGE_BLOCK
Constant specifying the name of the formal parameter for defining the page block size for incremental fetch.protected java.lang.String
imgBlank
Deprecated.please useAbstractAppTransform._imgBlank
insteadprotected FormalParameter
incrementalFetchNavigationType
Formal parameter that specifies which type of incremental fetch navigation will be enabled.FormalParameter
incrementalFetchPageBlock
Indicates the number of pages to show per block for incremental fetch.-
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 AbstractObjectInfoListTransform()
Class constructor
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description java.util.Map
addCSSForObjectType(WebObjectInfo object)
Return the class Attribute to be used in the table cell for the transform.protected abstract int
getBlockPosition()
protected abstract int
getBlockSize()
protected abstract int
getChildCount()
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.protected boolean
getDereferenceShortcuts(WebObjectInfo object)
Get 'dereferenceShortcuts' flagabstract WebEvent
getEvent(WebObjectInfo object)
Generate the event that allows users to request actions on a given object.abstract int
getGoToArgument()
abstract WebEvent
getGoToEvent()
protected java.lang.String
getImageName(WebObjectInfo object)
Utility method that helps giving the image name to use - based on the information available on the formal parameters and on the the object type of theWebObjectInfo
instance.protected java.lang.String
getImageTooltip(WebObjectInfo object)
According to the object's type, generate the tooltip that will be displayed with the image to render.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.java.util.Map<java.lang.String,java.lang.String>
getListItemAttributes(WebObjectInfo object)
Add attributes to List View Item tag.protected Tag
getNameWrapperTag(WebObjectInfo object)
java.lang.String
getObjectAbbreviation(WebObjectInfo object)
Utility method for obtaining the abbreviation of the object being analyzedjava.lang.String
getObjectDescription(WebObjectInfo object)
Utility method for obtaining the description of the object being analyzedjava.lang.String
getObjectModificationTime(WebObjectInfo object)
Utility method for obtaining the modification time of the object being analyzedjava.lang.String
getObjectName(WebObjectInfo object)
Utility method for obtaining the name of the object being analyzedjava.lang.String
getOwnerName(WebObjectInfo object)
Utility method for obtaining the owner of the object being analyzedprotected PathTransform
getPathTransform()
Get the PathTransform for rendering the path in location info.abstract java.util.List
getSortedList()
protected static int
getVisualizationMode(AbstractAppTransform transform, WebObjectInfo object)
protected int
getVisualizationMode(WebObjectInfo object)
void
initializeImages()
Initialize the images to be used by this transform.abstract boolean
isEmptyList()
boolean
isUserEnabled(WebUser object)
Utility method for determining if the user object is enabled or not.protected static boolean
isVisualizationObject(AbstractAppTransform transform, WebObjectInfo object)
protected boolean
isVisualizationObject(WebObjectInfo object)
void
renderAbbreviationInfo(MarkupOutput out, WebObjectInfo object)
Write out abbreviation information for a single object.void
renderAbbreviationInfo(MarkupOutput out, WebObjectInfo object, boolean renderBlankspace)
Write out abbreviation information for a single object.void
renderDescriptionInfo(MarkupOutput out, WebObjectInfo object)
Write out description information for a single object.void
renderDescriptionInfo(MarkupOutput out, WebObjectInfo object, boolean renderBlankspace)
Write out description information for a single object.void
renderEmptyList(MarkupOutput out)
Generate HTML contents when the list of the underlying bean being rendered is emptyvoid
renderIconInfo(MarkupOutput out, WebObjectInfo object)
Write out the image information for a single object.void
renderIncrementalFetch(MarkupOutput out)
Renders the incremental fetch links for the browse list, including the images.void
renderIsUserEnabled(MarkupOutput out, WebObjectInfo object)
Write out information about the object being enabled or not.void
renderIsUserEnabled(MarkupOutput out, WebObjectInfo object, boolean renderBlankspace)
void
renderLayeredIconInfo(MarkupOutput out, WebObjectInfo object)
Similar torenderIconInfo(MarkupOutput, WebObjectInfo)
, but instead 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
renderLayeredIconInfo(MarkupOutput out, WebObjectInfo object, boolean largeIconView)
overloaded...void
renderList(MarkupOutput out)
Generate HTML contents when the list of the underlying bean being rendered holds objectsvoid
renderLocationInfo(MarkupOutput out, WebObjectInfo object)
Write out the location information for a single object, by using thePathTransform
transform, including the ancestors of the specified object.void
renderModifiedInfo(MarkupOutput out, WebObjectInfo object)
Write out modified time information for a single object.void
renderNameInfo(MarkupOutput out, WebObjectInfo object)
Write out name information for a single object.void
renderObject(MarkupOutput out, WebObjectInfo object)
Generate HTML output for a single object from the list being processed.void
renderOwnerInfo(MarkupOutput out, WebObjectInfo object)
Write out owner information for a single objectvoid
transformForRequestSuccessful(MarkupOutput out)
Generates the output when the bean's status isEnumRequestStatus.WebBeanRequestSuccessful
.-
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, getSupportedBeanType, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, initializeCss, initializeTransform, 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.LayoutTransform
getLayoutDefinition, setLayoutDefinition
-
Methods inherited from interface com.microstrategy.web.transform.Transform
canTransform, getDescription, getFormalParams, getID, getPreview, getSupportedBeanType, isPreviewAvailable, isResolved, supports, supports, transform
-
-
-
-
Field Detail
-
incrementalFetchNavigationType
protected FormalParameter incrementalFetchNavigationType
Formal parameter that specifies which type of incremental fetch navigation will be enabled. Allowed values: a valid bitwise combination ofEnumIncrementalFetchProperties.NAVIGATION_BUTTONS_FIRST_LAST
and/orEnumIncrementalFetchProperties.NAVIGATION_BUTTONS_PREVIOUS_NEXT
,EnumIncrementalFetchProperties.NAVIGATION_BUTTONS_PREVIOUS_NEXT_SET
-
incrementalFetchPageBlock
public FormalParameter incrementalFetchPageBlock
Indicates the number of pages to show per block for incremental fetch.
Default value is 5, so the incremental fetch will render the navigation arrows for moving up and down five pages at the time.
-
FP_INCREMENTAL_FETCH_NAV_TYPE
public static final java.lang.String FP_INCREMENTAL_FETCH_NAV_TYPE
Constant specifying the name of the formal parameter for defining the navigation type for incremental fetch. Value is incrementalFetchNavigationType.- See Also:
- Constant Field Values
-
FP_INCREMENTAL_FETCH_PAGE_BLOCK
public static final java.lang.String FP_INCREMENTAL_FETCH_PAGE_BLOCK
Constant specifying the name of the formal parameter for defining the page block size for incremental fetch. Value is incrementalFetchPageBlock.- See Also:
- Constant Field Values
-
imgBlank
protected java.lang.String imgBlank
Deprecated.please useAbstractAppTransform._imgBlank
insteadProperty that holds the file and path information for a transparent/blank image
-
-
Method Detail
-
initializeImages
public void initializeImages()
Description copied from class:AbstractAppTransform
Initialize the images to be used by this transform.- Overrides:
initializeImages
in classAbstractAppTransform
-
transformForRequestSuccessful
public void transformForRequestSuccessful(MarkupOutput out)
Description copied from class:AbstractAppTransform
Generates the output when the bean's status isEnumRequestStatus.WebBeanRequestSuccessful
. This is the main entry point to generate the output for those Transforms that just want to render the "regular" bean case.
This is an abstract method. All classes need to implement it.- Specified by:
transformForRequestSuccessful
in classAbstractAppTransform
- Parameters:
out
- output by this transform- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
renderEmptyList
public void renderEmptyList(MarkupOutput out)
Generate HTML contents when the list of the underlying bean being rendered is empty- Parameters:
out
-MarkupOutput
instance where the contents generated will be stored.
-
renderList
public void renderList(MarkupOutput out)
Generate HTML contents when the list of the underlying bean being rendered holds objects- Parameters:
out
-MarkupOutput
instance where the contents generated will be stored.
-
renderObject
public void renderObject(MarkupOutput out, WebObjectInfo object)
Generate HTML output for a single object from the list being processed.- Parameters:
out
-MarkupOutput
instance where the contents generated will be stored.object
-WebObjectInfo
instance to be rendered.
-
renderIconInfo
public void renderIconInfo(MarkupOutput out, WebObjectInfo object)
Write out the image information for a single object. The css class of the image (which defines the GIF to use) is determined by the object type. The image will be rendered as a link if the event according to the object type, provided by thegetEvent()
method, is available.- Parameters:
out
-MarkupOutput
instance where the contents generated will be stored.object
-WebObjectInfo
instance to be rendered.
-
renderLayeredIconInfo
public void renderLayeredIconInfo(MarkupOutput out, WebObjectInfo object)
Similar torenderIconInfo(MarkupOutput, WebObjectInfo)
, but instead 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
-MarkupOutput
instance where to save the contents to displayobject
-WebObjectInfo
to be rendered.
-
renderLayeredIconInfo
public void renderLayeredIconInfo(MarkupOutput out, WebObjectInfo object, boolean largeIconView)
overloaded... Similar torenderIconInfo(MarkupOutput, WebObjectInfo)
, but instead 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
-MarkupOutput
instance where to save the contents to displayobject
-WebObjectInfo
to be rendered.largeIconView
- flag for a largeIconView or listView
-
getNameWrapperTag
protected Tag getNameWrapperTag(WebObjectInfo object)
- Parameters:
object
-WebObjectInfo
instance to be rendered.- Returns:
- a Tag instance with the name of the object to render already embedded. Might return null, in which case
the object name will have to be obtained by calling the
getObjectName(WebObjectInfo)
method separately.
-
renderNameInfo
public void renderNameInfo(MarkupOutput out, WebObjectInfo object)
Write out name information for a single object.
The text will be rendered as a link if the event according to the object type, provided by thegetEvent()
method, is available.- Parameters:
out
-MarkupOutput
instance where the contents generated will be stored.object
-WebObjectInfo
instance to be rendered.
-
getDereferenceShortcuts
protected boolean getDereferenceShortcuts(WebObjectInfo object)
Get 'dereferenceShortcuts' flag- Parameters:
object
-- Returns:
- Default 'true' - //retun true to be consistent with existing behavior
-
renderLocationInfo
public void renderLocationInfo(MarkupOutput out, WebObjectInfo object)
Write out the location information for a single object, by using thePathTransform
transform, including the ancestors of the specified object.- Parameters:
out
-MarkupOutput
instance where to save the contents to displayobject
-WebObjectInfo
to be rendered.
-
getPathTransform
protected PathTransform getPathTransform()
Get the PathTransform for rendering the path in location info.
-
renderAbbreviationInfo
public void renderAbbreviationInfo(MarkupOutput out, WebObjectInfo object)
Write out abbreviation information for a single object.- Parameters:
out
-MarkupOutput
instance where the contents generated will be stored.object
-WebObjectInfo
instance to be rendered.
-
renderAbbreviationInfo
public void renderAbbreviationInfo(MarkupOutput out, WebObjectInfo object, boolean renderBlankspace)
Write out abbreviation information for a single object.- Parameters:
out
-MarkupOutput
instance where the contents generated will be stored.object
-WebObjectInfo
instance to be rendered.renderBlankspace
- If abbreviation is not available, if this flag is true it will render a white space for it, otherwise it will not render anything.
-
renderOwnerInfo
public void renderOwnerInfo(MarkupOutput out, WebObjectInfo object)
Write out owner information for a single object- Parameters:
out
-MarkupOutput
instance where the contents generated will be stored.object
-WebObjectInfo
instance to be rendered.
-
renderDescriptionInfo
public void renderDescriptionInfo(MarkupOutput out, WebObjectInfo object)
Write out description information for a single object.- Parameters:
out
-MarkupOutput
instance where the contents generated will be stored.object
-WebObjectInfo
instance to be rendered.
-
renderDescriptionInfo
public void renderDescriptionInfo(MarkupOutput out, WebObjectInfo object, boolean renderBlankspace)
Write out description information for a single object.- Parameters:
out
-MarkupOutput
instance where to save the contents to displayobject
-WebObjectInfo
to be rendered.renderBlankspace
-boolean
to specify whether it should render a empty cell when it is empty. (otherwise no content is rendered).
-
renderModifiedInfo
public void renderModifiedInfo(MarkupOutput out, WebObjectInfo object)
Write out modified time information for a single object.- Parameters:
out
-MarkupOutput
instance where the contents generated will be stored.object
-WebObjectInfo
instance to be rendered.
-
renderIsUserEnabled
public void renderIsUserEnabled(MarkupOutput out, WebObjectInfo object)
Write out information about the object being enabled or not. This method by default only generates contents for theWebUser
object types.- Parameters:
out
-MarkupOutput
instance where the contents generated will be stored.object
-WebObjectInfo
instance to be rendered.
-
renderIsUserEnabled
public void renderIsUserEnabled(MarkupOutput out, WebObjectInfo object, boolean renderBlankspace)
-
getObjectName
public java.lang.String getObjectName(WebObjectInfo object)
Utility method for obtaining the name of the object being analyzed- Parameters:
object
-WebObjectInfo
instance to be processed.- Returns:
- value of the name property of the object. If handling a shortcut, it will obtain the property of the original target object and return this as result. By default the result will be encoded for its proper display on HTML.
-
getObjectAbbreviation
public java.lang.String getObjectAbbreviation(WebObjectInfo object)
Utility method for obtaining the abbreviation of the object being analyzed- Parameters:
object
-WebObjectInfo
instance to be processed.- Returns:
- value of the abbreviation property of the object.
-
getOwnerName
public java.lang.String getOwnerName(WebObjectInfo object)
Utility method for obtaining the owner of the object being analyzed- Parameters:
object
-WebObjectInfo
instance to be processed.- Returns:
- value of the owner property of the object.
-
getObjectDescription
public java.lang.String getObjectDescription(WebObjectInfo object)
Utility method for obtaining the description of the object being analyzed- Parameters:
object
-WebObjectInfo
instance to be processed.- Returns:
- value of the description property of the object. If handling a shortcut, it will obtain the property of the original target object and return this as result. By default the result might be encoded - as indicated on the Administrator's settings - for its proper display on HTML.
-
getObjectModificationTime
public java.lang.String getObjectModificationTime(WebObjectInfo object)
Utility method for obtaining the modification time of the object being analyzed- Parameters:
object
-WebObjectInfo
instance to be processed.- Returns:
- value of the modification time property of the object. If handling a shortcut, it will obtain the property of the original target object and return this as result. If no modification time can be found, it will return its creation time.
-
isUserEnabled
public boolean isUserEnabled(WebUser object)
Utility method for determining if the user object is enabled or not.- Parameters:
object
-WebUser
instance to be processed.- Returns:
- value of the enabled property of the object.
-
getSortedList
public abstract java.util.List getSortedList()
- Returns:
- a
List
instance with all the elements from the bean to be rendered by this transform. The contents will already be sorted if required.
-
getEvent
public abstract WebEvent getEvent(WebObjectInfo object)
Generate the event that allows users to request actions on a given object.- Parameters:
object
-WebObjectInfo
base object for a request.- Returns:
WebEvent
instance corresponding to the event enabled for theWebObjectInfo
provided. If no possible manipulation on the object is authorized,null
will be returned.
-
isEmptyList
public abstract boolean isEmptyList()
- Returns:
true
if the underlying object list is empty.
-
getGoToEvent
public abstract WebEvent getGoToEvent()
- 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 abstract int getGoToArgument()
- Returns:
- the identifier of the argument on the
getGoToEvent()
event where the element to navigate to will be specified.
-
getBlockPosition
protected abstract int getBlockPosition()
- 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 abstract int getBlockSize()
- 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 abstract int getChildCount()
- 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()
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.- Returns:
IncrementalFetch
initialized instance
-
renderIncrementalFetch
public void renderIncrementalFetch(MarkupOutput out)
Renders the incremental fetch links for the browse list, including the images.- Parameters:
out
-MarkupOutput
instance which includes the HTML for the header of the table to be used on the transform
-
addCSSForObjectType
public java.util.Map addCSSForObjectType(WebObjectInfo object)
Return the class Attribute to be used in the table cell for the transform.- Parameters:
object
-WebObjectInfo
to be rendered.- Returns:
java.util.Map
with the attribute name (as key) and the value.
-
getCssName
public 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.
-
getImageTooltip
protected java.lang.String getImageTooltip(WebObjectInfo object)
According to the object's type, generate the tooltip that will be displayed with the image to render. For example, when the object type isEnumDSSXMLObjectTypes.DssXmlTypeFolder
, it will generate the corresponding localized descriptor for Open Folder.- Parameters:
object
- TheWebObjectInfo
for which it's tooltip is required.- Returns:
- A
String
with the tooltip to set to the image associated with theWebObjectInfo
.
-
getImageName
protected java.lang.String getImageName(WebObjectInfo object)
Utility method that helps giving the image name to use - based on the information available on the formal parameters and 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 image associated with theWebObjectInfo
. If the type specified does not match the predefined list of styles, then it returns the file name and path for the blank (transparent) image.
-
isVisualizationObject
protected static boolean isVisualizationObject(AbstractAppTransform transform, WebObjectInfo object)
-
isVisualizationObject
protected boolean isVisualizationObject(WebObjectInfo object)
-
getVisualizationMode
protected static int getVisualizationMode(AbstractAppTransform transform, WebObjectInfo object)
-
getVisualizationMode
protected int getVisualizationMode(WebObjectInfo object)
-
getListItemAttributes
public java.util.Map<java.lang.String,java.lang.String> getListItemAttributes(WebObjectInfo object)
Add attributes to List View Itemtag. By Default, add CSS class attribute to support banding effect in list view This function is currently called in User Management and Security Role pages to add CSS class attribute to every other tag in the listView . Returns a map containing the attributes to add to the container of every object in the list of contents.
- Parameters:
object
- WebObjectInfo - List View Item- Returns:
- Map
-
-