Teamcenter 8.3 Rich Client Customization Programmer’s Guide Publication Number PLM00075 F Proprietary and restricted rights notice This software and related documentation are proprietary to Siemens Product Lifecycle Management Software Inc. © 2010 Siemens Product Lifecycle Management Software Inc. All Rights Reserved. All trademarks belong to their respective holders. 2 Rich Client Customization Programmer’s Guide PLM00075 F Contents Proprietary and restricted rights notice . 2 Getting started . 1-1 Before you begin . 1-1 Enable rich client customization . 1-2 Basic concepts about rich client customization . 1-4 Basic tasks for rich client customizations . 1-31 Sample customizations . 2-1 Common customizations . 2-1 Miscellaneous customizations . 2-61 Customizing forms and properties display . 3-1 Communication with the server . 3-1 Form user interface display components . 3-2 Displaying a form . 3-2 Teamcenter form types . 3-3 Developing automatic forms . 3-4 Developing forms by extending the abstract class . 3-5 Developing forms using JavaBeans . 3-11 Developing forms and customizing the properties display using XML style sheets . 3-13 Performing advanced customizations . 4-1 Customize the rich client properties files . 4-1 Customizing Command Suppression . 4-4 Registering user service functions on the server side . 4-7 Register run-time properties for Teamcenter business objects . 4-9 Displaying files in the viewer . 4-13 Customizing the data tabs display . 4-14 Customizing the rich client to perform additional validations on a file . 4-16 Creating pre- and post-actions in Resource Manager and Classification . 4-18 Writing headless programs . 4-24 Tips for rich client customization . 5-1 Using color within the rich client . 5-1 Localization of rich client customizations . 5-1 Updating your rich client customizations from previous versions . 5-2 Hide perspectives . 5-2 Changing the rendering property . 5-3 Define global properties . 5-3 Troubleshooting rich client customization . 6-1 PLM00075 F Rich Client Customization Programmer’s Guide 3 Contents Common problems in rich client customization . 6-1 Rich client debugging tools . 6-2 Enabling client-side logging . 6-5 Listener leaks . 6-7 Glossary . A-1 Rich client customization reference . B-1 Command line options for rich client startup . B-1 Coding standards . B-4 User interface components documented in Javadoc . B-6 Application Integration Framework (AIF) . B-49 Index . Index-1 Figures Starting the search for style sheets . 1-14 Searching for XMLRenderingStylesheet datasets . 1-15 Viewing the search results for XMLRenderingStylesheet datasets . 1-15 Viewing the style sheet contents . 1-16 Viewing the business object type that the style sheet is registered to . 1-17 Viewing the style sheet type . 1-17 Viewing the REGISTEREDTO preferences . 1-18 Types of available style sheets . 1-20 Properties dialog box . 1-20 Property style sheet . 1-21 Sample form . 1-22 Summary tab . 1-23 Summary style sheet . 1-24 Creation dialog box . 1-25 Create style sheet . 1-26 Summary tab in the My Teamcenter (2007) perspective . 1-27 Summary 2007 style sheet . 1-28 Create a custom style sheet . 1-30 Viewing the <dataset_name>.REGISTEREDTO and <type_name>.RENDERING preferences . 1-31 Adding a property to the Summary pane . 2-3 Adding a property to the Properties pane on the Summary tab . 2-4 The User Data boxes on the Item Master form . 2-5 The Item Master Form with the User Data boxes removed . 2-6 Selecting the item master form . 2-7 Default item master form . 2-7 Customized layout of the form’s General properties page . 2-8 Customized layout of the form’s Advanced properties page . 2-9 New graphic in the logon window . 2-10 New icon used for folder business objects . 2-14 Custom menu command on the menu bar . 2-15 Custom button on the tool bar . 2-15 Action launched from the custom menu command or button . 2-15 4 Rich Client Customization Programmer’s Guide PLM00075 F Contents Custom menu command moved to the Tools menu . 2-17 Custom menu command added to the shortcut menu . 2-19 Custom button on the tool bar . 2-21 Action launched from the custom button . 2-21 Custom button location moved on the toolbar . 2-22 Custom view in the list of available views . 2-27 Custom menu command displayed when the custom view is open . 2-27 Custom view in the list of available views . 2-33 Custom view displaying the contents of the selected object . 2-33 Launching the custom application . 2-39 New SendTo application in the navigation pane . 2-45 New SendTo application added to the Send To menu . 2-46 Message box resulting from the command override . 2-50 Custom form in the item creation wizard . 2-55 Choosing the custom menu command in the Spanish user interface . 2-58 Untranslated custom message box . 2-59 Translated custom message box . 2-60 Exit command button on the view toolbar . 2-64 Menu button on the view toolbar . 2-64 Exit command on the view menu . 2-64 TableViewer menu command . 2-71 TableViewer button . 2-71 TableViewer dialog box . 2-72 TreeViewer menu command . 2-76 TreeViewer button . 2-76 Tree viewer . ..