Class AbstractObjectBrowserTabTransform
- java.lang.Object
-
- com.microstrategy.web.transform.AbstractTransform
-
- com.microstrategy.web.transform.AbstractLayoutTransform
-
- com.microstrategy.web.app.transforms.AbstractAppTransform
-
- com.microstrategy.web.app.transforms.AbstractEditorTransform
-
- com.microstrategy.web.app.transforms.AbstractObjectBrowserTabTransform
-
- All Implemented Interfaces:
AppTransform
,Transform
- Direct Known Subclasses:
ObjectBrowserTabOMDTransform
,ObjectBrowserTabProjectBrowserTransform
,ObjectBrowserTabReportWorkingSetTransform
,ObjectBrowserTabRWWorkingSetTransform
public abstract class AbstractObjectBrowserTabTransform extends AbstractEditorTransform
This transform is the base class for those Tabs that are displayed within anObjectBrowserManager
.- Since:
- MicroStrategy Web 8.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 java.lang.String
_imgAttribute
protected java.lang.String
_imgAttributeForm
protected java.lang.String
_imgConsolidation
protected java.lang.String
_imgCube
protected java.lang.String
_imgCustomGroup
protected java.lang.String
_imgDerivedMetric
protected java.lang.String
_imgFilter
protected java.lang.String
_imgFolder
protected java.lang.String
_imgGraph
protected java.lang.String
_imgGridGraph
protected java.lang.String
_imgHierarchy
protected java.lang.String
_imgMetric
protected java.lang.String
_imgMetricDmx
protected java.lang.String
_imgPrompt
protected java.lang.String
_imgRa
protected java.lang.String
_imgReport
FormalParameter
attributeFormImage
Indicates the image to use when displaying an attribute form.FormalParameter
attributeImage
Indicates the image to use when displaying an attribute.FormalParameter
consolidationImage
Indicates the image to use when displaying a consolidation.FormalParameter
cubeImage
Indicates the image to use when displaying a cube.FormalParameter
customGroupImage
Indicates the image to use when displaying a custom group.FormalParameter
derivedMetricImage
Indicates the image to use when displaying a derived metric.FormalParameter
filterImage
Indicates the image to use when displaying a filter.FormalParameter
folderImage
Indicates the image to use when displaying a folder.static java.lang.String
FP_ATTRIBUTE_FORM_IMAGE
Constant specifying the name of the formal parameter for defining the attribute form image.static java.lang.String
FP_ATTRIBUTE_IMAGE
Constant specifying the name of the formal parameter for defining the attribute image.static java.lang.String
FP_CONSOLIDATION_IMAGE
Constant specifying the name of the formal parameter for defining the consolidation image.static java.lang.String
FP_CUBE_IMAGE
Constant specifying the name of the formal parameter for defining the cube image.static java.lang.String
FP_CUSTOM_GROUP_IMAGE
Constant specifying the name of the formal parameter for defining the custom group image.static java.lang.String
FP_DERIVED_METRIC_IMAGE
Constant specifying the name of the formal parameter for defining the derived metric image.static 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_GRAPH_IMAGE
Constant specifying the name of the formal parameter for defining the report image.static java.lang.String
FP_GRID_GRAPH_IMAGE
Constant specifying the name of the formal parameter for defining the report image.static java.lang.String
FP_HIERARCHY_IMAGE
Constant specifying the name of the formal parameter for defining the hierarchy image.static java.lang.String
FP_INCLUDE_DYNAMIC_SCRIPT
Constant specifying the name of the formal parameter for specifying whether to include dynamic scripts or not.static java.lang.String
FP_METRIC_DMX_IMAGE
Constant specifying the name of the formal parameter for defining the derived metric image.static java.lang.String
FP_METRIC_IMAGE
Constant specifying the name of the formal parameter for defining the metric image.static java.lang.String
FP_OBJECT_SUBTYPES_FILTER
Constant specifying the name of the formal parameter for defining the object subtypes to consider for the filter.static java.lang.String
FP_OBJECT_TYPES_FILTER
Constant specifying the name of the formal parameter for defining the object types to consider for the filter.static java.lang.String
FP_PROMPT_IMAGE
Constant specifying the name of the formal parameter for defining the prompt image.static java.lang.String
FP_RA_IMAGE
Constant specifying the name of the formal parameter for defining the recursive attribute image.static java.lang.String
FP_REPORT_IMAGE
Constant specifying the name of the formal parameter for defining the report image.FormalParameter
graphImage
Indicates the image to use when displaying a graph.FormalParameter
gridGraphImage
Indicates the image to use when displaying a grid and graph.FormalParameter
hierarchyImage
Indicates the image to use when displaying a hierarchy.FormalParameter
metricDmxImage
Indicates the image to use when displaying a Predictive metric.FormalParameter
metricImage
Indicates the image to use when displaying a metric.FormalParameter
objectSubtypesFilter
Indicates the filter specification for the object subtypes that should not be displayed.FormalParameter
objectTypesFilter
Indicates the filter specification for the object types that should not be displayed.FormalParameter
promptImage
Indicates the image to use when displaying a prompt.FormalParameter
raImage
FormalParameter
reportImage
Indicates the image to use when displaying a report.protected static java.lang.String
sSpaces
-
Fields inherited from class com.microstrategy.web.app.transforms.AbstractEditorTransform
_helpTopic, _helpType, applyJS, applyLabel, applyLabelID, canAutoSize, cancelJS, cancelLabel, cancelLabelID, closeEvent, closeImage, closeJS, closeLabel, closeLabelID, dhtmlClose, disableOKButton, editorContentsStyle, editorElements, editorLayoutFile, editorSubType, FP_APPLY_JS, FP_APPLY_LABEL, FP_APPLY_LABEL_ID, FP_CAN_AUTO_SIZE, FP_CANCEL_JS, FP_CANCEL_LABEL, FP_CANCEL_LABEL_ID, FP_CLOSE_EVENT, FP_CLOSE_IMAGE, FP_CLOSE_JS, FP_CLOSE_LABEL, FP_CLOSE_LABEL_ID, FP_DHTML_CLOSE, FP_DISABLE_OK_BUTTON, FP_EDITOR_CONTENTS_STYLE, FP_EDITOR_ELEMENTS, FP_EDITOR_LAYOUT_FILE, FP_EDITOR_SUBTYPE, FP_HELP_PAGE, FP_HELP_TOPIC, FP_HELP_TYPE, FP_NAVIGATE_ON_SUBMIT, FP_OK_JS, FP_OK_LABEL, FP_OK_LABEL_ID, FP_RENDER_FORM, FP_TITLE_LABEL, FP_TITLE_LABEL_ID, FP_USE_JS_IN_BONE, helpPage, helpTopic, helpType, includeDynamicScript, navigateOnSubmit, okJS, okLabel, okLabelID, renderForm, titleLabel, titleLabelID
-
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 AbstractObjectBrowserTabTransform()
Default no-argument constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected java.lang.String
formatObjectInfoParameter(java.lang.String id, java.lang.String type, java.lang.String subType, java.lang.String alias, java.lang.String name)
Outputs a string formatted the way the objectInfo argument of the event requires itprotected java.lang.String
generateTooltipInformation(java.lang.String objectAlias, WebObjectInfo item)
Generates a string that returns the information that would be displayed as a tooltip for theWebObjectInfo
item.protected java.lang.String
getClassName(WebObjectInfo object)
Return the class name to use for the generation of the HTML tag related with this object.protected java.lang.String
getFolderLinkClasses(WebObjectInfo object)
Return the className of the folderLink that is used to render the folderprotected java.lang.String
getJavascriptTyAttribute(WebObjectInfo object)
Return the Javascript TY attribute to use for the generation of the HTML tag related with this object.protected java.lang.String
getObjectDescription(WebObjectInfo item)
Returns the item's description from it's Object Info depending on whether the Allow HTML on object description property has been set.protected java.lang.String
getObjectImageName(WebObjectInfo object)
Utility method that helps giving the image name to use - based on the information available on the formal parameters - based on the the object type and/or subtype of theWebObjectInfo
instance.java.lang.Class
getSupportedBeanType()
Returns the supported bean type.protected java.lang.String
getTooltipTitle(WebObjectInfo item)
This method returns the tooltip title to be displayed on each object.protected void
initEditor(Editor editor)
Initialize the editor with the global settings.void
initializeImages()
Initializes the name of the images to use on this transform's output.void
initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.protected boolean
isObjectSubtypeVisible(WebObjectInfo object)
Is a validation method to check if the object's type is visible.protected boolean
isObjectTypeVisible(WebObjectInfo object)
Is a validation method to check if the object's type is visible.boolean
isTransformEnabled()
Indicates if the transform can be performed for the current state of the bean.protected boolean
shouldDisplayObject(WebObjectInfo obj)
Returns a boolean value if the user has enough ACLS and privileges to display the object.-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractEditorTransform
generateForm, getDivTagAroundContents, getEditorTitle, getOnSubmitJS, getWebBeanErrorInfo, initHelp, renderEditor, renderEditorContents, renderEditorElement, renderJavascript, setFocusFieldId, transformForRequestInError, 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, 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, hasSubBlock, initHeightAndWidthFromPreferences, initializeCss, 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, 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, getDescription, getFormalParams, getPreview, isPreviewAvailable, isResolved, supports, supports
-
-
-
-
Field Detail
-
sSpaces
protected static final java.lang.String sSpaces
- See Also:
- Constant Field Values
-
folderImage
public FormalParameter folderImage
Indicates 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.
-
_imgFolder
protected java.lang.String _imgFolder
-
reportImage
public FormalParameter reportImage
Indicates the image to use when displaying a 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.
-
_imgReport
protected java.lang.String _imgReport
-
graphImage
public FormalParameter graphImage
Indicates 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.
-
_imgGraph
protected java.lang.String _imgGraph
-
gridGraphImage
public FormalParameter gridGraphImage
Indicates the image to use when displaying a grid and 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.
-
_imgGridGraph
protected java.lang.String _imgGridGraph
-
cubeImage
public FormalParameter cubeImage
Indicates the image to use when displaying a cube.
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
_imgCube
protected java.lang.String _imgCube
-
filterImage
public FormalParameter filterImage
Indicates 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.
-
_imgFilter
protected java.lang.String _imgFilter
-
attributeImage
public FormalParameter attributeImage
Indicates the image to use when displaying an attribute.
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
_imgAttribute
protected java.lang.String _imgAttribute
-
raImage
public FormalParameter raImage
-
_imgRa
protected java.lang.String _imgRa
-
attributeFormImage
public FormalParameter attributeFormImage
Indicates the image to use when displaying an attribute form.
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
_imgAttributeForm
protected java.lang.String _imgAttributeForm
-
derivedMetricImage
public FormalParameter derivedMetricImage
Indicates the image to use when displaying a derived metric.
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
_imgDerivedMetric
protected java.lang.String _imgDerivedMetric
-
metricImage
public FormalParameter metricImage
Indicates the image to use when displaying a metric.
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
_imgMetric
protected java.lang.String _imgMetric
-
metricDmxImage
public FormalParameter metricDmxImage
Indicates the image to use when displaying a Predictive metric.
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
_imgMetricDmx
protected java.lang.String _imgMetricDmx
-
consolidationImage
public FormalParameter consolidationImage
Indicates the image to use when displaying a consolidation.
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
_imgConsolidation
protected java.lang.String _imgConsolidation
-
customGroupImage
public FormalParameter customGroupImage
Indicates the image to use when displaying a custom group.
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
_imgCustomGroup
protected java.lang.String _imgCustomGroup
-
hierarchyImage
public FormalParameter hierarchyImage
Indicates the image to use when displaying a hierarchy.
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
_imgHierarchy
protected java.lang.String _imgHierarchy
-
promptImage
public FormalParameter promptImage
Indicates the image to use when displaying a prompt.
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
_imgPrompt
protected java.lang.String _imgPrompt
-
objectTypesFilter
public FormalParameter objectTypesFilter
Indicates the filter specification for the object types that should not be displayed.
This filter is applied on top of whatever filter used in the bean when obtaining the information. Usage:
The value to specify for this formal parameter should be a list of numeric object types, separated by commas, with the ones that should not be displayed when transforming the bean. For example, "3,4", indicates reports (EnumDSSXMLObjectTypes.DssXmlTypeReportDefinition
) and metricsEnumDSSXMLObjectTypes.DssXmlTypeMetric
) should not be displayed if found on the collection of objects to display.
-
objectSubtypesFilter
public FormalParameter objectSubtypesFilter
Indicates the filter specification for the object subtypes that should not be displayed.
This filter is applied on top of whatever filter used in the bean when obtaining the information. Usage:
The value to specify for this formal parameter should be a list of numeric object subtypes, separated by commas, with the ones that should not be displayed when transforming the bean. For example, "257,769", indicates custom groups (EnumDSSXMLObjectSubTypes.DssXmlSubTypeCustomGroup
) and graphsEnumDSSXMLObjectSubTypes.DssXmlSubTypeReportGraph
) should not be displayed if found on the collection of objects to display.
-
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_REPORT_IMAGE
public static final java.lang.String FP_REPORT_IMAGE
Constant specifying the name of the formal parameter for defining the report image. Value is reportImage.- See Also:
- Constant Field Values
-
FP_GRAPH_IMAGE
public static final java.lang.String FP_GRAPH_IMAGE
Constant specifying the name of the formal parameter for defining the report image. Value is graphImage.- See Also:
- Constant Field Values
-
FP_GRID_GRAPH_IMAGE
public static final java.lang.String FP_GRID_GRAPH_IMAGE
Constant specifying the name of the formal parameter for defining the report image. Value is gridGraphImage.- See Also:
- Constant Field Values
-
FP_CUBE_IMAGE
public static final java.lang.String FP_CUBE_IMAGE
Constant specifying the name of the formal parameter for defining the cube image. Value is cubeImage.- 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_ATTRIBUTE_IMAGE
public static final java.lang.String FP_ATTRIBUTE_IMAGE
Constant specifying the name of the formal parameter for defining the attribute image. Value is attributeImage.- See Also:
- Constant Field Values
-
FP_RA_IMAGE
public static final java.lang.String FP_RA_IMAGE
Constant specifying the name of the formal parameter for defining the recursive attribute image. Value is raImage.- See Also:
- Constant Field Values
-
FP_ATTRIBUTE_FORM_IMAGE
public static final java.lang.String FP_ATTRIBUTE_FORM_IMAGE
Constant specifying the name of the formal parameter for defining the attribute form image. Value is attributeFormImage.- See Also:
- Constant Field Values
-
FP_METRIC_IMAGE
public static final java.lang.String FP_METRIC_IMAGE
Constant specifying the name of the formal parameter for defining the metric image. Value is metricImage.- See Also:
- Constant Field Values
-
FP_DERIVED_METRIC_IMAGE
public static final java.lang.String FP_DERIVED_METRIC_IMAGE
Constant specifying the name of the formal parameter for defining the derived metric image. Value is derivedMetricImage.- See Also:
- Constant Field Values
-
FP_METRIC_DMX_IMAGE
public static final java.lang.String FP_METRIC_DMX_IMAGE
Constant specifying the name of the formal parameter for defining the derived metric image. Value is derivedMetricImage.- See Also:
- Constant Field Values
-
FP_CONSOLIDATION_IMAGE
public static final java.lang.String FP_CONSOLIDATION_IMAGE
Constant specifying the name of the formal parameter for defining the consolidation image. Value is consolidationImage.- See Also:
- Constant Field Values
-
FP_CUSTOM_GROUP_IMAGE
public static final java.lang.String FP_CUSTOM_GROUP_IMAGE
Constant specifying the name of the formal parameter for defining the custom group image. Value is customGroupImage.- See Also:
- Constant Field Values
-
FP_HIERARCHY_IMAGE
public static final java.lang.String FP_HIERARCHY_IMAGE
Constant specifying the name of the formal parameter for defining the hierarchy image. Value is hierarchyImage.- See Also:
- Constant Field Values
-
FP_PROMPT_IMAGE
public static final java.lang.String FP_PROMPT_IMAGE
Constant specifying the name of the formal parameter for defining the prompt image. Value is promptImage.- See Also:
- Constant Field Values
-
FP_OBJECT_TYPES_FILTER
public static final java.lang.String FP_OBJECT_TYPES_FILTER
Constant specifying the name of the formal parameter for defining the object types to consider for the filter. Value is objectTypesFilter.- See Also:
- Constant Field Values
-
FP_OBJECT_SUBTYPES_FILTER
public static final java.lang.String FP_OBJECT_SUBTYPES_FILTER
Constant specifying the name of the formal parameter for defining the object subtypes to consider for the filter. Value is objectSubtypesFilter.- See Also:
- Constant Field Values
-
FP_INCLUDE_DYNAMIC_SCRIPT
public static final java.lang.String FP_INCLUDE_DYNAMIC_SCRIPT
Constant specifying the name of the formal parameter for specifying whether to include dynamic scripts or not. Value is includeDynamicScript.- See Also:
- Constant Field Values
-
-
Method Detail
-
isTransformEnabled
public boolean isTransformEnabled()
Indicates if the transform can be performed for the current state of the bean. If there's a case where the bean might be ready but the information it gets does not match what the transform expects, the rendering process might be stopped here. The outcome will be the component not being rendered at all (which can be logged as a warning for future investigation).- Returns:
True
if it's possible to use the transform for rendering the bean. Otherwise, returnsFalse
-
getSupportedBeanType
public java.lang.Class getSupportedBeanType()
Returns the supported bean type. This transform supports any of theObjectBrowserTabBean
instances- Specified by:
getSupportedBeanType
in interfaceTransform
- Overrides:
getSupportedBeanType
in classAbstractAppTransform
- Returns:
- the class of the bean supported by this transform.
-
initializeImages
public void initializeImages()
Initializes the name of the images to use on this transform's output. For each one of the images defined to be displayed, the resource folder information is added to its path and file name as specified on the formal parameters for the images.- Overrides:
initializeImages
in classAbstractAppTransform
-
initializeTransform
public void initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform. In particular it invokes the initializeJavaScriptAttribute method.- Specified by:
initializeTransform
in interfaceAppTransform
- Overrides:
initializeTransform
in classAbstractEditorTransform
- Parameters:
data
-Transformable
instance to be transformed.
-
getJavascriptTyAttribute
protected java.lang.String getJavascriptTyAttribute(WebObjectInfo object)
Return the Javascript TY attribute to use for the generation of the HTML tag related with this object.- Parameters:
object
- TheWebObjectInfo
for which it's ty attribute name is requested.- Returns:
- The Javascript TY attribute to use for the generation of the HTML tag related with
this object. If none is found given the object type,
null
will be returned.
-
getClassName
protected java.lang.String getClassName(WebObjectInfo object)
Return the class name to use for the generation of the HTML tag related with this object.- Parameters:
object
- TheWebObjectInfo
for which the class name is required- Returns:
- The Class name for that particular object
this object. If none is found given the object type,
null
will be returned.
-
getFolderLinkClasses
protected java.lang.String getFolderLinkClasses(WebObjectInfo object)
Return the className of the folderLink that is used to render the folder- Parameters:
object
- TheWebObjectInfo
for which class name is requested.- Returns:
- The class name
-
getObjectImageName
protected java.lang.String getObjectImageName(WebObjectInfo object)
Utility method that helps giving the image name to use - based on the information available on the formal parameters - based on the the object type and/or subtype 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 on theWebObjectInfo
definition does not match the predefined list of styles, it looks then based on the subtype. If still not found, it will return a transparent image.
-
formatObjectInfoParameter
protected java.lang.String formatObjectInfoParameter(java.lang.String id, java.lang.String type, java.lang.String subType, java.lang.String alias, java.lang.String name)
Outputs a string formatted the way the objectInfo argument of the event requires it- Parameters:
id
- id of the objecttype
- type of the objectsubType
- subtype of the object (should be null if dealing with the filter event)alias
- alias of the objectname
- name of the object- Returns:
- a String with the following format: ID|Type|Subtype|Alias|Name or
-
isObjectTypeVisible
protected boolean isObjectTypeVisible(WebObjectInfo object)
Is a validation method to check if the object's type is visible.- Parameters:
object
- TheWebObjectInfo
whose type visibility has to be checked.- Returns:
- True if the object key is found in the hash map of all the filtered types.
-
isObjectSubtypeVisible
protected boolean isObjectSubtypeVisible(WebObjectInfo object)
Is a validation method to check if the object's type is visible.- Parameters:
object
- TheWebObjectInfo
whose sub-type visibility has to be checked.- Returns:
- True if the object key is found in the hash map of all the filtered sub-types.
-
initEditor
protected void initEditor(Editor editor)
Initialize the editor with the global settings.- Overrides:
initEditor
in classAbstractEditorTransform
- Parameters:
editor
-Editor
instance to initialize
-
generateTooltipInformation
protected java.lang.String generateTooltipInformation(java.lang.String objectAlias, WebObjectInfo item)
Generates a string that returns the information that would be displayed as a tooltip for theWebObjectInfo
item.- Parameters:
objectAlias
- a String that has an alias to be displayed on the tooltip along with the item's title.item
- TheWebObjectInfo
for which the tooltip information has to be generated.- Returns:
- a String with the object's tooltip information. This includes the Object Name, Alias and a description.
-
getObjectDescription
protected java.lang.String getObjectDescription(WebObjectInfo item)
Returns the item's description from it's Object Info depending on whether the Allow HTML on object description property has been set.- Parameters:
item
- TheWebObjectInfo
for which the description is required.- Returns:
- a String with the description of the object.
-
shouldDisplayObject
protected boolean shouldDisplayObject(WebObjectInfo obj)
Returns a boolean value if the user has enough ACLS and privileges to display the object.- Parameters:
The
-WebObjectInfo
for which the ACLs and privileges are checked.- Returns:
- Whether the user has enough ACLs and privileges to display the object.
-
getTooltipTitle
protected java.lang.String getTooltipTitle(WebObjectInfo item)
This method returns the tooltip title to be displayed on each object. It is generated based on the type of the object.- Parameters:
item
- TheWebObjectInfo
based on which the tooltip has to be derived.- Returns:
- A string with the appropriate tooltip.
-
-