Configuration Parts
A configuration file contains the declarations of configuration parts as detailed below. Each of these part names is a keyword in the definition language and its name begins with a capital letter.
Every instance of a configuration part is given a unique name immediately following the part name keyword; the format of the name must follow the same form as a Java method name: starting with a lower case character, no spaces etc. The configuration file editor checks this.
FieldOrMethodDisplayStyle and TypeDisplayStyle describe HOW to display a Java element.
TypeSelector, MethodSelector and FieldSelector describe WHICH Java elements to include or exclude.
DiagramStyle binds selectors (which elements to display) to styles (how to display them).
PatternSwitch and OptionSwitch (note that the word switch is used here in a sense loosely equivalent to a command line switch) are parameters passed to a DiagramStyle.
Part Name (keyword) |
Description |
FieldOrMethodDisplayStyle |
Details of how to display a field or a method using Colors and TextStyles |
TypeDisplayStyle |
Details of how to display a type using Colors and TextStyles |
FieldSelector |
Used to differentiate between fields based on its criteria. Includes or excludes any given field. |
MethodSelector |
Used to differentiate between methods (methods and constructors) based on its criteria. Includes or excludes any given method. |
TypeSelector |
Used to differentiate between types (ie classes, interfaces and enums) based on its criteria. Includes or excludes any given type. |
DiagramStyle |
Used to control the presentation of the Java elements on a diagram by binding selectors to display styles. |
PatternSwitch |
A string pattern used to parameterize a TypeSelector, MethodSelector, FieldSelector or DiagramStyle. |
OptionsSwitch |
A choice from a set of options used to control a TypeSelector, MethodSelector, FieldSelector or DiagramStyle. |
BatchContentDirector |
Used to control the population and presentation of class dia |
Orange - display styles
Purple - selectors
Red - DiagramStyle
Gray - switches
Green BatchContentDirector
|