Perforce 2013.1 Javascript API for Visual Tools

More documents

Recommendations

Info

JavaScript API Methods Utility Functions Method encodeForHTML(str) encodeForHTMLAttribute(str) encodeForJavaScript(str) setWebKitDeveloperExtrasEnabled(bool) getImage(imagename) getImageNames() getSelection setP4VErrorDialogEnabled(true|false) setSelection(selList[,function(callback)] Map Description Encodes characters to prevent XSS attacks injected into dynamic data. For details, see “Preventing Cross-Site Scripting (XSS) Attacks” on page 25. Enables or disables the Inspect item in the context menu, which displays the WebKit WebInspector for debugging. Returns a string containing the specified P4V image in HTML embedded format. Use the names returned by getImageNames(). Returns a string array containing a list of images used by P4V to indicate file type and status. For consistency with P4V, use these images in your applications. Returns a list of the folders and files that are currently selected in the depot pane. Enable/disable display of server errors in popups. (By default, server errors are displayed in popups. Specify true to enable, false to disable. Given a list of paths and files, selects them in the depot pane and, if specified, executes the optional callback function. Enables you to construct an optimized workspace mapping for a client workspace specification that your application creates or modifies. 32 Perforce 2013.1 JavaScript API for Visual Tools
JavaScript API Methods The Map Function: Details The P4JsApi.Map function enables your application to manipulate Perforce client view mappings. Client view mappings define which depot files are accessible for a specified workspace, and where they reside on the local disk. For detailed information about client view mappings, refer to the P4 User’s Guide and the Perforce Command Reference Manual discussion of the p4 client command. Class level methods P4JsApi.Map.join(map1, map2): Returns the map that results from joining the two input maps. Properties map: A list of mapping lines. Instance methods Method clear() count() empty() includes(path) insert(left, [right]) join(map) left() new([s]) reverse() right() translate(path, reverse) Description Clears the mapping lines Returns the number of mapping lines Returns true if the map is empty Returns true if path is mapped Inserts a mapping line into the map. If right is provided, left and right are the left and right hand sides of the mapping line. If right is not provided, left is assumed to contain both sides of the map. Any spaces in the mapping strings must be quoted Returns a new map of this object joined with map. Returns a list of the left side of the mapping Constructs a new Map object. s can be a single mapping line string or a list containing mapping line strings Returns a new P4JsApi.Map object with the left and right sides of the mapping swapped Returns a list of the right side of the mapping Translates path through the map and return the result. If reverse is true, translate from right to left Perforce 2013.1 JavaScript API for Visual Tools 33
Page 1 and 2: Perforce 2013.1 JavaScript API for
Page 3 and 4: Table of Contents Chapter 1 Perforc
Page 5 and 6: Chapter 1 Perforce JavaScript API f
Page 7 and 8: The Permissions Table Entry The Per
Page 9 and 10: The Central Settings File Another a
Page 11 and 12: Programming Applets To pass form da
Page 13 and 14: Programming Applets if (!!p4out.dat
Page 15 and 16: Extending P4Admin and P4V Using P4W
Page 17 and 18: Extending P4Admin and P4V Example:
Page 19 and 20: Extending P4Admin and P4V Use the f
Page 21 and 22: Administering P4V Settings Centrall
Page 23 and 24: Security • Developer extras (to e
Page 25 and 26: Security Preventing Cross-Site Scri
Page 27 and 28: Troubleshooting Troubleshooting The
Page 29 and 30: Appendix A Method and Command Refer
Page 31: JavaScript API Methods Method getSe
Page 35 and 36: Supported p4 Commands Command confi
Page 37 and 38: Supported p4 Commands Command prote
Page 39 and 40: Index A Adding tabs 17 Alerts 15, 2

Perforce 2013.1 Javascript API for Visual Tools

Create successful ePaper yourself

Delete template?

Save as template?