Chapter 5   Naming SilverStream Objects

This page describes naming conventions used for objects created and referenced in the SilverStream programming environment. Here are some basic rules:

• Prefix objects with logical prefixes so that they are easily recognized and are grouped together in designer lists. For example, 'frm' for forms, 'dlg' for dialogs, 'pg' for pages (see table below)

• Use Java conventions for class, method, variable names and constants. For example, MyClass, thisIsMyMethod, myString, MY_CONSTANT.

• Prefix Swing controls with a 'j'. For example 'jsld' for a Swing slider control.

• Private and protected member variables begin with the characters "m_", and then follow the method naming convention above. For example: m_myProtectedMember.

• SilverStream has a small set of keywords reserved by the Form Designer. They are: AgDialog, AgBrowser, AgGeneral, and AgData.

• Table names, column names, and column expressions should match your database schema.

The following table shows the suggested naming conventions for various objects.

Visual class	Abbreviation or prefix	Example
Label	lbl	lblOrderdate
Text Field	fld	fldProductName
Text Area	ta	taProductDesc
HTML Edit Control	html	htmlResume
List Box	lb	lbTitles
Choice Box	ch	chStateID
Combo Box	cb	cbTitles
Check Box	chk	chkUSCitizen
Dialog box	dlg	dlgAddUsersToGroup
Radio Button	rb	rbActive
Text Button	btn	btnNext
Image Button	btn	btnSave
Image	img	imgOrderHeader
Rectangle	rct	rctPersonalInfo
Tab	tab	tabMaintenance
Slider	sld	sldVolume
Spin Control	spin	spinDaysOff
File attachment	attch	attchSales
Form	frm	frmEmployees
subform	frm	frmSecurity
View	vw	vwSalaries
Page	pg	pgOrders
Business object - blank class	bo	biMonthlyReport
Business object - mail	mail	mailSendNews
Business object - table modified	tbl	tblRegistration
Business object - scheduled	schd	schdMonthlySummary
Business object - server event	srvevt	srvevtRegister
Business object - invoked	inv	invValidate
Business object - data source object	dso	dsoNotesData
Business object - servlet	srvlet	srvletHRApp