| java.lang.Object
 com.sun.rave.propertyeditors.domains.Domain
All known Subclasses: com.sun.rave.propertyeditors.domains.LanguagesDomain, org.netbeans.modules.visualweb.web.ui.dt.component.propertyeditors.AlertTypesDomain, org.netbeans.modules.visualweb.web.ui.dt.component.propertyeditors.LabelLevelsDomain, org.netbeans.modules.visualweb.faces.dt_1_2.component.html.HtmlCommandButtonTypesDomain, com.sun.rave.propertyeditors.domains.LayoutDomain, com.sun.rave.propertyeditors.domains.HtmlVerticalAlignDomain, com.sun.rave.propertyeditors.domains.HtmlAlignDomain, com.sun.rave.propertyeditors.domains.HtmlTableRulesDomain, org.netbeans.modules.visualweb.web.ui.dt.component.propertyeditors.PageAlertTypesDomain, org.netbeans.modules.visualweb.faces.dt_1_2.component.html.HtmlMessagesLayoutStylesDomain, com.sun.rave.propertyeditors.domains.TextDirectionDomain, org.netbeans.modules.visualweb.faces.dt_1_2.component.html.HtmlCheckboxLayoutStylesDomain, org.netbeans.modules.visualweb.web.ui.dt.component.propertyeditors.SortFieldDomain, com.sun.rave.propertyeditors.domains.TimeZonesDomain, com.sun.rave.propertyeditors.domains.AttachedDomain, org.netbeans.modules.visualweb.faces.dt.converter.DateTimeStylesDomain, com.sun.rave.propertyeditors.domains.HtmlHorizontalAlignDomain, com.sun.rave.propertyeditors.domains.LocalesDomain, org.netbeans.modules.visualweb.faces.dt_1_1.component.html.HtmlCheckboxLayoutStylesDomain, org.netbeans.modules.visualweb.faces.dt_1_1.component.html.HtmlCommandButtonTypesDomain, org.netbeans.modules.visualweb.faces.dt.converter.DateTimeTypesDomain, com.sun.rave.propertyeditors.domains.HtmlLinkTypesDomain, com.sun.rave.propertyeditors.domains.HtmlTableBordersDomain, org.netbeans.modules.visualweb.web.ui.dt.component.propertyeditors.FileTypesDomain, com.sun.rave.propertyeditors.domains.HtmlRegionShapesDomain,
| Domain | | abstract public class Domain (Code) | | Abstract representation of a set of binary tuples that represents
the domain of values for a particular property. Domain elements are
represented by instances of class
Element . Concrete subclasses of
this class may provide a static list of items, or calculate the list
dynamically based on the current state of the associated components. If the
number of elements in a domain is large, it is recommended that the elements
be returned in sorted order, according to the natural ordering of the element
labels.
A
Domain implementation that needs access to the dynamic
context should extend
AttachedDomain instead of this class.
EditableDomain should be used to represent domains which users may
modify by the addition or removal or modification of elements.
Nota Bena: No check is made for duplicate elements.
|
| Field Summary | |
| final static Bundle | bundle
The localizing Bundle for this package. |
| Method Summary | |
| public String | getDisplayName()
Returns the display name of the element type that this domain represents.
This name may be used in messages, labels, and window titles. | | public Element | getElementAt(int index)
Returns the element at the index indicated, or null if there is no element
at the index indicated, or if the index is out of bounds. | | abstract public Element[] | getElements()
Returns an array of
Element s that represent the legal values
to which our associated property may be set. | | public int | getIndexOf(Element element)
Returns the index of the element indicated, of -1 if the element does
not exist in this domain. | | public String | getPropertyHelpId()
Returns the unique property help id that maps to the help topic for this
property editor. | | public int | getSize()
Returns the number of elements in the domain. | | public boolean | isRequired()
Returns true if this domain corresponds to a required property. |
| bundle | | final static Bundle bundle(Code) | | The localizing Bundle for this package. Classes in other
packages that extend Domain must provide their own
localization solution.
|
| getDisplayName | | public String getDisplayName()(Code) | | Returns the display name of the element type that this domain represents.
This name may be used in messages, labels, and window titles. By default,
returns null. If null is returned, editors will generally use the property's
display name.
|
| getElementAt | | public Element getElementAt(int index)(Code) | | Returns the element at the index indicated, or null if there is no element
at the index indicated, or if the index is out of bounds.
|
| getElements | | abstract public Element[] getElements()(Code) | | Returns an array of
Element s that represent the legal values
to which our associated property may be set. If there are no such
legal values, a zero-length array is returned. This method must never
return null.
The returned
Element s should be in the order most natural
for presentation to a user in a property editor.
|
| getIndexOf | | public int getIndexOf(Element element)(Code) | | Returns the index of the element indicated, of -1 if the element does
not exist in this domain. If an element is present more than once, the
index of the first one encountered is returned.
|
| getPropertyHelpId | | public String getPropertyHelpId()(Code) | | Returns the unique property help id that maps to the help topic for this
property editor. By default, returns null. Extending classes that provide
help should override this method.
|
| getSize | | public int getSize()(Code) | | Returns the number of elements in the domain.
|
| isRequired | | public boolean isRequired()(Code) | | Returns true if this domain corresponds to a required property. A
required property is one for which a "null" or "empty" value is not valid.
If this method returns false, property editors must make a "null" or
"unset" option available. By default, this method returns false.
|
|
|