Chapter 4   Designer Objects and their API Classes

This chapter lists the controls in the Page and Form Designers and specifies the class in the SilverStream API that is associated with the control. You can use this list to jump quickly into the online help for each class.

The sections are:

• Page Designer controls

• Form Designer controls

Page Designer controls   

The following table shows the classes associated with the controls in the Page Designer. Links to the online API documentation take you to the reference information for each class. The SilverStream package com.sssw.shr.page contains the page and page control classes.

Control	Associated class	Common uses of control
ActiveX	AgpActiveObject	Handles an ActiveX object.
Applet	AgpApplet	Handles a Java applet.
Cell	AgpTableCell	Handles formatting of a box inside a table, data view, layout region, or tab panel.
Checkbox	AgpButtonCheck	Displays and allows setting of a true/false value.
Choice Control	AgpChoice	Presents a dropdown list of choices.
Data	AgpData	Accesses additional data, beyond the primary data table for the page.
Data View	AgpViewPanel	Displays data in a table format.
File Attachment	AgpFileUpload	Uploads a file to the server.
Frame	AgpFrame	Divides a page into sections that contain other pages.
HTML Data Control	AgpHTMLControl	Inserts raw HTML.
Image	AgpImage	Enhances page appearance with graphics; can function as a button.
Image Hotspot, rectangular or oval	AgpImageHotSpot	Allows the user to bring up another page or perform an action by clicking on a specific portion of an image.
Label (also known as the Data tag)	AgpLabel	Displays literal text or text that results from an expression. Can function as a link.
Layout Region	AgpLayoutPanel	Arranges controls at specific positions on the page. Also called absolute positioning.
Line	Special type of AgpParagraph	Visually separates areas of the page with a horizontal line.
Link	Special type of AgpText	Allows the user to navigate to another page.
List Box	AgpList	Presents a selection list of multiple values.
Page	AgpPage	Handles properties, events, and methods for the page.
Paragraph	AgpParagraph	Formats a paragraph of text.
Plug-in	AgpPlugIn	Handles a plug-in.
Presentation	AgpPresentation	Includes a Java form or view on this page.
Radio Button	AgpButtonRadio	Displays and allows setting of a single value from a set of choices.
Subpage	AgpPage	Includes another page as part of this page.
Tab Panel	AgpTabPanel	Contains panes of information. Only the current pane's contents are displayed.
Table	AgpTable	Presents information in a table format.
Tag	AgpTag	Inserts additional HTML information.
Text	AgpText	Formats a selection of text.
Text Area	AgpTextArea	Displays and allows entry of multiple lines of text.
Text Button	AgpButtonText	Performs an action, such as submitting a request to the server.
Text Field	AgpTextField	Displays and allows entry of a single line of text or numbers. Can handle passwords and can be hidden.
Text Span	AgpTextSpan	Holds property settings for an arbitrary selection of text. You can assign a style or program events for the selected span.
View Panel	AgpViewPanel	Presents data in a tabular view.

Form Designer controls   

The following table shows the classes associated with the controls in the Form Designer. Links to the on-line API documentation take you to the reference information for each class. The SilverStream package com.sssw.rt.form and com.sssw.rt.jform contain the form and form control classes.

Control	Associated class	Purpose of control
ButtonCheck	AgcButtonCheck	Creates an AWT-based check box. (Version 2 toolbar)
ButtonImage	AgcButtonImage	Creates an AWT-based button with an image. (Version 2 toolbar)
ButtonRadio	AgcButtonRadio	Creates an AWT-based radio button. (Version 2 toolbar)
ButtonText	AgcButtonText	Creates an AWT-based button with a text label. (Version 2 toolbar)
Choice	AgcChoice	Creates an AWT-based dropdown list. (Version 2 toolbar)
ComboBox	AgcComboBox	Creates an AWT-based combo box, which combines a dropdown list with an edit box. (Version 2 toolbar)
Data	AgcData	Creates a SilverStream data cache that can be connected to a database or other external data source. Each form automatically has a primary data cache via the agData instance variable. It is not visible at runtime. (Common or Version 2 toolbar)
Dynamic View	AgcView	Creates a SilverStream view, which presents data in a tabular format. You can build the content of the view programmatically. (Other or Version 2 toolbar)
File Attachment	AgcFileAttachment	Creates a SilverStream control that manages downloading and uploading of files to a database. It is not visible at runtime. (Other or Version 2 toolbar)
Form	AgfForm
HTMLEditControl	AgcHTMLEditControl	Creates a SilverStream control that displays HTML and allows editing. A toolbar helps the user write HTML without using tags. (Common or Version 2 toolbar)
Image	AgcImage	Inserts an AWT-based control that displays an image. (Version 2 toolbar)
IntegerSpinnerField	AgcIntegerSpinnerField	Creates an AWT-based input field with increment and decrement arrows. The user can change the value via the arrows and optionally edit the value. (Version 2 toolbar)
JButton	AgcJButton	Creates a Swing-based button that can have an icon and a text label. (Common toolbar)
JCheckBox	AgcJCheckBox	Creates a Swing-based check box control that can have an icon and a text label. (Common toolbar)
JComboBox	AgcComboBox	Creates a Swing-based combo box, which combines a dropdown list with an edit box. (Common toolbar)
JEditorPane	AgcJEditorPane	Creates a Swing-based container for editing text of several types, including plain, HTML, and RTF. (Other toolbar)
JIntegerSpinnerField	AgcJIntegerSpinnerField	Creates a Swing-based input field with increment and decrement arrows. The user can change the value via the arrows and optionally edit the value. (Common toolbar)
JLabel	AgcJLabel	Creates a Swing-based label that can display text and an image. (Common toolbar)
JList	AgcJList	Creates a Swing-based scrollable list. (Common toolbar)
JProgressBar	JProgressBar	Creates a Swing progress bar for displaying changing status of a task. (Other toolbar)
JRadioButton	AgcJRadioButton	Creates a Swing-based radio button control that can have an icon and a text label. (Common toolbar)
JSlider	AgcJSlider	Creates a Swing-based slider with a knob the user moves between minimum and maximum values. (Common toolbar)
JTabbedPane	AgcJTabbedPane	Creates a Swing-based tabbed pane which serves as a container for other controls. By specifying a number of tabs, you can organize controls into several layers or "pages". (Other toolbar)
JTable	AgcJTable	Creates a Swing-based table with several rows and columns of data. (Other toolbar)
JTextArea	AgcJTextArea	Creates a Swing-based multiline editable text display. (Common toolbar)
JTextField	AgcTextField Also: AgcJBigDecimalField AgcJDoubleField AgcJDateField AgcJIntegerField AgcJPasswordField AgcJTimeField AgcJTimestampField	Creates a Swing-based single-line input field. By choosing a data type in the Designer, you can restrict input to a specific type of data. You can also choose the password option so that the characters the user types are masked from view. (Common toolbar)
JToggleButton	AgcJToggleButton	Creates a Swing-based button that toggles between two states. (Common toolbar)
JTree	AgcJTree	Creates a Swing-based tree control that presents hierarchical data as collapsible and expandable nodes. (Other toolbar)
Label	AgcLabel	Creates an AWT-based text label. (Version 2 toolbar)
List	AgcList	Creates an AWT-based scrollable list. (Version 2 toolbar)
Rectangle	AgcRectangle	Creates a rectangle that you can use to indicate a group of controls visually. (Common or Version 2 toolbar)
Slider	AgcSlider	Creates an AWT-based slider control. (Version 2 toolbar)
Subform	AgfForm	Inserts a form that was defined in the Form Designer as a control on the current form. (Gallery)
TextArea	AgcTextArea	Creates an AWT-based multiline text area with editing capability. (Version 2 toolbar)
TextField	AgcTextField Also: AgcBigDecimalField AgcDoubleField AgcDateField AgcIntegerField AgcPasswordField AgcTimeField AgcTimestampField	Creates an AWT-based input single-line field. By choosing a data type in the Designer, you can restrict input to a specific type of data. You can also choose the password option so that the characters the user types are masked from view. (Version 2 toolbar)
Timer	AgcTimer	Creates a SilverStream timer control that can fire events at specified intervals. It is not visible at runtime. (Common or Version 2 toolbar)
TreeControl	AgcTreeControl	Creates an AWT-based tree control that presents hierarchical data as collapsible and expandable nodes. (Version 2 toolbar)
View	AgcViewDownloadable	Inserts a view defined in the View Designer. (Gallery)