|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The VisualizationServiceIfc class provides abstract access to the methods in the
com.ptc.wvs package classes from classes in wt.
Supported API: false
Method Summary | |
int |
clipboardLinkIndex()
Returns the index of the Add to Clipboard link in the data array returned by getDefaultVisualizationData Supported API: false |
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 related to a given Representable Supported API: false |
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 URL 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 the HTML fragment that will allow publishing to be launched from the NAME link on the HTML Product Structure Page the fragment will be of the form javascript:createdialog(.... |
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 the HTML fragment that will allow productview to be launched from the NAME link on the HTML Product Structure Page the fragment will be of the form javascript:createdialog(.... |
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 the HTML fragment that will allow the thumbnail to be launched from the NAME link on the HTML Product Structure Page the fragment will be of the form javascript:createdialog(.... |
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 user-preferred thumbnail width and height Supported API: false |
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,
Locale locale)
Returns the HTML for the URL and image to be displayed as a thumbnail for an object, based on the based on the thumbnail preference for the client. |
String |
getVisToolTipsPref()
Returns the user preference for displaying Visualization tool tips on Visualization pages and property pages 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 |
boolean |
isWVSEnabled()
Returns true if visualization services and required software are installed and configured. |
int |
makeDefaultLinkIndex()
Returns the index of the make default link in the data array returned by getDefaultVisualizationData Supported API: false |
int |
printLinkIndex()
Returns the index of the Print link in the data array returned by getDefaultVisualizationData Supported API: false |
int |
productViewLinkIndex()
Returns the index of the Launch ProductView link in the default visualization data array returned by getDefaultVisualizationData Supported API: false |
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 Supported API: false |
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: false |
Field Detail |
public static final String PREF_VALUE_YES
public static final String PREF_VALUE_NO
public static final String THUMBNAILS_SEARCH_PREF_KEY
public static final String THUMBNAILS_PROP_PAGE_PREF_KEY
public static final String THUMBNAILS_VIS_PORTAL_PREF_KEY
public static final String DEFAULT_THUMBNAILS_SEARCH_PREF_VALUE
public static final String DEFAULT_THUMBNAILS_PROP_PAGE_PREF_VALUE
public static final String DEFAULT_THUMBNAILS_VIS_PORTAL_PREF_VALUE
public static final String THUMBNAILS_PREF_NODE
public static final String PREF_PVIEW_UPLOAD_ALL
public static final String PREF_PVIEW_UPLOAD_ON_DEMAND
public static final String PVIEW_UPLOAD_PREF_KEY
public static final String DEFAULT_PVIEW_UPLOAD_PREF_VALUE
public static final String PVIEW_UPLOAD_PREF_NODE
public static final String VIS_TOOL_TIPS_PREF_KEY
public static final String DEFAULT_VIS_TOOL_TIPS_PREF_VALUE
public static final String VIS_TOOL_TIPS_PREF_NODE
public static final String USEPRODUCTVIEW_PREF_KEY
public static final String DEFAULT_USEPRODUCTVIEW_PREF_VALUE
public static final String USEPRODUCTVIEW_PREF_NODE
public static final int PRODUCTVIEW_LINK
public static final int THUMBNAIL_LINK
public static final int CLIPBOARD_LINK
public static final int PRINT_LINK
public static final int DEFAULT_ICON
public static final int HAS_MARKUP_ICON
public static final int REP_NAME
public static final int REP_DESCRIPTION
public static final int REP_CONFIG_SPEC
public static final int REP_DATE_CREATED
public static final int DELETE_LINK
public static final int REFRESH_LINK
public static final int MAKE_DEFAULT
public static final int REPRESENTATIONS
public static final int PART_VIEW_LINK
public static final int PRODUCTVIEWLITE_LINK
public static final int THUMBNAIL_VIEWER_LINK
public static final int PV_PS_LINK
public static final int SAVE_ZIP_LINK
public static final int NUMBER_OF_VISDATA
Method Detail |
public boolean isWVSEnabled()
public String getPVFileUploadPref()
public String getVisToolTipsPref()
public String getJSPDirectoryPath()
public int getIndexOfVisLink(String prefKey, String prefDefault)
public String getVisLink(String objectReference, String prefKey, String prefDefault, Boolean forListing, Locale locale)
public String getCreateDialogWindow()
public int[] getThumbnailSize()
public String getDocThumbnailImage()
public String[] getDefaultVisualizationData(String representableObjectReference, Boolean forListing, Locale locale)
representableObjectReference
- The object reference of the representableforListing
- Specifies if the resulting HTML is to be used in a listing
public int productViewLinkIndex()
public int thumbnailLinkIndex()
public int clipboardLinkIndex()
public int printLinkIndex()
public int defaultIconIndex()
public int hasMarkupIconIndex()
public int repNameIndex()
public int repDescriptionIndex()
public int repConfigSpecIndex()
public int repDateCreatedIndex()
public int deleteLinkIndex()
public int refreshLinkIndex()
public int makeDefaultLinkIndex()
public int viewRepsLinkIndex()
public int viewPartStructureLinkIndex()
public String getPartStructureHTML(String objectReference, String configString, Integer levels, Locale locale)
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)
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)
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)
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)
objectReference
- The object reference of the WTPartconfigString
- a String representation of the ConfigSpec or nulllevels
- Specifies number of levels to traverse, -1 = all
public String getPartStructurePVHTML(String objectReference)
objectReference
- The object reference of the WTPart
public String getPartStructureViewThumbnailLinkHTML(String objectReference)
objectReference
- The object reference of the WTPart
public String[] getPartStructurePVandViewThumbnailLinkHTML(String objectReference)
objectReference
- The object reference of the representable
public String getPartStructurePublishHTML(String objectReference)
objectReference
- The object reference of the WTPart
public String getThumbnailURL(String objectReference)
objectReference
- The object reference of the representation
public String getPartStructureBasicURL(String objRef, String configString, Integer levels)
objRef
- The object reference of the representationconfigString
- ???levels
- The number of levels
public WTKeyedMap getPartStructurePVHTML(WTCollection collection)
collection
- a WTCollection of objects
public WTKeyedMap getPartStructureViewThumbnailLinkHTML(WTCollection collection)
collection
- a WTCollection of objects
public WTKeyedMap getPartStructurePVandViewThumbnailLinkHTML(WTCollection collection)
collection
- a WTCollection of objects
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |