Understanding Categories

An action is always assigned to a category. A category combines the action functions in a semantic unit.

Whenever you implement your own actions, you must also ensure they are assigned to a category When making an assignment, you can either use predefined categories or create your own categories dynamically.

Categories are always arranged hierarchically. The root of all categories is the DEFAULT category.

When you create a new category, it is always based on a predefined category structure.

It is necessary to specify a parent category and a description to be able to identify a specific category. However, you will normally also require additional display information, such as a description of the display, tooltip information, or even an image in the display. Therefore, you can generally distinguish between categories with and without display information.

 

Predefined Categories

All predefined categories are declared as constants in the Category class.

 

 

 

Relevant Category Classes and Interfaces

 

Package com.tssap.util.action

 

ICategory

 

This interface provides semantic units for the functions of an action. Each of these units is uniquely identified by its parent category and a description.

ICategory is not intended for implementation.

 

Methods:

ICategory getParent()

Returns the parent category. The root of all categories is the DEFAULT category.

 

String getDescription()

Returns a description of a category.

 

IDisplayableCategory

 

As well as the interface ICategory, IDisplayableCategory also provides display information such as the name for the display, additional info (tool tip), or an image.

 

 

Category

 

This factory class defines a set of categories and returns a category either of type ICategory or of type IDisplayableCategory.

The following categories are already predefined as constants: DEFAULT, NEW, OPEN, NAVIGATE, EDIT, DELETE, OTHERS, PROPERTIES, CUT, COPY, PASTE.

 

Relevant Methods:

Public static ICategory createCategory(ICategory parent,

                                       String description)

 

Creates a new category of the type Icategory from the parent category and the description.

 

public static IDisplayableCategory createDisplayableCategory(

                                       ICategory parent,

                                       String description,

                                       String displayName,

                                       String displayInfo,

                                       Image displayImage)

 

Creates an as yet undefined category with display information of the type IDisplayableCategory.

As well as the parameters parent and description that identify the category, additional parameters are available for the display information.

The parameter displayName specifies the display name that is to be assigned to the new category.

The parameter displayInfo specifies additional display information (tool tip) that is to be assigned to the new category. You generally do not have to specify this parameter.

The parameter displayImage specifies an image (icon) that is to be assigned to the new category. If no image is required for the display, null is passed.

 

 

 

Relationship Between Relevant Classes and Interfaces