Oculus Layout Builder Plugin API Documentation
November 25, 2002
A C D F G H I L P S

A

AbstractComponentMetaInfo - class com.oculustech.layoutbuilder.pluginapi.AbstractComponentMetaInfo.
Abstract implementation of ComponentMetaInfo.
AbstractComponentMetaInfo() - Constructor for class com.oculustech.layoutbuilder.pluginapi.AbstractComponentMetaInfo
 

C

canInlineConstruction() - Method in class com.oculustech.layoutbuilder.pluginapi.AbstractComponentMetaInfo
Return true iif it is OK to inline the construction of this component in the add() call.
canInlineConstruction() - Method in interface com.oculustech.layoutbuilder.pluginapi.ComponentMetaInfo
Return true iif it is OK to inline the construction of this component in the add() call.
CK_CHECK_BOX - Static variable in class com.oculustech.layoutbuilder.pluginapi.FieldInfo
Control kind constant.
CK_COLOR_DROPDOWN - Static variable in class com.oculustech.layoutbuilder.pluginapi.FieldInfo
Control kind constant.
CK_DROPDOWN - Static variable in class com.oculustech.layoutbuilder.pluginapi.FieldInfo
Control kind constant.
CK_EDITOR_PANE - Static variable in class com.oculustech.layoutbuilder.pluginapi.FieldInfo
Control kind constant.
CK_FONT_CHOOSER - Static variable in class com.oculustech.layoutbuilder.pluginapi.FieldInfo
Control kind constant.
CK_RADIO - Static variable in class com.oculustech.layoutbuilder.pluginapi.FieldInfo
Control kind constant.
CK_STRING_LIST_EDIT - Static variable in class com.oculustech.layoutbuilder.pluginapi.FieldInfo
Control kind constant.
CK_TEXT_FIELD - Static variable in class com.oculustech.layoutbuilder.pluginapi.FieldInfo
Control kind constant.
CO_FORMAT - Static variable in class com.oculustech.layoutbuilder.pluginapi.FieldInfo
Control Option Map key.
CO_OPTION_LABELS - Static variable in class com.oculustech.layoutbuilder.pluginapi.FieldInfo
Control Option Map key.
CO_OPTION_VALUES - Static variable in class com.oculustech.layoutbuilder.pluginapi.FieldInfo
Control Option Map key.
CO_TOOLTIP - Static variable in class com.oculustech.layoutbuilder.pluginapi.FieldInfo
Control Option Map key.
com.oculustech.layoutbuilder.pluginapi - package com.oculustech.layoutbuilder.pluginapi
 
componentClass - Variable in class com.oculustech.layoutbuilder.pluginapi.DefaultComponentKind
 
ComponentFactory - interface com.oculustech.layoutbuilder.pluginapi.ComponentFactory.
An instance of this interface provides the means by which components can be created in the builder environment.
ComponentKind - class com.oculustech.layoutbuilder.pluginapi.ComponentKind.
An instance of this structure class contains the information necessary for the builder shell to know about the availability of a component, how to represent it in the palette, and how to construct it from its factory.
ComponentKind(String, String, String, Icon) - Constructor for class com.oculustech.layoutbuilder.pluginapi.ComponentKind
 
ComponentMetaInfo - interface com.oculustech.layoutbuilder.pluginapi.ComponentMetaInfo.
An instance of this interface provides the meta-interface necessary for the builder to interact with a given component.
controlKind - Variable in class com.oculustech.layoutbuilder.pluginapi.FieldInfo
 
controlProperties - Variable in class com.oculustech.layoutbuilder.pluginapi.FieldInfo
 
createComponent() - Method in class com.oculustech.layoutbuilder.pluginapi.ComponentKind
Create an instance of this component kind with the default data model.
createComponent() - Method in class com.oculustech.layoutbuilder.pluginapi.DefaultComponentKind
 

D

DefaultComponentKind - class com.oculustech.layoutbuilder.pluginapi.DefaultComponentKind.
This simple extension of ComponentKind takes the Component class as a parameter, and provides an implementation of the createComponent() methods that simply instantiate the given class with the default constructor.
DefaultComponentKind(Class, String, String, String, Icon) - Constructor for class com.oculustech.layoutbuilder.pluginapi.DefaultComponentKind
 
DefaultComponentKind(Class, String, String, String, Icon, Class) - Constructor for class com.oculustech.layoutbuilder.pluginapi.DefaultComponentKind
 
defaultDataModelClass - Variable in class com.oculustech.layoutbuilder.pluginapi.DefaultComponentKind
 
defaultInspectorFieldsToExclude() - Method in class com.oculustech.layoutbuilder.pluginapi.AbstractComponentMetaInfo
Returns the set of fields that should be excluded when fields are automatically generated by reflection.
defaultInspectorFieldsToExclude() - Method in interface com.oculustech.layoutbuilder.pluginapi.ComponentMetaInfo
Returns the set of fields that should be excluded when fields are automatically generated by reflection.
doIncludeDefaultInspectorFields() - Method in class com.oculustech.layoutbuilder.pluginapi.AbstractComponentMetaInfo
If this returns true, the system will automatically generate fields in the inspector by reflecting on the component's class.
doIncludeDefaultInspectorFields() - Method in interface com.oculustech.layoutbuilder.pluginapi.ComponentMetaInfo
If this returns true, the system will automatically generate fields in the inspector by reflecting on the component's class.

F

FieldInfo - class com.oculustech.layoutbuilder.pluginapi.FieldInfo.
An instance of this class represents the meta-information of a field associated with a component.
FieldInfo() - Constructor for class com.oculustech.layoutbuilder.pluginapi.FieldInfo
 
fieldName - Variable in class com.oculustech.layoutbuilder.pluginapi.FieldInfo
 

G

generateCode(String, boolean, boolean) - Method in class com.oculustech.layoutbuilder.pluginapi.AbstractComponentMetaInfo
Generate code for this component.
generateCode(String, boolean, boolean) - Method in interface com.oculustech.layoutbuilder.pluginapi.ComponentMetaInfo
Generate code for this component.
generateDeclaration(String) - Method in class com.oculustech.layoutbuilder.pluginapi.AbstractComponentMetaInfo
This should generate a class declaration for this component.
generateDeclaration(String) - Method in interface com.oculustech.layoutbuilder.pluginapi.ComponentMetaInfo
This should generate a class declaration for this component.
getCategoryName() - Method in class com.oculustech.layoutbuilder.pluginapi.ComponentKind
Returns the name of the category in which to put this component in the palette
getComponent() - Method in interface com.oculustech.layoutbuilder.pluginapi.ComponentMetaInfo
Return the component corresponding to this metainfo instance.
getComponentClass() - Method in class com.oculustech.layoutbuilder.pluginapi.AbstractComponentMetaInfo
Returns class of object returned by getComponent().
getComponentKinds() - Method in interface com.oculustech.layoutbuilder.pluginapi.ComponentFactory
Return information on the various components/configurations supported from this factory.
getControlKind() - Method in class com.oculustech.layoutbuilder.pluginapi.FieldInfo
Return the kind of control to use for this field.
getControlProperties() - Method in class com.oculustech.layoutbuilder.pluginapi.FieldInfo
Return the properties map for this field.
getDeclarationType() - Method in class com.oculustech.layoutbuilder.pluginapi.AbstractComponentMetaInfo
Returns the class name to use in the generated code (getComponentClass().getName() with package adjusted to be more user friendly).
getDescription() - Method in class com.oculustech.layoutbuilder.pluginapi.ComponentKind
Returns a brief description of this component.
getFactoryName() - Method in class com.oculustech.layoutbuilder.pluginapi.ComponentKind
Returns the fully-qualified class name of the factory corresponding to this component-kind
getFieldInfo(ComponentMetaInfo, String) - Static method in class com.oculustech.layoutbuilder.pluginapi.AbstractComponentMetaInfo
Returns the FieldInfo for the field of the given name within cmi.
getFieldInfo(String) - Method in class com.oculustech.layoutbuilder.pluginapi.AbstractComponentMetaInfo
Gets the FieldInfo for the field of the given name.
getFieldName() - Method in class com.oculustech.layoutbuilder.pluginapi.FieldInfo
Return the logical name of this field.
getFields() - Method in interface com.oculustech.layoutbuilder.pluginapi.ComponentMetaInfo
Return information on the fields that should be presented in the inspector for this component type.
getHumanReadableName() - Method in class com.oculustech.layoutbuilder.pluginapi.ComponentKind
Returns the human-readable name of this component.
getIsXMLAttributeCompatible() - Method in class com.oculustech.layoutbuilder.pluginapi.FieldInfo
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
getJavaCodeValue() - Method in class com.oculustech.layoutbuilder.pluginapi.FieldInfo
Get the literal to be used in the generated Java code to represent the value of this field.
getJavaCodeValue(String) - Static method in class com.oculustech.layoutbuilder.pluginapi.FieldInfo
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.
getJavaCodeValueForColor(Color) - Static method in class com.oculustech.layoutbuilder.pluginapi.FieldInfo
Returns a String representing the code value of the argument c.
getJavaIdentifierValue(String) - Static method in class com.oculustech.layoutbuilder.pluginapi.FieldInfo
Returns the given string with characters not allowed in Java identifiers (variable names) replaced with underscores.
getKindName() - Method in class com.oculustech.layoutbuilder.pluginapi.ComponentKind
Returns the name of this component kind.
getLabel() - Method in class com.oculustech.layoutbuilder.pluginapi.FieldInfo
Return the label for this field in the inspector
getMethodOfNameArity(Class, String, int) - Static method in class com.oculustech.layoutbuilder.pluginapi.DefaultComponentKind
 
getPageName() - Method in class com.oculustech.layoutbuilder.pluginapi.FieldInfo
Return the name of the page (tab) onto which to place this field
getPaletteIcon() - Method in class com.oculustech.layoutbuilder.pluginapi.ComponentKind
Returns the icon to use for this component in the palette.
getSectionName() - Method in class com.oculustech.layoutbuilder.pluginapi.FieldInfo
Return the name of the section within the page into which to place this field.
getSortKey() - Method in class com.oculustech.layoutbuilder.pluginapi.FieldInfo
Returns the sort key that determines the order in which this component appears within its section.
getStringifiedValue() - Method in class com.oculustech.layoutbuilder.pluginapi.FieldInfo
Get the value as a string such that it can be set with setValueFromString().
getValue() - Method in class com.oculustech.layoutbuilder.pluginapi.FieldInfo
Get the value of this field
getValueTypeClass() - Method in class com.oculustech.layoutbuilder.pluginapi.FieldInfo
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.

H

hasTextConstructor(Class) - Static method in class com.oculustech.layoutbuilder.pluginapi.AbstractComponentMetaInfo
Returns true if given class has a constructor taking one argument of type String.

I

isDefaultValue() - Method in class com.oculustech.layoutbuilder.pluginapi.FieldInfo
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)
isXMLAttributeCompatible - Variable in class com.oculustech.layoutbuilder.pluginapi.FieldInfo
 

L

label - Variable in class com.oculustech.layoutbuilder.pluginapi.FieldInfo
 

P

pageName - Variable in class com.oculustech.layoutbuilder.pluginapi.FieldInfo
 

S

sectionName - Variable in class com.oculustech.layoutbuilder.pluginapi.FieldInfo
 
setValue(Object) - Method in class com.oculustech.layoutbuilder.pluginapi.FieldInfo
Set the value of this field
setValueFromString(String) - Method in class com.oculustech.layoutbuilder.pluginapi.FieldInfo
Set the value of this field from a stringified form returned by getStringifiedValue()
sortKey - Variable in class com.oculustech.layoutbuilder.pluginapi.FieldInfo
 

A C D F G H I L P S
Oculus Layout Builder Plugin API Documentation
November 25, 2002

Copyright 2002 Oculus Technologies Corporation. 103 Broad Street, 6th Floor,
Boston, Massachusetts, 02110, U.S.A. All Rights Reserved.