org.eclipse.birt.report.model.api.metadata
Interface IPredefinedStyle


public interface IPredefinedStyle

BIRT defines a fixed set of predefined styles. These style correspond to certain report elements, or element slots. For example, there is a style for chart, for list headers, for table footers and so on.

The set of predefined styles is part of the element design and is fixed by the development team. Fixed properties of predefined styles includes the internal name and display name. However, the property values for the style are set in a design or template and are part of the design itself.

This class represents the invariant part of the predefined styles. It is used to create a style element within a new design.

Note that predefined styles are identified with an internal name of element name, slot name or their combination. For example, to select a list, use the "list" style. To select a list header, use the "list-header" style. Styles also have a display name id which is used to get localized display name, but the internal name remains fixed across all locales. This ensures that a design created in one locale can be used in another.


Method Summary
 java.lang.String getDisplayNameKey()
          Returns the message ID for the display name.
 java.lang.String getName()
          Gets the internal style name.
 java.lang.String getType()
           
 

Method Detail

getDisplayNameKey

java.lang.String getDisplayNameKey()
Returns the message ID for the display name.

Returns:
the display name message ID

getName

java.lang.String getName()
Gets the internal style name.

Returns:
the name

getType

java.lang.String getType()
Returns:


Copyright © 2008 Actuate Corp. All rights reserved.