|
Oculus Layout Builder Plugin API Documentation November 25, 2002 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.oculustech.layoutbuilder.pluginapi.FieldInfo
An instance of this class represents the meta-information of a field associated with a component. It determines how that field appears in the inspector, and gives the information via which the field may be stringified and unstringified when being saved out or restored.
Field Summary | |
static java.lang.String |
CK_CHECK_BOX
Control kind constant. |
static java.lang.String |
CK_COLOR_DROPDOWN
Control kind constant. |
static java.lang.String |
CK_DROPDOWN
Control kind constant. |
static java.lang.String |
CK_EDITOR_PANE
Control kind constant. |
static java.lang.String |
CK_FONT_CHOOSER
Control kind constant. |
static java.lang.String |
CK_RADIO
Control kind constant. |
static java.lang.String |
CK_STRING_LIST_EDIT
Control kind constant. |
static java.lang.String |
CK_TEXT_FIELD
Control kind constant. |
static java.lang.String |
CO_FORMAT
Control Option Map key. |
static java.lang.String |
CO_OPTION_LABELS
Control Option Map key. |
static java.lang.String |
CO_OPTION_VALUES
Control Option Map key. |
static java.lang.String |
CO_TOOLTIP
Control Option Map key. |
protected java.lang.String |
controlKind
|
protected java.util.Map |
controlProperties
|
protected java.lang.String |
fieldName
|
protected boolean |
isXMLAttributeCompatible
|
protected java.lang.String |
label
|
protected java.lang.String |
pageName
|
protected java.lang.String |
sectionName
|
protected java.lang.String |
sortKey
|
Constructor Summary | |
protected |
FieldInfo()
|
Method Summary | |
java.lang.String |
getControlKind()
Return the kind of control to use for this field. |
java.util.Map |
getControlProperties()
Return the properties map for this field. |
java.lang.String |
getFieldName()
Return the logical name of this field. |
boolean |
getIsXMLAttributeCompatible()
Returns true if this field's value is suitable for encoding as an XML tag attribute, or false if this value should be stored as the textual data of the tag |
java.lang.String |
getJavaCodeValue()
Get the literal to be used in the generated Java code to represent the value of this field. |
static java.lang.String |
getJavaCodeValue(java.lang.String stringLiteral)
Returns the given string wrapped in double-quotes, with all backslashes, double-quotes, and newlines it contains escaped out, making it an appropriate java string literal. |
static java.lang.String |
getJavaCodeValueForColor(java.awt.Color c)
Returns a String representing the code value of the argument c. |
static java.lang.String |
getJavaIdentifierValue(java.lang.String stringLiteral)
Returns the given string with characters not allowed in Java identifiers (variable names) replaced with underscores. |
java.lang.String |
getLabel()
Return the label for this field in the inspector |
java.lang.String |
getPageName()
Return the name of the page (tab) onto which to place this field |
java.lang.String |
getSectionName()
Return the name of the section within the page into which to place this field. |
java.lang.String |
getSortKey()
Returns the sort key that determines the order in which this component appears within its section. |
abstract java.lang.String |
getStringifiedValue()
Get the value as a string such that it can be set with setValueFromString(). |
abstract java.lang.Object |
getValue()
Get the value of this field |
abstract java.lang.Class |
getValueTypeClass()
Get the Class representing the type of value of this field (i.e., all possible return values of getValue() must be an instance of this class or one of its subclasses. |
abstract boolean |
isDefaultValue()
Returns true iff the value of this field is the default value that would automatically be assumed for a new instance of this component (and hence doesn't have to be explicitly set in the generated code) |
abstract void |
setValue(java.lang.Object v)
Set the value of this field |
abstract void |
setValueFromString(java.lang.String v)
Set the value of this field from a stringified form returned by getStringifiedValue() |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String CK_TEXT_FIELD
public static final java.lang.String CK_FONT_CHOOSER
public static final java.lang.String CK_COLOR_DROPDOWN
public static final java.lang.String CK_EDITOR_PANE
public static final java.lang.String CK_CHECK_BOX
public static final java.lang.String CK_DROPDOWN
public static final java.lang.String CK_RADIO
public static final java.lang.String CK_STRING_LIST_EDIT
public static final java.lang.String CO_OPTION_LABELS
public static final java.lang.String CO_OPTION_VALUES
public static final java.lang.String CO_TOOLTIP
public static final java.lang.String CO_FORMAT
protected java.lang.String fieldName
protected java.lang.String label
protected java.lang.String controlKind
protected java.util.Map controlProperties
protected java.lang.String pageName
protected java.lang.String sectionName
protected java.lang.String sortKey
protected boolean isXMLAttributeCompatible
Constructor Detail |
protected FieldInfo()
Method Detail |
public java.lang.String getFieldName()
public java.lang.String getLabel()
public java.lang.String getControlKind()
public java.util.Map getControlProperties()
public java.lang.String getPageName()
public java.lang.String getSectionName()
public java.lang.String getSortKey()
public boolean getIsXMLAttributeCompatible()
public abstract java.lang.Object getValue()
public abstract void setValue(java.lang.Object v)
public abstract java.lang.String getStringifiedValue()
public static java.lang.String getJavaCodeValue(java.lang.String stringLiteral)
public static java.lang.String getJavaIdentifierValue(java.lang.String stringLiteral)
public java.lang.String getJavaCodeValue()
Default implementation handles primitive types, Colors, Fonts and Strings. It is assumed that Number, Boolean and Character instances can be rendered as their primitive type (int, double, etc.) rather than their object type.
public static java.lang.String getJavaCodeValueForColor(java.awt.Color c)
public abstract void setValueFromString(java.lang.String v)
public abstract java.lang.Class getValueTypeClass()
public abstract boolean isDefaultValue()
|
Oculus Layout Builder Plugin API Documentation November 25, 2002 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |