Oculus Layout Builder Plugin API Documentation
November 25, 2002

com.oculustech.layoutbuilder.pluginapi
Class ComponentKind

java.lang.Object
  |
  +--com.oculustech.layoutbuilder.pluginapi.ComponentKind
Direct Known Subclasses:
DefaultComponentKind

public abstract class ComponentKind
extends java.lang.Object

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.


Constructor Summary
ComponentKind(java.lang.String kindName, java.lang.String humanReadableName, java.lang.String description, javax.swing.Icon paletteIcon)
           
 
Method Summary
abstract  java.lang.Object createComponent()
          Create an instance of this component kind with the default data model.
 java.lang.String getCategoryName()
          Returns the name of the category in which to put this component in the palette
 java.lang.String getDescription()
          Returns a brief description of this component.
 java.lang.String getFactoryName()
          Returns the fully-qualified class name of the factory corresponding to this component-kind
 java.lang.String getHumanReadableName()
          Returns the human-readable name of this component.
 java.lang.String getKindName()
          Returns the name of this component kind.
 javax.swing.Icon getPaletteIcon()
          Returns the icon to use for this component in the palette.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ComponentKind

public ComponentKind(java.lang.String kindName,
                     java.lang.String humanReadableName,
                     java.lang.String description,
                     javax.swing.Icon paletteIcon)
Method Detail

getFactoryName

public java.lang.String getFactoryName()
Returns the fully-qualified class name of the factory corresponding to this component-kind

getKindName

public java.lang.String getKindName()
Returns the name of this component kind. This must be globally unique, so should be qualified a la package-names, etc. Will often be the same as the class name of the component (javax.swing.JButton), but may not always be, as sometimes one will want the same class to appear in the palette multiple times, each representing a different configuration of the underlying class.

getHumanReadableName

public java.lang.String getHumanReadableName()
Returns the human-readable name of this component.

getDescription

public java.lang.String getDescription()
Returns a brief description of this component.

getCategoryName

public java.lang.String getCategoryName()
Returns the name of the category in which to put this component in the palette

getPaletteIcon

public javax.swing.Icon getPaletteIcon()
Returns the icon to use for this component in the palette.

createComponent

public abstract java.lang.Object createComponent()
Create an instance of this component kind with the default data model. May either return a subclass of java.awt.Component, or else an instance of ComponentMetaInfo, via which it can have more control over configuration, etc.

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.