|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ptc.wvs.common.ui.VisualizationHelper
The VisualizationHelper class provides abstract access to class methods in the com.ptc.wvs
package from external packages such as wt and provides visualization helper methods.
Supported API: true
Field Summary | |
static String |
DEFAULT_THUMBNAILS_PROP_PAGE_PREF_VALUE
Thumbnail preference default value to use in getIndexOfVisLink Supported API: true |
static String |
THUMBNAILS_PROP_PAGE_PREF_KEY
Thumbnail preference key to use in getIndexOfVisLink Supported API: true |
Constructor Summary | |
VisualizationHelper()
|
Method Summary | |
int |
clipboardLinkIndex()
Returns the index of the Add to Clipboard link in the data array returned by getDefaultVisualizationData Supported API: true |
int |
defaultIconIndex()
Returns the index of the Default Representation link in the data array returned by getDefaultVisualizationData Supported API: false |
int |
deleteLinkIndex()
Returns the index of the delete link in the data array returned by getDefaultVisualizationData Supported API: false |
String |
getCreateDialogWindow()
Returns the JavaScript to create a Dialog Window. |
String[] |
getDefaultVisualizationData(String representableObjectReference,
Boolean forListing,
Locale locale)
Returns a set of HTML fragments to display thumbnails and other visualization action links Supported API: true |
String |
getDocThumbnailImage()
Returns the name of the dummy WTDocument thumbnail image file Supported API: false |
int |
getIndexOfVisLink(String prefKey,
String prefDefault)
Returns the index in the data array returned by getDefaultVisualizationData of the HTML fragment to use for launching PV. |
String |
getJSPDirectoryPath()
Returns the path of the visualization jsp page directory in codebase Supported API: false |
String |
getPartStructureBasicURL(String objRef,
String configString,
Integer levels)
Returns the URL to the Visualization for the representation Supported API: false |
String[] |
getPartStructureCreateRepFormHTML(String objectReference,
Integer levels,
Integer type,
Locale locale)
Returns HTML fragments for creating a representation for the WTPart structure. |
String |
getPartStructureED(String objectReference,
String configString,
Integer levels)
Returns ED file content for viewing the WTPart structure. |
String[] |
getPartStructureFormHTML(String objectReference,
Integer levels,
Integer type,
Locale locale)
Returns HTML fragments for viewing the WTPart structure. |
String |
getPartStructureHTML(String objectReference,
String configString,
Integer levels,
Locale locale)
Returns the HTML fragment for viewing the WTPart structure, the users current WTPartConfigSpec will be used. |
String |
getPartStructureHTML(String objectReference,
String configString,
Integer levels,
Locale locale,
Boolean displayThumbnail,
Boolean forListing)
Returns the HTML fragment for viewing the WTPart structure, the users current WTPartConfigSpec will be used. |
String |
getPartStructurePublishHTML(String objectReference)
Returns an HTML fragment to allow publishing of a default representation from a WTPart or EPMDocument NOTE: this is not publishing the Part Structure, it is publishing the EPMDoc. |
String[] |
getPartStructurePVandViewThumbnailLinkHTML(String objectReference)
Returns 2 HTML fragments to view in PV and view the thumbnail of the default representation from the HTML Product Structure page. |
WTKeyedMap |
getPartStructurePVandViewThumbnailLinkHTML(WTCollection collection)
Returns 2 HTML fragments to view in PV and view the thumbnail of the default representation from the HTML Product Structure page. |
String |
getPartStructurePVHTML(String objectReference)
Returns an HTML fragment to allow ProductView or ProductViewLite to be launched from the object NAME/NUMBER links in HTML tables and the Product Structure page. |
WTKeyedMap |
getPartStructurePVHTML(WTCollection collection)
Returns a set of HTML fragment to allow ProductView to be launched from the NAME link on the HTML Product Structure page. |
String |
getPartStructureViewThumbnailLinkHTML(String objectReference)
Returns an HTML fragment to allow the thumbnail to be launched from the object NAME/NUMBER links in HTML tables and the Product Structure page. |
WTKeyedMap |
getPartStructureViewThumbnailLinkHTML(WTCollection collection)
Returns a set of HTML fragment to view the thumbnail of the default representation from the HTML Product Structure page. |
String |
getPVFileUploadPref()
Returns the user preference for uploading ProductView files. |
int[] |
getThumbnailSize()
Returns the thumbnail width and height Supported API: true |
String |
getThumbnailURL(String objectReference)
Returns the URL to the Thumbnail Image for the representation Supported API: false |
String |
getVisLink(String objectReference,
String prefKey,
String prefDefault,
Boolean forListing)
Returns the HTML for the URL and image to be displayed as a thumbnail for an object, based on the thumbnail preference for the client. |
String |
getVisLink(String objectReference,
String prefKey,
String prefDefault,
Boolean forListing,
Locale locale)
Returns the HTML for the URL and image to be displayed as a thumbnail for an object, based on the thumbnail preference for the client. |
String |
getVisToolTipsPref()
Returns the user preference for displaying Visualization tool tips The return value will be either VisualizationHelperIfc.PREF_VALUE_YES or VisualizationHelperIfc.PREF_VALUE_NO. |
int |
hasMarkupIconIndex()
Returns the index of the Markups link in the data array returned by getDefaultVisualizationData Supported API: false |
static boolean |
isAdministrator()
Determines if the current user is a Windchill administrator Supported API: false |
boolean |
isWVSEnabled()
Returns true if visualization services are enabled Supported API: true |
int |
makeDefaultLinkIndex()
Returns the index of the make default link in the data array returned by getDefaultVisualizationData Supported API: false |
static VisualizationHelper |
newVisualizationHelper()
Default factory for the class. |
int |
printLinkIndex()
Returns the index of the Print link in the data array returned by getDefaultVisualizationData Supported API: true |
int |
productViewLinkIndex()
Returns the index of the Launch ProductView link in the data array returned by getDefaultVisualizationData Supported API: true |
int |
refreshLinkIndex()
Returns the index of the refresh link in the data array returned by getDefaultVisualizationData Supported API: false |
int |
repConfigSpecIndex()
Returns the index of the representation config spec in the data array returned by getDefaultVisualizationData Supported API: false |
int |
repDateCreatedIndex()
Returns the index of the representation creation date in the data array returned by getDefaultVisualizationData Supported API: false |
int |
repDescriptionIndex()
Returns the index of the representation description in the data array returned by getDefaultVisualizationData Supported API: false |
int |
repNameIndex()
Returns the index of the representation name in the data array returned by getDefaultVisualizationData Supported API: false |
int |
thumbnailLinkIndex()
Returns the index of the thumbnail, Publish Me, or Launch ProductView link in the data array returned by getDefaultVisualizationData. |
int |
viewPartStructureLinkIndex()
Returns the index of the part structure view link in the data array returned by getDefaultVisualizationData Supported API: false |
int |
viewRepsLinkIndex()
Returns the index of the view representations link in the data array returned by getDefaultVisualizationData Supported API: true |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String THUMBNAILS_PROP_PAGE_PREF_KEY
public static final String DEFAULT_THUMBNAILS_PROP_PAGE_PREF_VALUE
Constructor Detail |
public VisualizationHelper()
Method Detail |
public boolean isWVSEnabled()
isWVSEnabled
in interface VisualizationHelperIfc
public String getPVFileUploadPref()
getPVFileUploadPref
in interface VisualizationHelperIfc
public String getVisToolTipsPref()
getVisToolTipsPref
in interface VisualizationHelperIfc
public String getJSPDirectoryPath()
getJSPDirectoryPath
in interface VisualizationHelperIfc
public int[] getThumbnailSize()
getThumbnailSize
in interface VisualizationHelperIfc
public String getDocThumbnailImage()
getDocThumbnailImage
in interface VisualizationHelperIfc
public String getCreateDialogWindow()
getCreateDialogWindow
in interface VisualizationHelperIfc
public String[] getDefaultVisualizationData(String representableObjectReference, Boolean forListing, Locale locale)
getDefaultVisualizationData
in interface VisualizationHelperIfc
representableObjectReference
- The object reference of the representableforListing
- Specifies if the resulting HTML is to be used in a listinglocale
- Specifies the locale to use for tooltip display
public int productViewLinkIndex()
productViewLinkIndex
in interface VisualizationHelperIfc
public int thumbnailLinkIndex()
thumbnailLinkIndex
in interface VisualizationHelperIfc
public int clipboardLinkIndex()
clipboardLinkIndex
in interface VisualizationHelperIfc
public int printLinkIndex()
printLinkIndex
in interface VisualizationHelperIfc
public int defaultIconIndex()
defaultIconIndex
in interface VisualizationHelperIfc
public int hasMarkupIconIndex()
hasMarkupIconIndex
in interface VisualizationHelperIfc
public int repNameIndex()
repNameIndex
in interface VisualizationHelperIfc
public int repDescriptionIndex()
repDescriptionIndex
in interface VisualizationHelperIfc
public int repConfigSpecIndex()
repConfigSpecIndex
in interface VisualizationHelperIfc
public int repDateCreatedIndex()
repDateCreatedIndex
in interface VisualizationHelperIfc
public int deleteLinkIndex()
deleteLinkIndex
in interface VisualizationHelperIfc
public int refreshLinkIndex()
refreshLinkIndex
in interface VisualizationHelperIfc
public int makeDefaultLinkIndex()
makeDefaultLinkIndex
in interface VisualizationHelperIfc
public int viewRepsLinkIndex()
viewRepsLinkIndex
in interface VisualizationHelperIfc
public int viewPartStructureLinkIndex()
viewPartStructureLinkIndex
in interface VisualizationHelperIfc
public int getIndexOfVisLink(String prefKey, String prefDefault)
getIndexOfVisLink
in interface VisualizationHelperIfc
prefKey
- The key for the user preference to display thumbnails
use THUMBNAILS_PROP_PAGE_PREF_KEY for the property page
preference keyprefDefault
- The default value for the key, use
DEFAULT_THUMBNAILS_PROP_PAGE_PREF_VALUE for the default property page value
public String getVisLink(String objectReference, String prefKey, String prefDefault, Boolean forListing)
public String getVisLink(String objectReference, String prefKey, String prefDefault, Boolean forListing, Locale locale)
getVisLink
in interface VisualizationHelperIfc
public String getPartStructureHTML(String objectReference, String configString, Integer levels, Locale locale)
getPartStructureHTML
in interface VisualizationHelperIfc
objectReference
- The object reference of the WTPartconfigString
- a String representation of the ConfigSpec or nulllevels
- Specifies number of levels to traverse, -1 = alllocale
- Specifies locale for ALT tags
public String getPartStructureHTML(String objectReference, String configString, Integer levels, Locale locale, Boolean displayThumbnail, Boolean forListing)
getPartStructureHTML
in interface VisualizationHelperIfc
objectReference
- The object reference of the WTPartconfigString
- a String representation of the ConfigSpec or nulllevels
- Specifies number of levels to traverse, -1 = alllocale
- Specifies locale for ALT tagsdisplayThumbnail
- If TRUE the thumbnail will be exposed in the html, if not, an icon will be displayed.forListing
- If TRUE, the HTML will be for a result table
public String[] getPartStructureFormHTML(String objectReference, Integer levels, Integer type, Locale locale)
getPartStructureFormHTML
in interface VisualizationHelperIfc
objectReference
- The object reference of the WTPartlevels
- Specifies number of levels to traverse, -1 = alltype
- Specifies visible type, 1=text only(default), 2=icon only, 3= text & iconlocale
- Specifies locale for ALT tags
public String[] getPartStructureCreateRepFormHTML(String objectReference, Integer levels, Integer type, Locale locale)
getPartStructureCreateRepFormHTML
in interface VisualizationHelperIfc
objectReference
- The object reference of the WTPartlevels
- Specifies number of levels to traverse, -1 = alltype
- Specifies visible type, 1=text only(default), 2=icon only, 3= text & iconlocale
- Specifies locale for ALT tags
public String getPartStructureED(String objectReference, String configString, Integer levels)
getPartStructureED
in interface VisualizationHelperIfc
objectReference
- The object reference of the WTPartconfigString
- a String representation of the ConfigSpec or nulllevels
- Specifies number of levels to traverse, -1 = all
public static boolean isAdministrator()
public String getPartStructurePVHTML(String objectReference)
getPartStructurePVHTML
in interface VisualizationHelperIfc
objectReference
- The object reference of the representable
public String getPartStructureViewThumbnailLinkHTML(String objectReference)
getPartStructureViewThumbnailLinkHTML
in interface VisualizationHelperIfc
objectReference
- The object reference of the representable
public String[] getPartStructurePVandViewThumbnailLinkHTML(String objectReference)
getPartStructurePVandViewThumbnailLinkHTML
in interface VisualizationHelperIfc
objectReference
- The object reference of the representable
public String getPartStructurePublishHTML(String objectReference)
getPartStructurePublishHTML
in interface VisualizationHelperIfc
objectReference
- The object reference of the representable
public static VisualizationHelper newVisualizationHelper()
public String getThumbnailURL(String objectReference)
getThumbnailURL
in interface VisualizationHelperIfc
objectReference
- The object reference of the representation
public String getPartStructureBasicURL(String objRef, String configString, Integer levels)
VisualizationHelperIfc
getPartStructureBasicURL
in interface VisualizationHelperIfc
objRef
- The object reference of the representationconfigString
- ???levels
- The number of levels
public WTKeyedMap getPartStructurePVHTML(WTCollection collection)
getPartStructurePVHTML
in interface VisualizationHelperIfc
collection
- a WTCollection of objects
public WTKeyedMap getPartStructureViewThumbnailLinkHTML(WTCollection collection)
getPartStructureViewThumbnailLinkHTML
in interface VisualizationHelperIfc
collection
- a WTCollection of objects
public WTKeyedMap getPartStructurePVandViewThumbnailLinkHTML(WTCollection collection)
getPartStructurePVandViewThumbnailLinkHTML
in interface VisualizationHelperIfc
collection
- a WTCollection of objects
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |