Package gw.lang.reflect
Interface IPresentationInfo
-
- All Known Implementing Classes:
IPresentationInfo.Default
public interface IPresentationInfo
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
IPresentationInfo.Default
-
Field Summary
Fields Modifier and Type Field Description static FeatureCategory
CATEGORY_BEHAVIOR
static FeatureCategory
CATEGORY_DESIGN
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description FeatureCategory
getCategory()
String
getCharacterMask()
String
getDefaultValue()
boolean
isAutoUpdate()
boolean
isMultiEdit()
boolean
isMultiLine()
boolean
isPresentable()
boolean
isPrimary()
boolean
isRequired()
-
-
-
Field Detail
-
CATEGORY_BEHAVIOR
static final FeatureCategory CATEGORY_BEHAVIOR
-
CATEGORY_DESIGN
static final FeatureCategory CATEGORY_DESIGN
-
-
Method Detail
-
isPresentable
boolean isPresentable()
- Returns:
- True if the this feature can be presented for editing e.g., in a property editor.
-
isRequired
boolean isRequired()
- Returns:
- True if this feature is required, and should be called out as such in a property editor.
-
getCategory
FeatureCategory getCategory()
- Returns:
- The id of the category under which this feature belongs. Feature categories facilitate grouping of features for presentation purposes e.g., in a property editor.
-
isMultiEdit
boolean isMultiEdit()
- Returns:
- True if this feature can be edited in the company of other objects with this feature. For instance, if this is a font it's likely that it's ok to edit this font's value along with other objects that are selected so as to set all their fonts to the same value with one change. Conversely, if this is a value that probably pertains to just this object, say a chunk of Gosu, it's probably best to return true here so that the feature is not editable while other object are selected.
-
isAutoUpdate
boolean isAutoUpdate()
- Returns:
- True if the feature editor for this feature can auto-update while the user modifies the value. For instance, if this feature is a simple label text value, auto-update means that the value changes automatically as the user types. Otherwise, if auto-update is false, the user must explicitly commit the changes when he is finished typing e.g., via an OK button.
-
isPrimary
boolean isPrimary()
- Returns:
- True if this property is considered the primary property for this object, false otherwise. Editors may use this information to implement editing behavior e.g. supporting jumping to the primary property when editing.
-
getCharacterMask
String getCharacterMask()
- Returns:
- A regular expression string specifying which characters are allowed in the value of this property, or null if no such restriction exists.
-
getDefaultValue
String getDefaultValue()
-
isMultiLine
boolean isMultiLine()
-
-