Using the JavaBeans in guicomponents.jar

The following table presents the JavaBeans included inguicomponents.jar:

AddAndLinkButton This button launches a property editor that adds a new item to the repository and automatically links the new item to the item currently displayed by the form in which this button resides. Add this button within the scope of a PropogatingPanel and set the itemType and locatorKey properties to the name of the item type and the name of the form to use, respectively. Optionally, set the addToSameFolder property (which defaults to true) and/or the createPinnedLink property (which defaults to false).
AttachmentsEditor This component displays, adds, and removes attachments to an item. Add this component within the scope of a PropogatingPanel. Nothing else needs to be done to make this component function. The propertyName is fixed, so setting this property has no effect.
BooleanEditor

This component edits properties of type Property.Types.INT32 or Property.Types.ENUMERATED as boolean values.

Add this component within the scope of a PropogatingPanel and set the propertyName property to the name of the property to be edited. Optionally, set the trueValue and falseValue properties to the integer values that represent true and false. In the case of Property.Types.INT32 properties, this is a pair of arbitrarily designated values. In the case of Property.Types.ENUMERATED properties, this pair corresponds to the code values of the enumerated values that represent true and false.

ComboEditor This component edits properties of type Property.Types.ENUMERATED. Add this component within the scope of a PropogatingPanel and set the propertyName property to the name of the property to be edited. Optionally, set the sortOrdering property to make the list of values be sorted in ASCENDING, DESCENDING, or NONE sort order.
ContentEditor This component edits properties of type Content . Add this component within the scope of a PropogatingPanel and set the propertyName property to the name of the property to be edited. Capable of displaying and editing plaintext and HTML content types.
DateEditor This component edits properties of type Property.Types.TIME. Add this component within the scope of a PropogatingPanel and set the propertyName property to the name of the property to be edited. Optionally, set the displayTimePortion property (which defaults to true) to display the date only or date and time. Optionally set the allowNull property (which defaults to true) to allow or disallow blank values.
ItemDisplayListener This is not a JavaBean, but an interface that some of the JavaBeans support. It is the listener interface for receiving notifications of a new item to be displayed and to refresh the display of the currently displayed item.
ItemsPaneComponent

Displays requirements, tasks, or topics in a folder in tree form. When an item is displayed in this component, the tree will be expanded so that the item is visible and the item can be selected. Most of the normal application item-level functionality is available via the context menu for the selected Item.

The ItemsPaneComponent depends on a StarTeam library that requires a StarTeam Server 5.3 or higher. On older releases, the component displays a placeholder instead of the component. The placeholder indicates that the component cannot find a 5.3 or higher license.

This component can be used in one of three ways:

  • If the actAsItemDisplayListener property is set to false (default), then you may set the linksComponent property to create a relationship such that when an Item selected in the LinksComponent, it will be displayed in this component.
  • If the actAsItemDisplayListener property is set to false (default), then you may leave the linksComponent property empty and call the showItem(Item) or setItem(ItemWrapper) methods directly.
  • If the actAsItemDisplayListener property is set to true, then the component will display the ItemWrapper set by the setItem method of the ItemDisplayListener interface.
Add this component within the scope of a PropogatingPanel, and it will automatically display the Item in the “current scope” according to the PropogatingPanel. Nothing else must be done to make this component function.
ItemPropertyEditor This is not a JavaBean but is the superclass of most the JavaBeans. This abstract base class is for property editor components. Subclasses of this class allow the display or editing of individual item properties. This class hooks listeners to event sources, such as PropogatingPanel, that control which item to display.
ItemPropertyLabel This component displays a property’s display name, optionally allowing an arbitrary name to override the default display name. Add this component within the scope of a PropogatingPanel and set the propertyName property to the name of the property. Optionally, set the text property to override the display name of the property. Optionally, set the prefix and suffix properties.
LinksAndTracesComponent.java This component shows all of the historical links and new traces and has a similar format to the LinksComponent table. Traces are the more advanced link asset created since StarTeam 2009.
LinksComponent This component displays items linked to an item. Add this component within the scope of a PropogatingPanel. Nothing else must be done to make this component function. The propertyName is fixed, so setting this property has no effect. Optionally, set the typeFilter property to the name of an item type to limit the displayed items to items of that type.
MultiSelectCheckBoxControl This component edits properties of type Property.Types.ENUMERATED which are multi-select. Add this component within the scope of a PropogatingPanel and set the propertyName property to the name of the property to be edited. Optionally, set the sortOrdering property to make the list of values be sorted in ascending, descending, or none sort order.
Navigator This component controls the navigation through a list of ItemWrapper. Add an ActionListener to listen for button events (ok, cancel, apply, and reset), or add a PropertyChangeListener to listen for currentItem events indicating that the currently selected item has changed, and items events indicating that the underlying list of ItemWrappers has changed. Optionally, set the refreshItems property to indicate whether or not the item data should be fetched from the server every time the item selection changes. The refreshItems property defaults to true.
NumberEditor This component edits properties of type Property.Types.INT32 or Property.Types.FLOAT64. Add this component within the scope of a PropogatingPanel and set the propertyName property to the name of the property to be edited. The component automatically detects the difference between integer and floating point numbers and behaves appropriately.
OpenLinkedItemButton This button launches a property editor to display an item selected in a LinksComponent. Add this button to the form and set the LinksComponent property with a reference to the LinksComponent to find the selected link in. Clicking the button performs the same action on the selected item as double-clicking the item in the LinksComponent.
PropogatingPanel This component recursively propagates the currentItem property change events to all the PropogatingPanel, ItemPropertyEditor, and ItemDisplayListener objects contained in this panel. It provides a convenient way to hook all property editors to the Navigator so that they can listen for new current item selections. As a side effect, this component sets tabbed pane tab titles red if the tab contains any required properties. We recommend using an instance of this class at the top level somewhere and adding it as a PropertyChangeListener to the Navigator.
RadioGroupControl

This component edits properties of type Property.Types.ENUMERATED which are single select. Add this component within the scope of a PropogatingPanel and set the propertyName property to the name of the property to be edited. Optionally, set the sortOrdering property to make the list of values be sorted in ascending, descending, or none sort order.

RevisionCommentEditor This component displays and edits the revision comment for an item. Add this component within the scope of a PropogatingPanel. Nothing else needs to be done to make this component function. The propertyName is fixed, so setting this property has no effect.
StaticTextEditor This component displays any type of property as read-only static text. Add this component within the scope of a PropogatingPanel and set the propertyName property to the name of the property to be displayed.
TaskDependenciesComponent This component displays the predecessor and successor relationships for a task. Add this component within the scope of a PropogatingPanel. Nothing else needs to be done to make this component function. The propertyName is fixed, so setting this property has no effect.
TaskWorkEditor This component displays, adds, edits, and removes Work Records for a task. Add this component within the scope of a PropogatingPanel. Nothing else needs to be done to make this component function. The propertyName is fixed, so setting this property has no effect.
TestButton This button populates a form with live data for testing convenience. This button is not intended to be visible on production forms, but may be added to the form so that, during development, live data may be used in the form without requiring that the form be launched from the application. The button should be hidden or removed when used in a production environment. The samples provided with StarTeam Extensions use this button in JBuilder and hide in when APEs are displayed to users.
TextAreaEditor This component edits properties of type Property.Types.TEXT in a multiline editor. Add this component within the scope of a PropogatingPanel and set the propertyName property to the name of the property to be edited.
TextFieldEditor This component edits properties of type Property.Types.TEXT in a single line editor. Add this component within the scope of a PropogatingPanel and set the propertyName property to the name of the property to be edited.
UserListEditor This component edits property groups that contain lists of User IDs. Add this component within the scope of a PropogatingPanel and set the propertyName property to the name of the primary property of the property group that contains the list of users, the countPropertyName property to the name of the property group’s property that identifies the number of IDs in the list, and the IDsPropertyName property to the name of the property group’s property that identifies the IDs in the list. Lists of users require implementing a special group of three properties. You must set the property name for all three members of the group.
UserListPropertyEditor

This component edits properties of type ObjectArray whose values are of type User . Add this component within the scope of a PropogatingPanel and set the propertyName property to the name of the property to be edited. Optionally, set the sortOrdering property to make the list of values be sorted in ascending, descending, or none sort order.

Back to top