Transformation classes

Table 1 lists the methods that can be overridden in a transformation class.
Table 1. RcpTransformation methods
Method Description
getApplicationKeypadDisplayInfo() Returns an IApplicationKeypadDisplayInfo object that controls how, and if, the application keypad is displayed. This method enables the application keypad to be customized for this transformation. Returning null from this method indicates that the default application keypad, based on the application's default settings, should be displayed.
getAutoAdvanceOrderer() Returns an IAutoAdvanceOrderer object that controls how, and if, auto advance is performed. The default implementation is to return null, indicating that the system should decide the auto advance handler to use from the project settings.

getDefaultMonospacedFont()

Allows you to override the default monospaced font at the transformation level. See Overriding the default monospaced font for an example that uses this method.
getHostKeypadDisplayInfo() Returns an IHostKeypadDisplayInfo object that controls how, and if, the host keypad is displayed. This method enables the host keypad to be customized for this transformation. Returning null from this method indicates that the default host keypad should be displayed based on the application's default settings. Refer to Customizing the host keypad for examples that use this method.
getOiaDisplayInfo() Returns an IOiaDisplayInfo object that controls how, and if, the OIA is displayed. This method enables the OIA to be customized for this transformation. Returning null from this method indicates that the default OIA should be displayed based on the application's default settings.
getToolbarDisplayInfo() Returns an IToolbarDisplayInfo object that controls how, and if, the toolbar is displayed. This method enables the toolbar to be customized for this transformation. Returning null from this method indicates that the default toolbar should be displayed based on the application's default settings.
handlePreSubmit() This method is called just prior to a command being submitted. Refer to Validating input on a transformation for examples that use this method.
handlePostSubmit() This method is called just after a command has been submitted.
isInitialFocusAtCursorPosition() Identifies whether the initial focus is placed at cursor position.
needsAutoAdvanceSupport() Identifies whether the auto advance function for this transformation is enabled.
preRender() This method is called prior to the render() method being called.
postRender() This method is called after the render() method is called and the rendering of the transformation is complete.
setScreenCapture() Sets the screen capture for use while editing ComponentRendering and DefaultRendering in the ZIETrans Toolkit. componentRendering.setScreenCapture( <fully qualified transformation name>.screenCapture);
needsArrowKeyNavigationSupport() Identifies whether the arrow key navigation support function for this transformation is enabled.