@jcs:suppress-common-tags Annotation

The @jcs:suppress-common-tags annotation provides a means to suppress certain annotations in a custom control implementation (JCS file). The annotations that may be suppressed are @common:define, @common:schema, @common:target-namespace, and @common:xmlns. You can use the @jcs:suppress-common-tags annotation to suppress these annotations if they are not appropriate for the control you are building. The annotations which are suppressed are subsequently not available to JCX controls which extend the custom control: the suppressed annotations do not appear in the Property Editor for the control in Design View; and in Source View, adding a suppressed annotation will generate a compile-time error.

Syntax

@jcs:suppress-common-tags

tags="annotationList"

 

Attributes

tags

Optional. Specifies the list of @common annotations, separated by spaces, that should be suppressed for this control. Note that you do not need to include the @common prefix, only the annotation name.

Remarks

The following @common annotations appear by default on a custom control, but can be suppressed using the @jcs:suppress-common-tags annotation:

The following fragment shows how to use the @jcs:suppress-common-tags annotation to suppress the @common:define, @common:schema, @common:target-namespace, and @common:xmlns annotations:

/**
* @jcs:suppress-common-tags tags="define schema target-namespace xmlns"
*/

Related Topics

Tutorial: Java Control

Building Custom Java Controls