com.sun.rave.designtime
Interface Constants.BeanDescriptor

Enclosing interface:

Constants

public static interface Constants.BeanDescriptor

These constants are used as attribute keys for the BeanDescriptor. Use the 'setValue' method on the BeanDescriptor to set these values, and the 'getValue' method to retrieve them.

See Also:

FeatureDescriptor.setValue(String, Object), FeatureDescriptor.getValue(String)

Field Summary

static java.lang.String	ALLOWED_CHILD_TYPES This String[] attribute defines the set of allowed childrens' class names.
static java.lang.String	CLEANUP_METHOD This String attribute defines a method on the component that should be called when the host is cleaning up to allow this bean to cleanup resources, etc.
static java.lang.String	DISALLOWED_CHILD_TYPES This String[] attribute defines the set of dis-allowed childrens' class names.
static java.lang.String	FACET_DESCRIPTORS This attribute (of type FacetDescriptor[]) defines the facets that this JSF component surfaces.
static java.lang.String	HELP_KEY This String attribute defines the help key that resolves to the appropriate help contents for this component.
static java.lang.String	INSTANCE_NAME This String attribute defines the base instance name to use for new components of this type.
static java.lang.String	IS_CONTAINER This Boolean attribute defines whether this component should be treated as a container in the designer or not.
static java.lang.String	MARKUP_SECTION This String attribute defines the section of markup that a particular component has an 'affinity' for - meaning what part of the document does it need to be parented by.
static java.lang.String	PROPERTIES_HELP_KEY This String attribute defines the help key that resolves to the appropriate help contents for this component.
static java.lang.String	PROPERTY_CATEGORIES This attribute (of type CategoryDescriptor[]) defines the set of property categories that this component's property set should be organized in.
static java.lang.String	REQUIRED_PARENT_TYPES This String[] attribute defines the set of valid parents' class names.
static java.lang.String	RESIZE_CONSTRAINTS This attribute (of type Integer) defines the bitmask of constraints (from ResizeConstraints interface) that dictates how a user can resize this component
static java.lang.String	TAG_NAME This String attribute defines which JSP tag represents this component in the markup.
static java.lang.String	TAGLIB_PREFIX This String attribute defines the suggested JSP taglib prefix (if not already added to the JSP file)
static java.lang.String	TAGLIB_URI This String attribute defines which JSP taglib contains this component.
static java.lang.String	TEXT_NODE_PROPERTY This String attribute specifies a particular property name on a component that controls the contents of a Faces component's rendered text node.
static java.lang.String	TRAY_COMPONENT This Boolean attribute (Boolean.TRUE or Boolean.FALSE) defines wether this component should be shown in the tray.

Field Detail

ALLOWED_CHILD_TYPES

public static final java.lang.String ALLOWED_CHILD_TYPES

This String[] attribute defines the set of allowed childrens' class names. This restricts what children may be added to this bean. Class.isAssignableFrom(...) will be used to determine if a specific type matches an item in this list. If there is a match, the child bean will be allowed to be added as a child to this bean. If this is not set, any child is allowed (assuming this bean is a container). This attribute works in conjuction with the DISALLOWED_CHILD_TYPES attribute (expanding and contracting the list of possible children), as well as with the REQUIRED_PARENT_TYPES attribute on the bean being created.

See Also:

Constant Field Values

CLEANUP_METHOD

public static final java.lang.String CLEANUP_METHOD

This String attribute defines a method on the component that should be called when the host is cleaning up to allow this bean to cleanup resources, etc. This method should be called at both design-time and runtime, and must have zero arguments.

See Also:

Constant Field Values

DISALLOWED_CHILD_TYPES

public static final java.lang.String DISALLOWED_CHILD_TYPES

This String[] attribute defines the set of dis-allowed childrens' class names. This restricts what children may be added to this bean. Class.isAssignableFrom(...) will be used to determine if a specific type matches an item in this list. If there is a match, the child bean will not be allowed to be added as a child to this bean. If this is not set, any child is allowed (assuming this bean is a container). This attribute works in conjuction with the ALLOWED_CHILD_TYPES attribute (expanding and contracting the list of possible children), as well as with the REQUIRED_PARENT_TYPES attribute on the bean being created.

See Also:

Constant Field Values

FACET_DESCRIPTORS

public static final java.lang.String FACET_DESCRIPTORS

This attribute (of type FacetDescriptor[]) defines the facets that this JSF component surfaces.

See Also:

FacetDescriptor, Constant Field Values

HELP_KEY

public static final java.lang.String HELP_KEY

This String attribute defines the help key that resolves to the appropriate help contents for this component. This will be shown when the user presses F1 when a component is selected on the palette - or if a dynamic help window is showing.

See Also:

Constant Field Values

INSTANCE_NAME

public static final java.lang.String INSTANCE_NAME

This String attribute defines the base instance name to use for new components of this type. This base instance name will be auto-numbered for subsequent instances of the component on the form. For example, HtmlCommandButton defines "button" in it's instanceName attribute, so the first HtmlCommandButton dropped on a form is called "button1", and the second "button2", etc. If no instanceName is defined, the class name will be used (with the initial letter lower-cased), like "htmlCommandButton1".

See Also:

Constant Field Values

IS_CONTAINER

public static final java.lang.String IS_CONTAINER

This Boolean attribute defines whether this component should be treated as a container in the designer or not. If not defined, all JSF components are treated as containers, because the UIComponent base-class has parent/child symantics. The HtmlCommandButton, for example, defines this attribute to Boolean.FALSE so that the designer does not show it as a component that can have children.

See Also:

Constant Field Values

MARKUP_SECTION

public static final java.lang.String MARKUP_SECTION

This String attribute defines the section of markup that a particular component has an 'affinity' for - meaning what part of the document does it need to be parented by. For example, the Stylesheet component defines it's markupSection as "head", to get rendered into the head section of the document. "body" and/or "form" is assumed if nothing is set.

See Also:

Constant Field Values

PROPERTIES_HELP_KEY

public static final java.lang.String PROPERTIES_HELP_KEY

This String attribute defines the help key that resolves to the appropriate help contents for this component. This will be shown when the user presses F1 when a component is selected on the palette - or if a dynamic help window is showing.

See Also:

Constant Field Values

PROPERTY_CATEGORIES

public static final java.lang.String PROPERTY_CATEGORIES

This attribute (of type CategoryDescriptor[]) defines the set of property categories that this component's property set should be organized in. This is used to control the display order of the categories, as individual PropertyDescriptor classes will define which category a property belongs in.

See Also:

CategoryDescriptor, Constant Field Values

REQUIRED_PARENT_TYPES

public static final java.lang.String REQUIRED_PARENT_TYPES

This String[] attribute defines the set of valid parents' class names. This restricts which beans this component may be added to. Class.isAssignableFrom(...) will be used to determine if a specific type matches an item in this list. If there is a match, the bean will be allowed to be added as a child of the parent bean. If this attribute is not set, no restrictions are set on required parent types. This attribute works in conjuction with the ALLOWED_CHILD_TYPES and DISALLOWED_CHILD_TYPES attributes on the parent bean in question.

See Also:

Constant Field Values

RESIZE_CONSTRAINTS

public static final java.lang.String RESIZE_CONSTRAINTS

This attribute (of type Integer) defines the bitmask of constraints (from ResizeConstraints interface) that dictates how a user can resize this component

See Also:

Constants.ResizeConstraints, Constant Field Values

TAG_NAME

public static final java.lang.String TAG_NAME

This String attribute defines which JSP tag represents this component in the markup. For example HtmlCommandButton defines "command_button" in it's tagName attribute. If no tagName is defined, the component is assumed to be a non-visual, and will not be diplayed on the visual design surface.

See Also:

Constant Field Values

TAGLIB_PREFIX

public static final java.lang.String TAGLIB_PREFIX

This String attribute defines the suggested JSP taglib prefix (if not already added to the JSP file)

See Also:

Constant Field Values

TAGLIB_URI

public static final java.lang.String TAGLIB_URI

This String attribute defines which JSP taglib contains this component.

See Also:

Constant Field Values

TEXT_NODE_PROPERTY

public static final java.lang.String TEXT_NODE_PROPERTY

This String attribute specifies a particular property name on a component that controls the contents of a Faces component's rendered text node. This allows in-place editing of flow text on a component displayed in the designer.

See Also:

Constant Field Values

TRAY_COMPONENT

public static final java.lang.String TRAY_COMPONENT

This Boolean attribute (Boolean.TRUE or Boolean.FALSE) defines wether this component should be shown in the tray. The default setting is Boolean.FALSE for BeanDescriptors that do not include this attribute. Typically, this is only used for database-related components, and the occasional non-painting visual component like HtmlInputHidden.

See Also:

Constant Field Values