Use this page to create, manage, and edit live templates.
On this page:
- List of available live templates
- Context menu of a live template
- Template editing area
- Predefined functions to be used in live template variables
List of available live templates
|Item||Tooltip and shortcut||Description|
|By default expand with||Use this drop-down list to specify the default invocation key for all templates. Individual
expansion keys for the particular templates are defined in the editing area.
When Custom is selected, the Change link appears next to the drop-down, leading you to the Keymap page.
|Live Templates||This list shows all currently available template abbreviations supplied with their descriptions. The abbreviations are grouped below nodes and sorted alphabetically within each group. To activate a template or an entire group, select the check box to its left.|
|Click this button to have a new template item added to the current group of template. You can define the template abbreviation, description, text, variables, expansion key, and context in the editing area below.|
|Click this button to have the selected live template removed from the list.|
|Duplicate||Click this button to create a new template based on the selected template. A new template item is added to the current node and the fields in the Template Text area show the definition of the selected template.|
|Restore||Click this button to restore the deleted live templates. This button is only enabled when the changes are applied.|
Context menu of a live template
|Move||Choose a group to move the selected template to.|
|Change context||Choose this command to modify the set of contexts where the current template is enabled.
Upon choosing this command, a list of supported language contexts is displayed. To make
IntelliJ IDEA consider a context sensitive to the template, select a check box next to the context name.
The available context types depend on the enabled plugins.
|Copy||Choose this command to create a serialized template XML in the system clipboard. Refer to section Sharing Live Templates.|
|Paste||Choose this command to paste an XML representation of the copied templates to the selected group of templates. Refer to section Sharing Live Templates.|
|Restore defaults||This command only appears on the context menus of the modified templates, marked blue. Choose this command to restore the default template settings.|
Template editing area
The focus is moved to this area in the following cases:
- When you click the Add or Copy button.
- When you select a live template in the list.
- When you select a fragment of code in the editor and choose Tools | Save as Live Template.
Use controls of this area to create new live templates and edit the settings for the existing ones.
You can navigate through the Template Text Area using the hot keys that are marked in the field labels.
|Abbreviation||In this text box, specify the template abbreviation.|
|Description||In this text box, provide optional description of a template or an example of its usage.|
|Template Text||In this text box, type the template body that may contain plain text and variables in the format
When editing the live template variables, mind the following helpful hints:
You cannot edit the predefined live template variables
|Applicable in:||This read-only field shows the languages and/or pieces of code where the editor should be sensitive to the template. Upon pressing Ctrl+J in such context, IntelliJ IDEA displays a list of templates that are valid for this context.|
Click this link to modify the set of contexts where the current template is enabled.
Upon clicking the link, a list of supported language contexts is displayed. To make
IntelliJ IDEA consider a context sensitive to the template, select a check box next to the context
The available context types depend on the enabled plugins.
|Edit Variables||Click this button to open the Edit Template Variables dialog box, where you can define how IntelliJ IDEA should process template variables upon template expansion. Edit Template Variables dialog box contains a complete list of available functions. See the list of predefined functions below on this page.|
|Options||In this area, define the behavior of the editor when a template is expanded.
Predefined functions to be used in live template variables
|Creates a symbol of type with an annotation that resides at the specified location. For an example, see Live Templates in the iterations group.|
|Suggests all array variables applicable in the current scope. For an example, see Live Templates in the iterations group.|
|Suggests a supertype for a Kotlin object expression.|
|Returns the string passed as a parameter, converted to camel case. For example,
|Capitalizes the first letter of the name passed as a parameter.|
|Capitalizes the all letters of a CamelCase name passed as a parameter, and inserts an underscore
between the parts. For example, if the string passed as a parameter is |
|Casts the right-side expression to the left-side expression type. It is used in the iterations group to have a single template for generating both raw-type and Generics Collections.|
|Returns the name of the current class (the class where the template is expanded).|
|This expression substitutes for the class name completion at the variable position.|
|Returns the contents of the system clipboard.|
|Returns CamelCase string out of snake_case string. For example, if the string passed as a parameter is
|This expression substitutes for the code completion invocation at the variable position.|
|This expression substitutes for the smart type completion invocation at the variable position.|
|Returns component type of an array. For example, see the Live Templates in the iterations group in the other group.|
|Returns the current package name.|
Returns the current system date in the specified format.
By default, the current date is returned in the default system format. However, if you specify date format in double quotes, the date will be presented in this format:
|Replaces the first letter of the name passed as a parameter with the corresponding lowercase letter.|
|Shows the children of the class entered as a string parameter.|
|List of comma-delimited strings suggested for completion at the template invocation.|
|Escapes the specified string.|
|Returns the type which is expected as a result of the whole template. Makes sense if the template is expanded in the right part of an assignment, after return, etc.|
|Returns file name with extension.|
|Returns file name without extension.|
|Returns the first word of the string passed as a parameter.|
|Returns Groovy script with the specified code.|
You can use
|Makes a guess on the type of elements stored in a |
|Returns the type of an iterable component, such as an array or a collection.|
|Returns the name of a variable that can be iterated.|
|Returns the current line number.|
|Returns lower case separated by dashes, of the string passed as a parameter. For example, the string
|Returns the name of the embracing method (where the template is expanded).|
|Returns the list of parameters of the embracing method (where the template is expanded).|
|Returns the type of the value returned by the current method (the method within which the template is expanded).|
|Returns the fully qualified name of the current class (the class where the template is expanded).|
|Declares the left-side variable with a type of the right-side expression. It is used in the iterations group to have a single template for generating both raw-type and Generics Collections.|
|Returns snake_case string out of CamelCase string passed as a parameter.|
|Returns string separated with spaces out of CamelCase string passed as a parameter. For example, if the
string passed as a parameter is |
|Returns the subtypes of the type passed as a parameter.|
|Suggests the name of an index variable. Returns |
|Suggests the name for a variable based on the variable type and its initializer expression,
according to your code style settings that refer to the variable naming rules.|
For example, if it is a variable that holds an element within iteration, IntelliJ IDEA makes a guess on the most reasonable names, also taking into account the name of the container being iterated.
|Doesn't suggest |
|Returns the current system time.|
|Returns the type of the variable passed as a parameter.|
|Returns the string passed as a parameter with CamelHump letters substituting for underscores.
For example, if the string passed as a parameter is |
|Returns the string passed as a parameter with spaces substituting for underscores.|
|Returns the name of the current user.|
|Suggests all variables that may be assigned to the type passed as a parameter, for example variableOfType("java.util.Vector"). If you pass an empty string ("") as a parameter, suggests all variables regardless of their types.|
|Returns a suggested name for an index.|
|Returns a suggested name for a variable.|