0% found this document useful (0 votes)

8 views657 pages

Internet Builder Class Reference

Uploaded by

Marcelo Acosta

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

8 views657 pages

Internet Builder Class Reference

Uploaded by

Marcelo Acosta

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

CONTENTS 1

IBC Library
Reference
COPYRIGHT SoftVelocity Inc
All rights reserved.
This publication is protected by copyright and all rights are reserved by SoftVelocity Incorporated.
It may not, in whole or part, be copied, photocopied, reproduced, translated, or reduced to any
electronic medium or machine-readable form without prior consent, in writing, from SoftVelocity
Incorporated.

This publication supports Clarion Internet Connect. It is possible that it may contain technical or
typographical errors. SoftVelocity Incorporated provides this publication “as is,” without
warranty of any kind, either expressed or implied.

[Link]

Trademark Acknowledgements:
Btrieve is a registered trademark of Pervasive Software.
All other products and company names are trademarks of their respective owners.
CONTENTS 3

CONTENTS SUMMARY

FOREWORD 27
INTRODUCTION 29
BROKER CLASS 39
WEB SERVER CLASSES 61
WEB CLIENT MANAGER CLASS 91
BROWSER MANAGER CLASS 107
WEB FRAME CLASS 115
WEB WINDOW CLASSES 127
WEB CONTROL CLASS 217
WEBCONTROLCLASS DERIVED CLASSES 263
WEB AREA CLASSES 407
WEB REPORT CLASS 441
JSL MANAGER CLASS 449
JSL EVENTS CLASS 475
WEB FILES CLASS 487
LAYOUT HTML CLASS 507
SUBMIT ITEM CLASS 519
HTML CLASS 525
TEXT OUTPUT CLASS 569
HTTP CLASSES 579
INDEX 621
4 IBC LIBRARY REFERENCE

CONTENTS
FOREWORD 27
INTRODUCTION 29
Changes in this Book 28
About This Book 30
Clarion Internet Builder Classes 31
Class Libraries Generally.......................................................................................31
Internet Builder Classes—The IBC Library ..........................................................31
Using the IBC Library ...........................................................................................32
Internet Connect Terms and Concepts .................................................................. 32
Internet Builder Class Synopsis ............................................................................ 35
Internet Builder Class Header Files .......................................................................36
Internet Connect Templates and the IBC Library ................................................. 36
Documentation Conventions 37
Reference Item Formats and Syntax Diagrams .................................................... 37
Property (short description of intended use) ......................................................... 37
Method (short description of what the method does) ............................................38

BROKER CLASS 39
Overview 41
BrokerClass Concepts ............................................................................................41
Relationship to Other Internet Builder Classes ..................................................... 41
Internet Connect Template Implementation ...........................................................42
Source Files............................................................................................................42
Conceptual Example ..............................................................................................43
BrokerClass Properties 44
Client (WebClientManagerClass object) .............................................................. 44
Http (HttpClass object) ..........................................................................................44
Files (WebFilesClass object) .................................................................................45
ServerName (server identifier) ..............................................................................45
BrokerClass Methods 46
Functional Organization—Expected Use ..............................................................46
CloseChannel (close channel to application broker) .............................................47
GetAuthorizedInfo (get client password) ..............................................................48
GetClient (return WebClientManagerClass object) ...............................................49
GetRequestArguments (return browser request) .................................................. 50
Init (initialize the BrokerClass object) .................................................................. 51
Kill (shut down the BrokerClass object) ............................................................... 52
OpenChannel (open channel to application broker) ............................................. 53
ProcessHttpHeader (process incoming http)..........................................................54
SetClient (set client information) .......................................................................... 55
SetClientBrowser (set browser information) ........................................................ 55
TakeFile (send HTML code or JSL data)...............................................................56
TakeHtmlPage (prepare and send HTML code) ....................................................57
TakeJslData (prepare and send JSL data) ..............................................................58
TakeUnauthorized (prepare and send access denied page)....................................59

WEB SERVER CLASSES 61

Overview 63
WebServerClass Concepts .....................................................................................63
ShutDownClass Concepts ......................................................................................63
Relationship to Other Internet Builder Classes ..................................................... 63
Internet Connect Template Implementation ...........................................................64
Source Files............................................................................................................64
Conceptual Example ..............................................................................................65
WebServerClass Properties 66
Active (server communicates with broker) ........................................................... 66
ArgIndex (index to browser request string) .......................................................... 66
Broker (BrokerClass object) ................................................................................. 66
CurSubmit (SubmitItemClass object) ....................................................................67
Client (WebClientManagerClass object) .............................................................. 67
CommandLine (command line parameters) ..........................................................68
DialogPageBackColor (MESSAGE page background color) ...............................68
DialogPageImage (MESSAGE page wallpaper) ...................................................68
DialogWinBackColor (MESSAGE window background color) ...........................68
DialogWinImage (MESSAGE window wallpaper) .............................................. 69
Files (WebFilesClass object) ................................................................................ 69
GotCommandLine (command line arguments set flag) ........................................ 69
JavaLibraryPath (Java Support Library location) ..................................................70
PageToReturnTo (return URL).............................................................................. 70
ProgramName (Server pathname) ........................................................................ 71
TimeOut (period of inactivity after which to shut down) ..................................... 71
WebServerClass Methods 72
Functional Organization—Expected Use ..............................................................72
Connect (establish communication with Application Broker) ...............................74
GetInternetEnabled (return Web/Windows mode) ................................................ 75
GetReadyForPage (return ready-to-continue flag) ................................................76
GetRequestedWholePage (return scope of browser request)................................ 77
GetSendWholePage (return full or partial refresh flag).........................................78
Halt (immediately shut down the Server) ............................................................. 79
Init (initialize the WebServerClass object) ............................................................80
Kill (shut down the WebServerClass object) .........................................................81
Quit (shut down the Server normally) ...................................................................82
SetDialogPageBackground (set MESSAGE Web page background) ....................83
SetDialogWinBackground (set MESSAGE Web page window background) .......84
SetSendWholePage (force full page refresh) ........................................................ 85
SetNewPageDisable (suppress outgoing Web pages) ............................................86
SetNextAction (return Web page field information) ..............................................87
TakeEvent (process WebServerClass object events) .............................................88
TakePageSent (prepare WebServerClass object for next page) .............................89
ShutDownClass Methods 90
Close (a virtual shut down the Web-enabled application) .....................................90

WEB CLIENT MANAGER CLASS 91

Overview 93
WebClientManagerClass Concepts .......................................................................93
Relationship to Other Internet Builder Classes ..................................................... 93
Internet Connect Template Implementation ...........................................................93
Source Files............................................................................................................93
WebClientManagerClass Properties 94
Broker (BrokerClass object) ................................................................................. 94
Browser (BrowserManagerClass object) .............................................................. 94
IP (client IP address) ..............................................................................................95
Jsl (JslManagerClass object) ..................................................................................95
WebClientManagerClass Methods 96
Functional Organization—Expected Use ..............................................................96
Feq2Id (return HTML control Id) ..........................................................................97
Init (initialize the WebClientManagerClass object)...............................................98
Kill (shut down the WebClientManagerClass object) ...........................................99
NextHtmlPage (prepare for next HTML page) ....................................................100
TakeFile (send HTML code or JSL data).............................................................100
TakeHtmlPage (send HTML code) ......................................................................101
TakeJslData (send JSL data) ................................................................................103
TakeUnauthorized (send access denied page) .....................................................105

BROWSER MANAGER CLASS 107

Overview 109
BrowserManagerClass Concepts .........................................................................109
Relationship to Other Internet Builder Classes ................................................... 109
Internet Connect Template Implementation .........................................................109
Source Files..........................................................................................................109
BrowserManagerClass Properties 110
Kind (browser type) .............................................................................................110
SetNoCache (external cache control support)......................................................110
SupportsStyleSheets (style sheet support) ...........................................................111
SubmitFromJava (applet communication mode) .................................................111
BrowserManagerClass Methods 112
Init (initialize the BrowserManagerClass object) ................................................112

WEB FRAME CLASS 115

Overview 117
WebFrameClass Concepts ...................................................................................117
Relationship to Other Internet Builder Classes ................................................... 117
Internet Connect Template Implementation .........................................................117
Source Files..........................................................................................................117
Conceptual Example ............................................................................................118
WebFrameClass Properties 119
FrameWindow (MDI frame window) ..................................................................119
MenubarFeq (menubar control number) ..............................................................119
ToolbarFeq (Toolbar control number) .................................................................119
WebFrameClass Methods 120
CopyControlsToWindow (a virtual to copy frame controls to child window) ... 120
CopyControlToWindow (copy frame control to child window) ......................... 122
GetMenubarFeq (return menubar control number) .............................................123
GetToolbarFeq (return Toolbar control number) .................................................124
TakeEvent (a virtual to handle menu and toolbar events) ....................................125

WEB WINDOW CLASSES 127

Overview 131
WebWindowClass Concepts ............................................................................... 131
Relationship to Other Internet Builder Classes ................................................... 132
Internet Connect Template Implementation .........................................................132
Source Files..........................................................................................................133
WebControlListClass Methods 134
Functional Organization—Expected Use ............................................................134
AddControlsToLayout (set controls for HTML generation) ...............................135
CreateHtml (generate HTML for controls) ......................................................... 136
Init (initialize the WebControlListClass object) ..................................................138
Kill (shut down the WebControlListClass object) .............................................. 138
SetParentDefaults (set a control’s children) ........................................................139
WebWindowBaseClass Properties 140
AllowJava (generate or suppress JavaScript) .......................................................140
Background (window background color) ............................................................140
BackImage (window wallpaper) ..........................................................................140
BorderWidth (Web page border width) ...............................................................141
CloseImage (close button graphic) ..................................................................... 141
CreateCaption (include a titlebar on the Web page) ........................................... 141
CreateClose (include a close button on the Web page) ........................................142
CreateToolbar (include a toolbar on the Web page) ............................................142
DefaultButton (enter key button) ........................................................................ 143
DefaultButtonNeeded (simulate default button) ................................................. 143
DisabledAction (default HTML for disabled controls) ...................................... 144
Files (WebClientManagerClass object) ...............................................................144
FormatBorderWidth (HTML table cell border width) .........................................145
GroupBorderWidth (group box border width).................................................... 145
HelpDocument (HTML help document) .............................................................145
HelpEnabled (HTML help enabled flag) .............................................................146
HelpRelative (remote or local help document) ....................................................146
HelpStyle (HTML help style) ..............................................................................146
HtmlOption (window/control scaling information) ............................................ 147
IsSplash (splash screen flag) ................................................................................147
MenubarFeq (menubar control number) ..............................................................148
MenubarType (menu placement) .........................................................................148
OptionBorderWidth (option box border width) .................................................. 148
PageBackground (web page background color) ................................................. 149

PageImage (web page wallpaper) ........................................................................149

Server (WebServerClass object) ..........................................................................149
SheetBorderWidth (sheet border width) ............................................................. 150
SnapX (horizontal control alignment factor) .......................................................150
SnapY (vertical control alignment factor) ...........................................................150
TimerAction (time released browser action) .......................................................151
TimerDelay (time interval for browser action) ....................................................151
ToolbarFeq (toolbar control number) ..................................................................152
WebWindowBaseClass Methods 153
Functional Organization—Expected Use ............................................................153
CreateChildHtml (create HTML for control’s children) .................................... 153
GetBackgroundColor (return Web window background color) ...........................154
GetBackgroundImage (return Web window wallpaper) ......................................154
GetControl (return control information) ..............................................................155
GetCreateClose (return close button flag) ...........................................................155
GetChildren (return all child controls).................................................................156
GetFirstChild (return first child control) ............................................................ 157
GetHelpHandler (return HTML to show help document) .................................. 157
GetHelpReference (return HTML help document reference)............................. 158
GetHelpTarget (return HTML HREF for help display) ...................................... 158
GetMenubarFeq (return menubar control number) .............................................158
GetPageImage (return Web page wallpaper) .......................................................159
GetShowMenubar (return menubar include/omit flag) ...................................... 159
GetShowToolbar (return toolbar include/omit flag) ........................................... 159
GetToolbarFeq (return Toolbar control number) .................................................160
GetToolbarMode (return toolbar entity) ..............................................................160
GetWebActiveFrame (return WebFrameClass reference) ...................................161
WebWindowClass Properties 162
Authorize (require username and password) ...................................................... 162
AuthorizeArea (name of password protected Web page) ................................... 163
HtmlTarget (HtmlClass object) ............................................................................163
IsCentered (center or left-justify web window) ...................................................163
IsSecure (public or secure channel) .................................................................... 164
SentHtml (first time process) ...............................................................................164
WebWindowClass Methods 165
Functional Organization—Expected Use ............................................................165
AddControl (add control information) ................................................................ 167
AddControlsToLayout (set controls for HTML generation) ...............................169

BodyFooter (generate HTML BODY footer) ......................................................170

BodyHeader (generate HTML BODY header) ....................................................171
CreateChildHtml (create HTML for control’s children) .................................... 172
CreateDummyHtmlPage (write empty Html page) ............................................ 173
CreateHtmlPage (generate HTML for a window) .............................................. 174
CreateJslData (generate Java Support Library data) ............................................175
CreatePageFooter (generate HTML page footer) ................................................176
CreatePageHeader (generate HTML page footer) ...............................................176
CreateUnauthorizedPage (create unauthorized user page) ..................................177
GetAuthorized (check user authorization) .......................................................... 179
GetBackgroundColor (return Web window background color) ...........................180
GetBackgroundImage (return Web page wallpaper)............................................181
GetButtonInClientArea (return button present indicator) ....................................182
GetChildren (return all child controls).................................................................183
GetControl (return control information) ..............................................................184
GetControlInfo (return control reference) .......................................................... 185
GetCreateClose (return close button flag) ...........................................................186
GetFirstChild (return first child control) ............................................................ 187
GetHelpHandler (return HTML to show help document) .................................. 188
GetHelpReference (return HTML help document reference)............................. 189
GetHelpTarget (return HTML HREF for help display) ...................................... 190
GetMenubarFeq (return menubar control number) .............................................191
GetPageImage (return Web page wallpaper) .......................................................192
GetShowMenubar (return menubar include/omit flag) ...................................... 192
GetShowToolbar (return toolbar include/omit flag) ........................................... 193
GetTableAttributes (return window HTML <STYLE>) .....................................194
GetTargetSecurity (return public or secure flag) .................................................195
GetToolbarFeq (return Toolbar control number) .................................................196
GetToolbarMode (return toolbar entity) ..............................................................197
GetWebActiveFrame (return WebFrameClass reference) .................................. 198
Init (initialize the WebWindowClass object) ...................................................... 199
Kill (shut down the WebWindowClass object) ....................................................200
ResetFromControls (set control information) ..................................................... 200
SetBackground (set Web page window background) ..........................................201
SetCentered (center window in Web page) ..........................................................202
SetChildDefaults (set children of each control) ...................................................202
SetFormatOptions (set Web page scale and alignment) .......................................203
SetHelpDocument (enable single document Web page help) ..............................204
SetHelpURL (enable multiple document Web page help) ...................................205

SetPageBackground (set Web page background) ............................................... 206

SetPassword (require Web page password) ........................................................ 207
SetSplash (make this a splash window) .............................................................. 208
SetTimer (set Web page timer and action) ...........................................................209
SuppressControl (omit control from Web page) ................................................. 210
TakeCreatePage (fill Client request for page) .....................................................211
TakeEvent (handle browser and ACCEPT loop events) ......................................212
TakeRequest (process browser event/request) .................................................... 213
TakeUnknownSubmit (a virtual to handle unexpected requests) ....................... 214
TitleContents (set browser titlebar) .................................................................... 215
ValidatePassword (verify password) ................................................................... 216

WEB CONTROL CLASS 217

Overview 219
WebControlClass Concepts ................................................................................ 219
Relationship to Other Internet Builder Classes ................................................... 219
Internet Connect Template Implementation .........................................................220
Source Files..........................................................................................................220
WebControlClass Properties 221
ActionOnAccept (browser action for control) .................................................... 221
Container (container control) .............................................................................. 222
DisabledAction (HTML for disabled control) .................................................... 222
Feq (control number) ...........................................................................................223
IsDynamic (memory allocated flag) ................................................................... 223
OwnerWindow (owner window) .........................................................................223
ParentFeq (Web page parent control ) .................................................................224
RealParentFeq (window parent control) ............................................................. 224
WebControlClass Methods 225
Functional Organization—Expected Use ............................................................225
BeforeResetControl (a virtual for control preprocessing) .................................. 227
CreateCellContents (write HTML for control) ....................................................227
CreateCellFooter (end HTML for control attributes) ..........................................228
CreateCellHeader (begin HTML for control attributes) ..................................... 228
CreateColorParameters (write Java applet color parameters) ............................. 229
CreateForeColorParameter (write Java applet foreground color parameter) ...... 230
CreateHtml (write HTML for control and its attributes) .....................................231
CreateHtmlExtra (write HTML for related control) ............................................232
CreateJslData (update Web page controls) ..........................................................232

CreateParams (write all parameters for Java control) ..........................................233

DoSetChildDefaults (set nested child controls) .................................................. 233
GetAlignText (return text alignment information) ..............................................234
GetAppletType (return applet type) .................................................................... 234
GetBackgroundColor (return background color) .................................................235
GetCanDisable (return disable-ability flag) .........................................................236
GetCellAttributes (return control attributes)........................................................237
GetChoiceChanged (return selection change) .................................................... 238
GetEventAction (return browser action)..............................................................239
GetFont (add font information)........................................................................... 240
GetHasHotkey (control text contains ‘&’)...........................................................240
GetIsChild (return family identity) ......................................................................241
GetLevel (return nesting level)................................................................................242
GetNameAttribute (return HTML control name) ................................................242
GetParentBackgroundColor (return parent background color) ...........................243
GetPosition (get control coordinates) ................................................................. 244
GetQuotedText (return control text in quotes) ....................................................245
GetTableAttributes (return HTML STYLE)........................................................245
GetText (return control text) ................................................................................245
GetUseChanged (return contents changed indicator) ......................................... 246
GetVisible (return control status flag) .................................................................247
Init (initialize the WebControlClass object) ........................................................248
Kill (shut down the WebControlClass object) .....................................................249
PopFont (restore pre-PushFont font) .................................................................. 250
PushFont (implement control font) ......................................................................251
RefreshDisabled (update Web page control status) .............................................252
ResetControl (update server control) ...................................................................253
ResetFromQueue (record changes to Server LIST queue) ................................. 254
SetAutoSpotLink (a virtual to set AutoSpotLink) .............................................. 255
SetBorderWidth (a virtual to set BorderWidth) ...................................................255
SetBreakable (allow word wrap) .........................................................................256
SetChildDefaults (a virtual to set Web page control children) ............................256
SetDescription (a virtual to set AltText) .................................................................257
SetEventAction (associate browser action with control event) .......................... 258
SetParentDefaults (confirm parent) .....................................................................260
SetQueue (a virtual to set the FromQ property) ..................................................261
UpdateCopyChoice (save selected item number) ................................................261
UpdateCopyUse (save copy of control contents).................................................262

WEBCONTROLCLASS DERIVED CLASSES 263

Overview 269
WebControlClass Concepts ................................................................................ 269
Classes Derived from WebControlClass ............................................................ 269
Relationship to Other Internet Builder Classes ................................................... 269
Internet Connect Template Implementation .........................................................269
Source Files..........................................................................................................270
WebHtmlCheckClass Methods 271
BeforeResetControl (control preprocessing) .......................................................271
CreateCellContents (generate HTML check box) ...............................................272
CreateJslData (update Web page control) ............................................................273
GetHasHotkey (control text may contain &) .......................................................274
ResetControl (update server control) ...................................................................275
WebHtmlEntryClass Methods 276
CreateCellContents (generate HTML entry box) ................................................276
CreateJslData (update Web page control) ............................................................277
ResetControl (update server control) ...................................................................278
WebHtmlGroupClass Properties 279
BorderWidth (Web page control border width) .................................................. 279
WebHtmlGroupClass Methods 280
CreateHtml (write HTML for GROUP control) ................................................. 280
GetHasHotkey (control text may contain &) .......................................................281
Init (initialize WebHtmlGroupClass object) ........................................................282
SetBorderWidth (set Web page control border width).........................................283
WebHtmlItemClass Methods 284
CreateCellContents (generate HTML menu item) ...............................................284
GetVisible (return control status flag) .................................................................285
ResetControl (update server control) ...................................................................286
WebHtmlMenuClass Methods 287
CreateCellContents (generate HTML menu) ...................................................... 287
CreateHtml (write HTML for MENU control) ....................................................288
GetCellAttributes (return control attributes)........................................................289
GetVisible (return control status flag) .................................................................290
WebHtmlOptionClass Properties 291
BorderWidth (Web page control border width) .................................................. 291

WebHtmlOptionClass Methods 292

CreateHtml (write HTML for OPTION control) .................................................292
CreateJslData (update Web page control) ............................................................293
GetTableAttributes (return HTML STYLE)........................................................294
Init (initialize WebHtmlOptionClass object) .......................................................295
ResetControl (update server control) ...................................................................296
SetBorderWidth (set Web page control border width).........................................297
WebHtmlPromptClass Methods 298
CreateCellContents (generate HTML prompt) ................................................... 298
GetHasHotkey (control text may contain &) .......................................................299
WebHtmlRadioClass Methods 300
CreateCellContents (generate HTML radio button) ............................................300
GetHasHotkey (control text may contain &) .......................................................301
WebHtmlRegionClass Methods 302
CreateHtmlExtra (write HTML for related control) ............................................302
SetParentDefaults (confirm parent) .....................................................................303
WebHtmlSheetClass Properties 304
BorderWidth (Web page control border width) .................................................. 304
WebHtmlSheetClass Methods 305
CreateHtml (write HTML for SHEETcontrol) ....................................................305
CreateTabControl (write HTML for SHEET TABs) .............................................. 307
GetIsChild (return family identity) ......................................................................308
GetTableAttributes (return HTML STYLE)........................................................309
Init (initialize WebHtmlSheetClass object) .........................................................310
ResetControl (update server control) ...................................................................311
SetBorderWidth (set Web page control border width).........................................312
SetChildDefaults (set nested child controls) ........................................................313
WebHtmlTabClass Properties 314
IsEnabled (control enabled flag) ......................................................................... 314
WebHtmlTabClass Methods 315
CreateHtml (write HTML for control and its attributes) .....................................315
CreateJslData (update Web page control) ............................................................316
CreateParams (write all tab parameters) ............................................................. 317
GetAppletType (return applet type) .................................................................... 318
GetHasHotkey (control text may contain &) .......................................................319
GetIsChild (return family identity) ......................................................................320
GetPosition (get control coordinates) ................................................................. 321
GetVisible (return control status flag) .................................................................322

ResetControl (update server control) ...................................................................323

SetParentDefaults (confirm parent) .....................................................................324
WebHtmlTextClass Methods 325
CreateCellContents (generate HTML text box).................................................. 325
CreateJslData (update Web page control) ............................................................326
ResetControl (update server control) ...................................................................327
WebButtonClass Methods 328
BeforeResetControl (control preprocessing) .......................................................328
GetHasHotkey (control text may contain &) .......................................................329
GetVisible (return control status flag) .................................................................330
ResetControl (update server control) ...................................................................331
WebHtmlButtonClass Methods 332
CreateCellContents (generate HTML button) .....................................................332
Init (initialize WebButtonClass object)................................................................333
ResetControl (update server control) ...................................................................334
WebJavaButtonClass Properties 335
IsEnabled (control enabled flag) ......................................................................... 335
WebJavaButtonClass Methods 336
CreateHtml (write HTML for control and its attributes) .....................................336
CreateJslData (update Web page control) ............................................................338
CreateParams (write all button parameters).........................................................339
GetAppletType (return applet type) .................................................................... 339
GetCanDisable (return disable-ability flag) .........................................................340
GetFilename (return image filename) ..................................................................341
ResetControl (update server control) ...................................................................342
WebJavaToolButtonClass Methods 343
GetEventAction (return browser action)..............................................................343
WebImageClass 345
WebHtmlImageClass Properties 346
AltText (text to substitute for image) ...................................................................346
WebHtmlImageClass Methods 347
CreateCellContents (generate HTML image control) .........................................347
SetChildDefaults (set image/region relationship) ................................................348
SetDescription (set text to substitute for image) ................................................. 348
WebJavaImageClass Properties 349
Filename (image file filename) ........................................................................... 349

WebJavaImageClass Methods 350

CreateHtml (write HTML for control and its attributes) .....................................350
CreateJslData (update Web page control) ............................................................352
CreateParams (write all image parameters) ........................................................ 353
GetAppletType (return applet type) .................................................................... 354
WebListClass Methods 355
GetBackgroundColor (return background color) .................................................355
WebHtmlListClass Methods 356
CreateCellContents (generate HTML list box) ................................................... 356
CreateJslData (update Web page control) ............................................................357
ResetControl (update server control) ...................................................................358
WebJavaListClass Properties 359
AutoSpotLink (hypertext links) .......................................................................... 359
EventActionQ (browser actions for listbox events) .............................................359
Format (Web list formatting information) ...........................................................360
FromQ (LIST data source) ...................................................................................360
QueueActionQ (Server LIST queue changes) .....................................................361
Started (Java list applet started) .......................................................................... 361
WebJavaListClass Methods 362
CreateHtml (write HTML for LIST control) ...................................................... 362
CreateJslData (update Web page control) ............................................................364
CreateParams (write all list parameters) ............................................................. 365
GetAppletType (return applet type) .................................................................... 366
GetEventAction (return browser action)..............................................................367
Init (initialize the WebJavaListClass object) ...................................................... 368
Kill (shut down the WebJavaListClass object) ....................................................369
ResetControl (update server control) ...................................................................370
ResetFromQueue (record changes to Server LIST queue) ................................. 371
SetAutoSpotLink (set live hypertext links) ..........................................................372
SetDirty (force refresh of Web page list box) ......................................................372
SetEventActin (associate browser action with control event) ............................ 373
SetQueue (set the data source queue) ..................................................................375
UpdateState (force refresh of Web page list box) ............................................... 376
WebStringClass Methods 377
SetBreakable (allow word wrap) .........................................................................377
WebHtmlStringClass Methods 378
CreateCellContents (generate HTML text string) .............................................. 378
GetCellAttributes (return control attributes)........................................................379

WebJavaStringClass Properties 380

AutoSpotLink (hypertext links) .......................................................................... 380
LastText (last transmitted value) ..........................................................................380
WebJavaStringClass Methods 381
CreateHtml (write HTML for control and its attributes) .....................................381
CreateJslData (update Web page control) ............................................................382
CreateParams (write all string parameters) ......................................................... 383
GetAppletType (return applet type) .................................................................... 384
Init (initialize WebJavaStringClass object)..........................................................385
SetAutoSpotLink (set live hypertext links) ..........................................................386
WebCloseButtonClass Properties 387
Height (button height) ..........................................................................................387
Width (button width) ............................................................................................387
X (button horizontal position)............................................................................. 387
Y (button vertical position) ..................................................................................387
WebCloseButtonClass Methods 388
CreateHtml (write HTML for control and its attributes) .....................................388
CreateJslData (update Web page control) ............................................................390
CreateParams (write all string parameters) ......................................................... 391
GetAppletType (return applet type) .................................................................... 392
GetCloneFeq (return button to mimic) ............................................................... 393
GetPosition (get control coordinates) ................................................................. 394
GetVisible (return control status flag) .................................................................395
Init (initialize WebCloseButtonClass object) ......................................................396
ResetControl (apply Web page button action) .....................................................397
WebHotlinkClass Methods 398
CreateCellContents (generate HTML hypertext link) .........................................398
WebLiteralClass Properties 399
Text (Web page text) ............................................................................................399
WebLiteralClass Methods 400
CreateHtml (write HTML for control)................................................................ 400
GetCellAttributes (return control attributes)........................................................401
WebNullControlClass Methods 402
CreateHtml (write HTML for control)................................................................ 402
CreateJslData (update Web page control) ............................................................402
GetAppletType (return applet type) .................................................................... 403
GetCellAttributes (return control attributes)........................................................404

GetIsChild (return family identity) ......................................................................405

GetVisible (return control status flag) .................................................................406
WEB AREA CLASSES 407
Overview 409
WebAreaClass Concepts ..................................................................................... 409
Relationship to Other Internet Builder Classes ................................................... 409
Internet Connect Template Implementation .........................................................410
Source Files..........................................................................................................410
WebAreaClass Properties 411
Background (area background color) ..................................................................411
BackImage (area wallpaper) ................................................................................411
LocalFont (area font information) ...................................................................... 411
WebAreaClass Methods 412
GetBackgroundColor (return background color) .................................................412
GetCellAttributes (return area attributes) ............................................................413
GetFont (add font information)........................................................................... 414
GetVisible (return control status flag) .................................................................415
Init (initialize the WebAreaClass object) ............................................................ 416
Kill (shut down the WebAreaClass object)........................................................ 417
PushFont (implement area font) ..........................................................................418
SetBackground (set Web page area background) ................................................419
SetFont .................................................................................................................420
SetParentDefaults (confirm parent) .....................................................................421
WebCaptionClass Properties 422
Alignment (text justification).............................................................................. 422
WebCaptionClass Methods 423
CreateHtml (write HTML for caption and its attributes) .....................................423
GetCellAttributes (return caption attributes) .......................................................424
GetPosition (get control coordinates) ................................................................. 425
GetText (return caption text) ................................................................................426
GetVisible (return control status flag) .................................................................427
Init (initialize the WebCaptionClass object) ....................................................... 428
WebMenubarClass Methods 429
CreateHtml (write HTML for menubar and its children) ....................................429
GetPosition (get control coordinates) ................................................................. 430
GetVisible (return control status flag) .................................................................431
Init (initialize the WebMenubarClass object) ......................................................432

WebToolbarClass Methods 433

CreateHtml (write HTML for toolbar and its children) ...................................... 433
GetAppletType (return applet type) .................................................................... 434
GetPosition (get control coordinates) ................................................................. 435
GetVisible (return control status flag) .................................................................436
WebClientAreaClass Methods 437
CreateHtml (write HTML for client area and its children)..................................437
GetBackgroundColor (return background color) .................................................438
GetPosition (get control coordinates) ................................................................. 439

WEB REPORT CLASS 441

Overview 443
WebReportClass Concepts.................................................................................. 443
Relationship to Other Internet Builder Classes ................................................... 443
Internet Connect Template Implementation .........................................................443
Source Files..........................................................................................................444
WebReportClass Properties 445
Html (HtmlClass object) ..................................................................................... 445
Q (report image files to preview) ........................................................................ 445
NumPages (report page count)............................................................................ 446
Server (WebServerClass object) ..........................................................................446
WebReportClass Methods 447
Init (initialize the WebReportClass object) ..........................................................447
Kill (shut down the WebReportClass object) ..................................................... 447
Preview (send report pages to client browser) .................................................... 448
SetNumPages (set maximum report page count) .................................................448

JSL MANAGER CLASS 449

JSLManagerClass Methods 455

Functional Organization—Expected Use ............................................................455
AddQueueEntry (add a Java list row) ..................................................................456
BeginUpdate (write JSL data delimiters).............................................................457
CloseChannel (close output channel and notify Client) ..................................... 458
Init (initialize the JSLManagerClass object) ...................................................... 459
Kill (shut down the JSLManagerClass object) ................................................... 459
OpenChannel (open channel for JSL data) ......................................................... 460
RemoveAllQueueEntries (delete all Java list rows).............................................462
RemoveQueueEntries (delete Java list rows).......................................................463
ScrollQueueDown (scroll Java list down) ..............................................................464
ScrollQueueUp (scroll Java list up) .................................................................... 465
SelectControl (set Java control to update) ...........................................................466
SetAttribute (set Java control attribute—string) ..................................................467
SetAttributeFilename (set Java control attribute—pathname) ............................ 468
SetAttributeLong (set Java control attribute—number).......................................469
SetChecked (set Java check box status) .............................................................. 470
SetIconAttribute (display icon in Java list) ..........................................................471
SetListChoice (highlight HTML list row) .......................................................... 472
SetQueueEntry (replace a Java list row) .................................................................473
SetValue (set Java control contents) .....................................................................474

JSL EVENTS CLASS 475

Overview 477
JslEventsClass Concepts ..................................................................................... 477
Relationship to Other Internet Builder Classes ................................................... 478
Internet Connect Template Implementation .........................................................478
Source Files..........................................................................................................478
JslEventsClass Properties 479
EventQ (equivalent Clarion and JSL events) ...................................................... 479
JSLEventsClass Methods 480
Functional Organization—Expected Use ............................................................480
AddEvent (add a Clarion/JSL event pair) ............................................................481
Init (initialize the JSLEventsClass object) ...........................................................482
Kill (shut down JSLEventsClass object)..............................................................483
GetEventNumber (returnClarion event number) .................................................484
GetEventString (return event/action pairs) ......................................................... 485

WEB FILES CLASS 487

Overview 489
WebFilesClass Concepts ......................................................................................489
Relationship to Other Internet Builder Classes ................................................... 489
Internet Connect Template Implementation .........................................................489
Source Files..........................................................................................................490
WebFilesClass Methods 491
Functional Organization—Expected Use ............................................................491
GetAlias (return HTML alias for file) .................................................................492
GetDirectory (return temporary folder name) .....................................................493
GetFilename (return temporary file pathname) .................................................. 494
GetProgramRef (return HTML program reference) ........................................... 495
GetPublicDirectory (return public folder name) ................................................. 496
GetRelativeFilename (return filename for Broker) .............................................498
GetSeparateSecure (return web server security support).................................... 499
GetTempFilename (return filename for Server) ................................................. 500
Init (initialize the WebFilesClass object) .............................................................501
Kill (shut down the WebFilesClass object)..........................................................502
LoadImage (return linked image filename) ........................................................ 503
RemoveAll (remove temporary files and folders) .............................................. 504
SelectTarget (set public or secure channel) .........................................................505

LAYOUT HTML CLASS 507

Overview 509
LayoutHtmlClass Concepts ................................................................................ 509
Relationship to Other Internet Builder Classes ................................................... 509
Internet Connect Template Implementation .........................................................510
Source Files..........................................................................................................510
Conceptual Example ............................................................................................510
LayoutHtmlClass Properties 511
SnapX (horizontal grid snap) .............................................................................. 511
SnapY (vertical grid snap) .................................................................................. 511
Style (HTML table style) .....................................................................................511
LayoutHtmlClass Methods 512
Functional Organization—Expected Use ............................................................512
CreateHtml (generate HTML table) ....................................................................513
Init (initialize the LayoutHtmlClass object) ........................................................514

Insert (add control to layout process) ..................................................................515

Kill (shut down the LayoutHtmlClass object) .....................................................516
SetCell (set current control/cell) ......................................................................... 517
SUBMIT ITEM CLASS 519
Overview 521
SubmitItemClass Concepts ..................................................................................521
Relationship to Other Internet Builder Classes ................................................... 521
Internet Connect Template Implementation .........................................................521
Source Files..........................................................................................................521
SubmitItem Properties 522
Event (event number) ...........................................................................................522
Extra (other event information)............................................................................522
Feq (control number) ...........................................................................................522
Name (new control contents) .............................................................................. 523
NewValue (new control contents) ....................................................................... 523
SubmitItem Methods 524
Reset (set SubmitItem properties)....................................................................... 524

HTML CLASS 525

CreateOpen (start new HTML page) .................................................................. 535

GetFontChanged (return font changed flag) ........................................................536
GetFontStyle (return HTML STYLE string) .......................................................537
GetPixelsX (convert horizontal dialog units to pixels) ........................................538
GetPixelsY (convert vertical dialog units to pixels) ............................................539
GetControlReference (return control HREF) ......................................................540
Init (initialize the HtmlClass object) ................................................................... 541
Kill (shut down the HtmlClass object)................................................................ 541
PopFont (restore pre-PushFont font) .................................................................. 542
PushFont (set current font) ................................................................................. 543
TakeNewControl (set first control) ......................................................................544
WriteAppletDimParameter (write Java applet dim parameter) .......................... 545
WriteAppletFilenameParameter (write Java applet filename parameter) ............546
WriteAppletFontParameter (write Java applet font parameter) .......................... 547
WriteAppletFooter (end Java applet) ...................................................................548
WriteAppletHeader (begin Java applet) ...............................................................549
WriteAppletOptParameter (write Java applet parameter) ....................................550
WriteAppletParameter (write Java applet parameter)..........................................551
WriteAppletUAID (write Java applet unique Id) .................................................552
WriteChildAppletFooter (end child Java applet) .................................................553
WriteChildAppletHeader (begin child Java applet) ............................................ 554
WriteContainerAppletHeader (begin container applet) ...................................... 555
WriteControlFooter (end HTML control)........................................................... 556
WriteControlHeader (begin HTML control) ...................................................... 556
WriteEventHandler (write HTML control accepted action) ............................... 557
WriteFontFooter (end HTML font) .................................................................... 559
WriteFontHeader (begin HTML font) .................................................................559
WriteFormFooter (end HTML FORM) .............................................................. 560
WriteFormHeader (begin HTML FORM) ...........................................................560
WriteJavaScript (write shared JavaScript functions) ...........................................561
WriteOnFocusHandler (write HTML control selected action) ............................562
WriteRefreshTimer (write HTML timer refresh) ................................................563
WriteSpace (write HTML space) .........................................................................564
WriteSubmitApplet (write Java applet coordinator) ........................................... 565
WriteTableFooter (end HTML TABLE) .................................................................. 566
WriteTableHeader (begin HTML TABLE) .............................................................. 566
WriteTableNewCol (begin HTML TABLE CELL) .............................................567
WriteTableNewRow (begin HTML TABLE ROW) ................................................ 567
WriteText (write breakable text string) ................................................................568

TEXT OUTPUT CLASS 569

Overview 571
TextOutPutClass Concepts ..................................................................................571
Relationship to Other Internet Builder Classes ................................................... 571
Internet Connect Template Implementation .........................................................571
Source Files..........................................................................................................571
TextOutputClass Methods 572
Functional Organization—Expected Use ............................................................572
Close (close the file) ........................................................................................... 573
CreateOpen (create and open the file) .................................................................574
GetSize (return file size) ......................................................................................575
Open (open the file) .............................................................................................576
Write (write text) ................................................................................................ 577
Writeln (write text and newline marker)..............................................................578

HTTP CLASSES 579

GetServerProperty (return outgoing http information) ........................................595

Init (initialize the HttpClass object) .....................................................................596
Kill (shut down the HttpClass object) ..................................................................596
PreparePage (prime ServerInfo for next transmission) ...................................... 597
PreparePageForBrowser (prime ServerInfo for HTML transmission) ............... 598
PreparePageForJava (prime ServerInfo for JSL transmission) ...........................599
PrepareUnauthorized (prime ServerInfo for password challenge) ......................600
ProcessHeader (process incoming http) .............................................................. 601
SendCookies (update cookies on client) ..............................................................601
SetBrowserProperty (set browser property) ....................................................... 602
SetCookie (set cookie value) .............................................................................. 603
SetProgName (set server name) ...........................................................................604
SetProcName (set protected area name) ............................................................. 605
SetServerProperty (set outgoing http item) ........................................................ 606
HttpPageBaseClass Properties 607
ExpireDateTime (transmission expiration timestamp) ........................................607
FileHandler (TextOutputClass object) .................................................................607
FileLen (transmission size) ................................................................................. 608
GotHtmlBody (http only transmission) ...............................................................608
HtmlFilename (HTML/JSL transmission file) ....................................................609
Http (HttpClass object) ........................................................................................609
NowDateTime (transmission timestamp) ............................................................610
PageFilename (entire transmission file) ..............................................................610
Status (status of Client request) .......................................................................... 611
HttpPageBaseClass Methods 612
Functional Organization—Expected Use ............................................................612
AppendDefaultBody (supply default HTML) .....................................................613
FinishPage (prepend http to outgoing transmission) ...........................................614
HandleStatusCode (process status code) .............................................................615
Init (initialize the HttpPageBaseClass object) .....................................................616
Kill (shut down the HttpPageBaseClass object) ................................................. 617
PreparePage (set outgoing http items) ................................................................ 617
PreparePageBody (virtual to set outgoing http items) ........................................ 618
SetupHttpStatus (set outgoing http status indicators) ..........................................619
WritePageBody (write outgoing http body)........................................................ 620

INDEX 621
CONTENTS 21
26 IBC LIBRARY REFERENCE
FOREWORD 27

FOREWORD

Welcome to the Clarion Internet Builder Class (IBC) Library Reference!

This book is designed to be your every day reference to Clarion’s IBC
Library. Your only contact with the IBC Library may be through Clarion’s
Internet Templates. However, if you want to dig deeper and tweak your web-
enabled applications, or take complete control of the HTML code generation
process, then this is the book for you.

Once you’ve become familiar with the Clarion’s Internet Templates through
the Internet Application Guide, you may need more information on the finer
points of the Internet Builder Class properties and methods that the
templates rely on.

That’s why we created this reference. This reference provides in-depth

discussions of the IBC Library. It shows you how the IBC Templates use the
powerful IBC Library objects—and how you can use, reuse, and modify the
IBC Library within your hand-coded project.
28 IBC LIBRARY REFERENCE
CHAPTER 1 INTERNET BUILDER CLASSES 29

INTRODUCTION

About This Book 30

Clarion Internet Builder Classes 31
Class Libraries Generally.......................................................................................31
Internet Builder Classes—The IBC Library ..........................................................31
Using the IBC Library ...........................................................................................32
Internet Connect Terms and Concepts .................................................................. 32
Internet Builder Class Synopsis ............................................................................ 35
Internet Builder Class Header Files .......................................................................36
Internet Connect Templates and the IBC Library ................................................. 36
Documentation Conventions 37
Reference Item Formats and Syntax Diagrams .....................................................37
Property (short description of intended use) ......................................................... 37
Method (short description of what the method does) ............................................38
30 IBC LIBRARY REFERENCE

About This Book

The IBC Library Reference describes the Internet Builder Class (IBC)
Library used for Internet Connect applications.

The Internet Builder Classes are designed to “Web-enable” Clarion

applications. In effect, the IBC Library turns your Clarion application into a
dynamic HTML code generator that duplicates its Windows operation
through any Java-enabled Web browser. That’s right; your fully functional
Windows application can be run through any Java-enabled browser,
including those running on Unix, Sun, O/S2, and Macintosh operating
systems.

The IBC Library Reference describes how this takes place, by providing an
overview of each class or related group of classes. It provides specific
information on the public properties and methods of each class, plus
examples for using them. It also shows you the source files for each class and
describes the relationships between the classes.
CHAPTER 1 INTERNET BUILDER CLASSES 31

Clarion Internet Builder Classes

Class Libraries Generally

The purpose of a class library in an Object Oriented system is to help

programmers work more efficiently by providing a safe, efficient way to
reuse pieces of program code. In other words, a class library should relieve
programmers of having to write certain routines by letting them use already
written generic routines to perform common or repetitive program tasks.

In addition, a class library can reduce the amount of programming required

to implement changes to an existing class based program. By deriving
classes that incrementally add to or subtract from the classes in the library,
programmers can accomplish substantial changes without having to rewrite
the base classes or the programs that rely on the base classes.

Internet Builder Classes—TheIBCLibrary

Typical Reusability and Maintainance Benefits

The Internet Builder Classes (IBC Library) provide all the benefits of class
libraries in general. Plus, the Internet Connect Templates automatically
generate code that uses and reuses the robust, flexible, and solid (pre-tested)
objects defined by the IBC Library. Further, the templates are designed to
help you easily derive your own classes from the Internet Builder Classes.

Of course, you need not use the templates to use the Internet Builder Classes.
However, the template generated code certainly provides appropriate
examples for using the IBC Library in hand coded programs. Either way, the
bottom line for you is more powerful programs with less coding.

IBC Library Scope and Purpose

The Internet Builder Classes have a fairly specific focus or scope. That is, its
objects are designed to “Web-enable” a Clarion application. In effect, the
Internet Builder Classes turn your Clarion application into a dynamic
HTML code generator.

The IBC Library contains objects that

• Communicate with Java-enabled Web browsers through
SoftVelocity’s Application Broker
• Generate HTML equivalents to application WINDOWs
• Generate JSL data equivalents to application QUEUEs, USE
variables, etc.
• Accept and process browser generated events and requests
32 IBC LIBRARY REFERENCE

In summary, the IBC Libary supports Web-enabled Windows

applications.

Using the IBCLibrary

Typically, the Server program (your Web-enabled application) calls only

a very few of the many IBC Library methods. These few methods call
all of the other IBC methods needed to accomplish their purpose. See IBC
Library Quick Reference in the Internet Connect User’s Guide for more
information on this short list of IBC primary interface methods.

Internet Connect Terms and Concepts

Key Terms

Server Your Web-enabled Clarion application, which

generates HTML code to represent each of your
application’s windows and reports, and receives and
processes Client generated events.

Client The Java-enabled browser program (such as Internet

Explorer, Netscape Navigator, or Communicator),
which receives and displays the Server generated
HTML, then dispatches new requests.

Broker SoftVelocity’s Application Broker, which handles all

communications between the Client and the Server.
That is, the Client and Server do not directly
communicate with each other; each communicates
only with the Broker.

Java Support Library (JSL)

SoftVelocity provides a Java Support Library with
each Internet Connect license. This small library of
Java objects supports Windows-like controls for the
HTML pages generated by the Server. The library
must reside on the Client computer and is
automatically downloaded by the Application
Broker the first time the Client references a library
object. The Library is downloaded as a cabinet
(.CAB) file, an archive file (.ZIP), or as individual
object files, depending on the Client’s browser.
CHAPTER 1 INTERNET BUILDER CLASSES 33

This book uses these terms as defined here. That is, Server always refers
to a Web-enabled Clarion application; Client refers to the Java-enabled
browser that is controlling the Server; and Broker refers to the
Application Broker that routes messages between the Client and Server.

The IBC Library contains a class to represent each of these real-world

objects (WebServerClass, BrokerClass, WebClientManagerClass,
JSLManagerClass). This book uses WebServerClass, BrokerClass,
WebClientManagerClass, JSLManagerClass, etc. to refer to discrete
executable objects within the Server program.

Key Concepts

Internet Connect succeeds by using the Broker (SoftVelocity’s Application

Broker) to maintain a persistent communication between the Client (internet
browser) and the Server (Web-enabled Clarion application) over an internet
connection. The Client generates requests for the Server to process, and the
Server generates HTML code in response to the Clients’ requests. The
Broker routes Client requests to the appropriate Server, and routes Server
generated HTML code to the Client that requested it.

One very important point to remember is that the Server cannot initiate any
action on the Client. In the Internet context, the Client initiates Server
activity by sending something to the Server. The Client may send a request
for more information, or it may send data entered by the end user, or both.
The Server responds to the Client request, typically by generating and
sending more HTML code. The generated HTML code is structured so that
end user manipulation of the HTML controls sends additional requests to the
Server.

The relationship between Client, Server, and Broker may be represented as

shown in the following diagram.
34 IBC LIBRARY REFERENCE

Client n

Client 2

Client
Any Java-enabled Web
Browser

Workstation
(Windows, OS/2, UNIX, etc.)

Request
Internet/

HTML
Intranet

Application Broker
Routes traffic between
Client and Server

Request
HTML

Web Server Server

Any Web-enabled Clarion
Application

Server 2

Server n

Web
Web Web
Broker Client
Window Server
Class Manager
Class Class
object Class
object object
object
CHAPTER 1 INTERNET BUILDER CLASSES 35

Internet Builder Class Synopsis

Following is a brief description of the functions and purposes of the main

Internet Builder Classes. The Server (your Web-enabled Clarion
application) program uses these classes to receive and respond to Client
requests through the Broker (SoftVelocity’s Application Broker). The
Server need not explicitly instantiate all these classes because some of the
classes are instantiated by the other classes as needed.

BrokerClass

The BrokerClass communicates with the Application Broker. It relies on the

WebClientManagerClass

The WebClientManagerClass helps the WebWindowClass generate

appropriate HTML code and JSL data by providing accurate information
about the Client’s browser. The WebClientManagerClass contains current
information about the Client Web browser, Java Support Library, and IP
address. The WebClientManagerClass also communicates with the
BrokerClass on behalf of the WebWindowClass. The BrokerClass
instantiates and manages a single WebClientManagerClass object.

WebServerClass

The WebServerClass establishes a communication channel with the

Application Broker and handles the information coming through the channel,
including information such as new page requests and value-to-field
assignments forwarded from the Client’s browser. The WebServerClass’s
primary job is to decode requests (submit strings) that come from the Client
through the Appication Broker. Typically, the Server instantiates a single
global WebServerClass object.

WebWindowClass

The WebWindowClass “translates” a Clarion WINDOW to its HTML

equivalent, control by control, and uses the WebServerClass to process
requests (submit strings) that come from the Client through the Appication
Broker. This class contains a variety of properties that control how the
Clarion to HTML translation is accomplished. For example it contains
properties to specify background, menu, toolbar, and client area colors, as
well as the action to take for disabled controls, etc. Typically, the Server
36 IBC LIBRARY REFERENCE

instantiates a local WebWindowClass object for each WINDOW you

want to display on the Client.

Other Classes

There are several other classes in the IBC Library that help these main
classes accomplish their objectives. All of these Internet Builder Classes are
documented in the remainder of this book.

Internet Builder ClassHeader Files

Including the right files in your program’s data section

Many of the class declarations directly reference other classes. To resolve

these references, each class header (.INC file) INCLUDEs only the headers
containing the directly referenced classes. This convention maximizes
encapsulation, minimizes compile times, and ensures that all necessary
components are present for the make process. We recommend you follow
this convention too.

A good rule of thumb is to INCLUDE as little as possible. The compiler will

let you know if you have omitted something.

Including the right files in your project

If you use the Internet Connect Templates, they automatically add the
appropriate files to your project. However, if you hand code your program
you must manually add some files to your project. See the Hand Coded
Programs in the Internet Connect User’s Guide for more information.

Internet ConnectTemplatesandtheIBCLibrary

The Internet Connect Templates rely heavily on the Internet Builder Classes.
However, the templates are highly configurable and are designed to let you
substitute your own class definitions if you wish. See Internet Builder Class
Templates—Classes in the Internet Connect User’s Guide for more
information on configuring the global level interaction between the Internet
Connect Templates and the IBC Library. See Internet Builder Class
Templates—Classes in the Internet Connect User’s Guide for more
information on configuring the IBC Library for individual controls.
CHAPTER 1 INTERNET BUILDER CLASSES 37

Documentation Conventions
Reference Item Formats and Syntax Diagrams

Each Clarion programming language element referenced in this manual is

printed in UPPER CASE letters.

Each Hyper-Text Markup Language (HTML) element referenced in this

manual is printed in <UPPER CASE> letters surrounded by angle brackets.

Class Properties (data types and structures) occur at the beginning of a

chapter, followed by Class Methods (functions and procedures) at the end.
Methods are generally documented in alphabetical order rather than logical
order.

The documentation formats for Properties and Methods are illustrated in the
following syntax diagrams:

Property (short descriptionof intendeduse)

Property Datatype, ATTRIBUTES
A complete description of the Property and its uses.

Datatype shows the datatype of the property such as LONG or

&BrowseClass.

Attributes shows any significant Clarion attributes such as PROTECTED.

Implementation: A discussion of specific implementation issues. The implementation may

change with each release / version of Internet Connect.
ComplexDataType STRUCTURE !actual structure declaration
END

SeeAlso: Related Methods and Properties

38 IBC LIBRARY REFERENCE

Method (short description of what the method does)

Method A brief statement of what the method does.

parameter1 A complete description of parameter1, along with how it
relates to parameter2 and the Method.
parameter2 A complete description of parameter2, along with how it
relates to parameter1 and the Method. Because it is
enclosed in brackets, [ ], it is optional, and may be
omitted.
A concise description of what the Method does. Sometimes a Method has no
parameters.

Attributes shows any significant Clarion attributes such as VIRTUAL or

PROTECTED.

Return DataType: The data type returned.

Implementation: A description of how the method currently accomplishes its objective. The
implementation may change with each release / version of Clarion.

Example:
FieldOne = FieldTwo + FieldThree !This is a source code example
FieldThree = Method(FieldOne,FieldTwo) !Comments follow the “!” character

SeeAlso: Related Methods and Properties

CHAPTER 2 BROKER CLASS 39

BROKER CLASS

Overview 41
BrokerClass Concepts ............................................................................................41
Relationship to Other Internet Builder Classes ..................................................... 41
Internet Connect Template Implementation ...........................................................42
Source Files............................................................................................................42
Conceptual Example ..............................................................................................43
BrokerClass Properties 44
Client (WebClientManagerClass object) .............................................................. 44
Http (HttpClass object) ..........................................................................................44
Files (WebFilesClass object) ................................................................................ 45
ServerName (server identifier) ..............................................................................45
BrokerClass Methods 46
Functional Organization—Expected Use ..............................................................46
CloseChannel (close channel to application broker) .............................................47
GetAuthorizedInfo (get client password) ..............................................................48
GetClient (return WebClientManagerClass object) ...............................................49
GetRequestArguments (return browser request) .................................................. 50
Init (initialize the BrokerClass object) .................................................................. 51
Kill (shut down the BrokerClass object) ............................................................... 52
OpenChannel (open channel to application broker) ............................................. 53
ProcessHttpHeader (process incoming http)..........................................................54
SetClient (set client information) .......................................................................... 55
SetClientBrowser (set browser information) ........................................................ 55
TakeFile (send HTML code or JSL data)...............................................................56
TakeHtmlPage (prepare and send HTML code) ....................................................57
TakeJslData (prepare and send JSL data) ..............................................................58
TakeUnauthorized (prepare and send access denied page)....................................59
40 IBC LIBRARY REFERENCE
CHAPTER 2 BROKER CLASS 41

Overview
If you have not already done so, please take a moment to read Internet
Connect Terms and Concepts in the preceding chapter. This short topic
contains information and terms that are prerequisite to the following
material.

BrokerClassConcepts

The BrokerClass communicates with the Application Broker. It relies on the

HttpClass to receive and process (parse) Client requests, and to forward the
responses prepared by the WebWindowClass to the Client, through the
Application Broker. The responses may include HTML code, data for Java
applets (JSL data), graphic images (.JPG, .GIF, etc.), or any other
information requested by the Client. Typically, the Server instantiates a
single global BrokerClass object. The Server typically instantiates a single
global BrokerClass object that does the following fundamental things to aid
this transmission of information:
• Records the instance number or handle of the Server
• Records the IP address of the Client that started this Server
instance
• Records the directory paths that contain files shared with the
Client
• Records the type of browser the Client is running
• Establishes a communication channel to the Application Broker
Most of the recorded information is supplied by the Application Broker
when it starts the Server application. With this information, the Server can
identify itself, its client, and the location of any shared files when it
communicates with the Application Broker.

Relationship toOther Internet Builder Classes

InternetDataSinkClass

The BrokerClass is derived from the InternetDataSinkClass. The

InternetDataSinkClass methods don’t do anything; they are simply
placeholders. The InternetDataSinkClass does provide a generic reference
for all of its derived classes.

HttpClass

The BrokerClass uses the HttpClass to process incoming and outgoing HTTP
(Hyper-Text Transfer Protocol) headers. HTTP is the protocol that web
42 IBC LIBRARY REFERENCE

servers use to transmit HTML pages to internet browsers. Conversely,

internet browsers use HTTP to transmit their requests to web servers.

WebClientManagerClass

The BrokerClass uses the WebClientManagerClass to supply information

about the client’s browser and IP address.

WebFilesClass

The BrokerClass uses the WebFilesClass to locate and identify files shared
with the client.

If your program uses the BrokerClass, it also needs these other classes. See
the Conceptual Example for more information.

Internet ConnectTemplate Implementation

The Internet Connect Templates generate code to instantiate a single global

BrokerClass object for your web-enabled application. The BrokerClass
object is called Broker. Except for theBroker initialization and termination,
the template generated code does not reference the Broker object; all other
references to the Broker object are handled by other IBC Library objects.

SourceFiles

The BrokerClass source code is installed by default to the \LIBSRC folder.

The specific BrokerClass files and their respective components are:

[Link] BrokerClass declarations

[Link] BrokerClass method definitions

CHAPTER 2 BROKER CLASS 43

Conceptual Example

The following example shows a typical sequence of statements to declare,

instantiate, initialize, use, and terminate a BrokerClass object and related
objects.
MyWebPgm PROGRAM

LinkBaseClasses EQUATE(1)
BaseClassDllMode EQUATE(0)
INCLUDE('[Link]') !declare TextOutputClass
INCLUDE('[Link]') !declare WebBrokerClass
INCLUDE('[Link]') !declare WebWindowClass
INCLUDE('[Link]') !declare WebClientManagerClass
INCLUDE('[Link]') !declare WebReportClass
INCLUDE('[Link]') !declare Internet EQUATEs
MAP
INCLUDE('[Link]') !declare Internet helper procedures
END
!data declarations
Broker BrokerClass !declare Broker object
HtmlManager HtmlClass !declare HtmlManager object
JavaEvents JslEventsClass !declare JslEvents object
WebServer WebServerClass !declare WebServer object
WebFilesManager WebFilesClass !declare WebFilesManager object

ICServerWin WINDOW,AT(-100,-100,0,0) !declare an invisible

window END
CODE
[Link](1, '') !initialize WebFilesManager object
[Link] !initialize JavaEvents object
[Link]('TREE', WebFilesManager) !initialize Broker object
[Link](WebFilesManager) !initialize HtmlManager object
[Link](Broker,,600,,WebFilesManager) !initialize WebServer object
IF ([Link]()) !if launched by App Broker
OPEN(ICServerWin) !open invisible window
ACCEPT
IF (EVENT() = EVENT:OpenWindow)
[Link] !set up communication w/ App Broker
Main !run as usual
BREAK
END
END
ELSE !if not launched by App Broker
Main !run as usual
END
[Link] !shut down WebServer object
[Link] !shut down HtmlManager object
[Link]() !shut down Broker object
[Link] !shut down JavaEvents object
[Link] !shut down WebFilesManager object
44 IBC LIBRARY REFERENCE

BrokerClass Proper ties

The BrokerClass contains the properties listed below.

Client (WebClientManagerClassobject)
Client &WebClientManagerClass, PROTECTED
The Client property is a reference to the WebClientManagerClass object that
supplies information about the client’s browser and IP address.

This property is PROTECTED, therefore, it can only be referenced by a

BrokerClass method, or a method in a class derived from BrokerClass.

Implementation: The Init method calls the SetClient method to instantiate a

WebClientManagerClass object for this BrokerClass object.

SeeAlso: Init, SetClient

Http (HttpClassobject)
Http &HttpClass
The Http property is a reference to the HttpClass object that processes
incoming and outgoing HTTP headers.

Implementation: The Init method instantiates an HttpClass object for this BrokerClass object.

SeeAlso: Init
CHAPTER 2 BROKER CLASS 45

Files(WebFilesClassobject)
Files &WebFilesClass
The Files property is a reference to the WebFilesClass object that locates and
identifies files shared with the client’s browser.

Implementation: The Init method sets the initial value of the Files property.

SeeAlso: Init

ServerName (server identifier)

ServerName CSTRING(255), PROTECTED
The ServerName property uniquely identifies this instance of the Server
(Web-enabled application). The BrokerClass object uses the ServerName
property to uniquely identify the Server when communicating with the
Application Broker.

This property is PROTECTED, therefore, it can only be referenced by a

BrokerClass method, or a method in a class derived from BrokerClass.

Implementation: The Init method sets the value of the ServerName property. The Application
Broker supplies the ServerName value when it launches the Server program.

SeeAlso: Init
46 IBC LIBRARY REFERENCE

BrokerClass Methods
The BrokerClass contains the methods listed below.

Functional Organization—ExpectedUse

As an aid to understanding the BrokerClass, it is useful to organize its

methods into two categories according to their expected use—the primary
interface and the virtual methods. This organization reflects what we believe
is typical use of these methods.

Primary Interface Methods

The primary interface methods, which you are likely to call fairly routinely
from your program, can be further divided into three categories:

Housekeeping (one-time) Use:

Init initialize the BrokerClass object
Kill shut down the BrokerClass object

Mainstream Use:

Occasional Use:
CloseChannel close channel to application broker
GetAuthorizedInfo get client password
GetClient return WebClientManagerClass object
GetRequestArguments return browser request
OpenChannel open channel to application broker
ProcessHttpHeader process incoming http
SetClient set client information
SetClientBrowser set browser information

Virtual Methods

Typically you will not call these methods directly—the Primary Interface
methods call them. However, we anticipate you will often want to override
these methods, and because they are virtual, they are very easy to override.
These methods do provide reasonable default behavior in case you do not
want to override them.

TakeFile send HTML code or JSL data to client

TakeHtmlPage prepare and send HTML code
TakeJslData prepare and send JSL data
TakeUnauthorized prepare and send access denied page
CHAPTER 2 BROKER CLASS 47

CloseChannel (closechannel to applicationbroker)

CloseChannel
The CloseChannel method closes the communication channel to the
Application Broker. The communication channel is established by the
OpenChannel method.

Example:
[Link] PROCEDURE
CODE
[Link] !close communication channel
IF (NOT ([Link] &= NULL))
[Link]
DISPOSE([Link])
END
IF (NOT [Link] &= NULL)
[Link]
DISPOSE([Link])
END

SeeAlso: OpenChannel
48 IBC LIBRARY REFERENCE

GetAuthorizedInfo (getclient password)

GetAuthorizedInfo( area, userid, password )

GetAuthorizedInfoGets the client’s userid and password.

area A string constant, variable, EQUATE, or expression
containing the name or description of the restricted Web
page.
userid A string variable to receive the client userid.
password A string variable to receive the client password.
The GetAuthorizedInfo method gets the client’s userid and password. Your
program can verify the contents of the userid and password before
proceeding.

When it demands a password, the client browser displays the contents of the
area parameter to the end-user. By default, this value comes from the
[Link] property.

Implementation: The GetAuthorizedInfo method relies on the HttpClass object to supply the
userid and password.

Example:
[Link] PROCEDURE
Password STRING(255)
UserName STRING(255)
CODE
[Link]([Link], UserName, Password)
RETURN [Link](UserName, Password)

SeeAlso: [Link], [Link],

[Link], [Link]
CHAPTER 2 BROKER CLASS 49

GetClient (returnWebClientManagerClassobject)
GetClient, WebClientManagerClass
The GetClient returns a reference to the WebClientManagerClass object for
this BrokerClass object. The WebClientManagerClass object supplies
information about the client browser.

Implementation: The GetClient method calls the SetClient method to instantiate the
BrokerClass’ WebClientManagerClass object.

Return DataType: WebClientManagerClass

Example:
[Link] PROCEDURE(*BrokerClass Broker,SIGNED TimeOut,WebFilesClass Files)

ServerName CSTRING(255)
StartIndex SIGNED
EndIndex SIGNED

CODE
[Link] &= NEW SubmitItemClass
[Link] &= Broker
[Link] &= [Link]() !set reference to Client info
!etc.

SeeAlso: SetClient
50 IBC LIBRARY REFERENCE

GetRequestArguments (return browser request)

GetRequestArguments, STRING
The GetRequestArguments returns a browser request string from the
Client.

Implementation: The GetRequestArguments method relies on the HttpClass object to supply

the browser request arguments. The requests come from the HTTP Hyper-
Text Transfer Protocol) the Client browser transmits to the Server (your Web-
enabled application) through the Application Broker.

Return DataType: STRING

Example:
[Link] PROCEDURE

Header EQUATE('Internet:')
CmdRequest EQUATE('Request')
HttpStart UNSIGNED
LenHeader SIGNED
LenCmdRequest SIGNED
LenCmd SIGNED
Request ANY
CODE
IF ([Link])
CASE EVENT()
OF EVENT:DDEexecute
Request = DDEvalue()
LenHeader = LEN(Header)
LenCmdRequest = LEN(CmdRequest)
LenCmd = LenHeader + LenCmdRequest
HttpStart = INSTRING(NewLine,Request,1,LenCmd+2)+2
[Link](SUB(Request,HttpStart,LEN(Request)-HttpStart))

[Link] = [Link]() !get Client browser request

SeeAlso: [Link]
CHAPTER 2 BROKER CLASS 51

Init (initialize theBrokerClassobject)

Init( program, WebFilesClass )

Init Initializes the BrokerClass object.

program A string constant, variable, EQUATE, or expression
containing the program name.
WebFilesClass The label of the WebFilesClass object that locates and
identifies files shared with the client browser.
The Init method initializes the BrokerClass object.

The BrokerClass uses the program value when communicating with the
client browser, for example to identify the program for processing cookies or
when demanding password authorization.

Implementation: The Init method records the client IP address, the Web-application’s instance
number, and calls the SetClient method to record information about the
client’s specific Web browser.

The Init method passes the program parameter to the HttpClass object to
supply to the client browser as needed.

Example:
!data declarations
CODE
[Link](1, '') !initialize WebFilesManager object
[Link] !initialize JavaEvents object
[Link]('TREE', WebFilesManager) !initialize Broker object
[Link](WebFilesManager) !initialize HtmlManager object
[Link](Broker,,600,,WebFilesManager) !initialize WebServer object
IF ([Link]()) !if launched by App Broker
OPEN(ICServerWin) !open invisible window
ACCEPT
IF (EVENT() = EVENT:OpenWindow)
[Link] !set up communication w/ App Broker
Main !run as usual
BREAK
END
END
ELSE !if not launched by App Broker
Main !run as usual
END
[Link] !shut down WebServer object
[Link] !shut down HtmlManager object
[Link]() !shut down Broker object
[Link] !shut down JavaEvents object
[Link] !shut down WebFilesManager object

SeeAlso: SetClient, [Link]

52 IBC LIBRARY REFERENCE

Kill (shut down theBrokerClassobject)

Kill
The Kill method frees any memory allocated during the life of the object and
performs any other required termination code.

OpenChannel (openchannel toapplicationbroker)

OpenChannel, BYTE
The OpenChannel method opens a communication channel to the
Application Broker and returns a value indicating its success of failure. A
return value of zero (0) indicates the channel is not established; any other
value indicates the identity or handle of the channel.

The communication channel is dedicated to communications between the

Application Broker and a single instance of the Server (Web-enabled
application).

The CloseChannel method closes the channel established by the

OpenChannel method.

Return DataType: BYTE

Example:
[Link] PROCEDURE
CODE
[Link] = [Link]()
IF ([Link])
IC:InitializeHooks
END

SeeAlso: CloseChannel
54 IBC LIBRARY REFERENCE

ProcessHttpHeader (processincominghttp)
ProcessHttpHeader( http )

ProcessHttpHeader
Processes the Hyper-Text Transfer Protocol (HTTP)
stream prepended to transmissions from the client
browser.
http A string constant, variable, EQUATE, or expression
containing the http to process.
The ProcessHttpHeader method processes the Hyper-Text Transfer
Protocol (HTTP) stream prepended to transmissions from the client browser.

Implementation: The ProcessHttpHeader method relies on the HttpClass object to process the
http stream.

Example:
[Link] PROCEDURE
Header EQUATE('Internet:')
CmdRequest EQUATE('Request')
HttpStart UNSIGNED
LenHeader SIGNED
LenCmdRequest SIGNED
LenCmd SIGNED
Request ANY
CODE
IF ([Link])
CASE EVENT()
OF EVENT:DDEexecute
Request = DDEvalue()
LenHeader = LEN(Header)
LenCmdRequest = LEN(CmdRequest)
LenCmd = LenHeader + LenCmdRequest
HttpStart = INSTRING(NewLine,Request,1,LenCmd+2)+2
[Link](SUB(Request,HttpStart,LEN(Request)-HttpStart))
[Link] = [Link]()
[Link] &= [Link]()
[Link] = CLOCK()
IF (NOT [Link])
RETURN NET:Unknown
END
IF (SUB([Link], 1, 1) = '@')
[Link] = SUB([Link],2,-1)
END
IF ([Link])
[Link] = [Link] & '&'
END
[Link] = 1
RETURN NET:Request
END
END
RETURN NET:Unknown

SeeAlso: [Link]
CHAPTER 2 BROKER CLASS 55

SetClient (set client information)

SetClient
The SetClient method records information about the Client.

Implementation: The SetClient method instantiates a WebClientManagerClass object if

necessary, then calls the SetClientBrowser method to identify the Client Web
browser.

Example:
[Link] PROCEDURE(STRING ProgramName, WebFilesClass Files)
CODE
[Link](BROWSER:IE30, TRUE, FALSE)
[Link](BROWSER:IE40, TRUE, FALSE)
[Link](BROWSER:NetScape3, FALSE, TRUE)
[Link] = TRUE
[Link](BROWSER:Mozilla4, FALSE, TRUE)
[Link] = TRUE
[Link](BROWSER:Unknown, FALSE, FALSE)
[Link] = IC:GetCommandLineOption('/inet=')
[Link] &= Files
[Link] &= NEW HttpClass
[Link](Files)
[Link](ProgramName)
[Link] !set Client information
[Link] = IC:GetCommandLineOption('/client=')

SeeAlso: SetClientBrowser

SetClientBrowser (set browser information)

SetClientBrowser, PROTECTED
The SetClientBrowser method records information about the Client’s Web
browser.

This method is PROTECTED, therefore, it can only be called by a

BrokerClass method, or a method in a class derived from BrokerClass.

Implementation: The SetClientBrowser method notes the Client’s specific type of Web
browser (Netscape, Internet Explorer, etc.), its version number, and the
facilities it supports, such as caching, java, style sheets, etc.

Example:
[Link] PROCEDURE
CODE
IF ([Link] &= NULL)
[Link] &= NEW WebClientManagerClass
[Link](SELF, UnknownBrowser)
END
[Link]
56 IBC LIBRARY REFERENCE

TakeFile (sendHTML codeor JSLdata)

TakeFile( filename, secure, immediate ), VIRTUAL

TakeFile Requests the Application Broker to transmit HTML code

or JSL data to the Client browser.
filename A string constant, variable, EQUATE, or expression
naming the file containing the HTML code or JSL data
to transmit.
secure An integer constant, variable, EQUATE, or expression
indicating whether to transmit over a secure channel or
public channel. A value of Secure:Full indicates a secure
channel; a value of Secure:None indicates a public
channel; and a value of Secure:Default indicates the
default channel.
immediate An integer constant, variable, EQUATE, or expression
indicating whether to immediately transmit the informa-
tion or to hold the transmission until the browser re-
quests the information. A value of one (1 or True) does
an immediate transmit, which is appropriate for JSL
data. A value of zero (0 or False) forces the browser to
make a subsequent request for a new page, which is
appropriate for HTML code.
The TakeFile method requests the Application Broker to transmit HTML
code or JSL data to the Client browser.

TakeFile is a VIRTUAL method so that other base class methods can directly
call the TakeFile virtual method in a derived class. This lets you easily
implement your own custom version of this method.

Implementation: EQUATEs for the secure parameter are declared in [Link] as follows:
ITEMIZE,PRE(Secure)
Default EQUATE
None EQUATE
Full EQUATE
Last EQUATE(Secure:Full)
END

Example:
[Link] PROCEDURE(STRING Filename, SIGNED Security)

CODE
[Link](200, Filename)
[Link]()
[Link](Filename, Security, TRUE)
CHAPTER 2 BROKER CLASS 57

TakeHtmlPage(prepare andsendHTML code)

TakeHtmlPage( filename, secure, immediate ), VIRTUAL

TakeHtmlPage Prepares an HTML page then requests the Application

Broker to transmit the HTML to the Client browser.
filename A string constant, variable, EQUATE, or expression
naming the file containing the HTML code to transmit.
secure An integer constant, variable, EQUATE, or expression
indicating whether to transmit over a secure channel or
public channel. A value of Secure:Full indicates a secure
channel; a value of Secure:None indicates a public
channel; and a value of Secure:Default indicates the
default channel.
immediate An integer constant, variable, EQUATE, or expression
indicating whether to immediately transmit the informa-
tion or to hold the transmission until the browser re-
quests the information. A value of one (1 or True) does
an immediate transmit, which is appropriate for JSL
data. A value of zero (0 or False) forces the browser to
make a subsequent request for a new page, which is
appropriate for HTML code.
The TakeHtmlPage method prepares an HTML page then requests the
Application Broker to transmit the HTML to the client browser.

TakeHtmlPage is a VIRTUAL method so that other base class methods can

directly call the TakeHtmlPage virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: TakeHtmlPage uses the HttpClass object to prepend the appropriate HTTP to
the HTML, then calls the TakeFile method to transmit the whole package.

EQUATEs for the secure parameter are declared in [Link] as follows:

ITEMIZE,PRE(Secure)
Default EQUATE
None EQUATE
Full EQUATE
Last EQUATE(Secure:Full)
END

Example:
[Link] PROCEDURE |
(STRING Filename,SIGNED Security, BYTE dontmove=FALSE)
CODE
[Link](Filename, Security, dontmove)

SeeAlso: TakeFile
58 IBC LIBRARY REFERENCE

TakeJslData (prepare andsendJSLdata)

TakeJslData( filename, secure ), VIRTUAL

TakeJslData Prepares Java Support Library (JSL) data then requests

the Application Broker to transmit the JSL data to the
client browser.
filename A string constant, variable, EQUATE, or expression
naming the file containing the JSL data to transmit.
secure An integer constant, variable, EQUATE, or expression
indicating whether to transmit over a secure channel or
public channel. A value of Secure:Full indicates a secure
channel; a value of Secure:None indicates a public
channel; and a value of Secure:Default indicates the
default channel.
The TakeJslData method prepares Java Support Library (JSL) data then
requests the Application Broker to transmit the JSL data to the client
browser.

TakeJslData is a VIRTUAL method so that other base class methods can

directly call the TakeJslData virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: TakeJslData uses the HttpClass object to prepend the appropriate HTTP to
the JSL data, then calls the TakeFile method to transmit the whole package.

EQUATEs for the secure parameter are declared in [Link] as follows:

ITEMIZE,PRE(Secure)
Default EQUATE
None EQUATE
Full EQUATE
Last EQUATE(Secure:Full)
END

Example:
[Link] PROCEDURE(STRING Filename,SIGNED Security)
CODE
[Link](Filename, Security)

SeeAlso: TakeFile
CHAPTER 2 BROKER CLASS 59

TakeUnauthorized(prepare andsendaccessdeniedpage)
TakeUnauthorized( filename, secure ), VIRTUAL

TakeUnauthorized Prepares an “access denied” page then requests the

Application Broker to transmit the page to the client
browser.
filename A string constant, variable, EQUATE, or expression
naming the file containing the “access denied” page to
transmit.
secure An integer constant, variable, EQUATE, or expression
indicating whether to transmit over a secure channel or
public channel. A value of Secure:Full indicates a secure
channel; a value of Secure:None indicates a public
channel; and a value of Secure:Default indicates the
default channel.
The TakeUnauthorized method prepares an “access denied” page then
requests the Application Broker to transmit the page to the client browser.

TakeUnauthorized is a VIRTUAL method so that other base class methods

can directly call the TakeUnauthorized virtual method in a derived class.
This lets you easily implement your own custom version of this method.

Implementation: TakeUnauthorized uses the HttpClass object to prepend the appropriate

HTTP to the “access denied” page, then calls the TakeFile method to
transmit the whole package.

EQUATEs for the secure parameter are declared in [Link] as follows:

ITEMIZE,PRE(Secure)
Default EQUATE
None EQUATE
Full EQUATE
Last EQUATE(Secure:Full)
END

Example:
[Link] PROCEDURE(STRING Filename,SIGNED Security)
CODE
[Link](Filename, Security)

SeeAlso: TakeFile
60 IBC LIBRARY REFERENCE
CHAPTER 3 WEBSERVERCLASSES 61

WEB SERVER CLASSES

Overview 63
WebServerClass Concepts .....................................................................................63
ShutDownClass Concepts ......................................................................................63
Relationship to Other Internet Builder Classes ..................................................... 63
Internet Connect Template Implementation ...........................................................64
Source Files............................................................................................................64
Conceptual Example ..............................................................................................65
WebServerClass Properties 66
Active (server communicates with broker) ........................................................... 66
ArgIndex (index to browser request string) .......................................................... 66
Broker (BrokerClass object) ................................................................................. 66
CurSubmit (SubmitItemClass object) ....................................................................67
Client (WebClientManagerClass object) .............................................................. 67
CommandLine (command line parameters) ..........................................................68
DialogPageBackColor (MESSAGE page background color) ...............................68
DialogPageImage (MESSAGE page wallpaper) ...................................................68
DialogWinBackColor (MESSAGE window background color) ...........................68
DialogWinImage (MESSAGE window wallpaper) .............................................. 69
Files (WebFilesClass object) ................................................................................ 69
GotCommandLine (command line arguments set flag) ........................................ 69
JavaLibraryPath (Java Support Library location) ..................................................70
PageToReturnTo (return URL).............................................................................. 70
ProgramName (Server pathname) ........................................................................ 71
TimeOut (period of inactivity after which to shut down) ..................................... 71
WebServerClass Methods 72
Functional Organization—Expected Use ..............................................................72
Connect (establish communication with Application Broker) ...............................74
GetInternetEnabled (return Web/Windows mode) ................................................ 75
GetReadyForPage (return ready-to-continue flag) ................................................76
GetRequestedWholePage (return scope of browser request).................................77
GetSendWholePage (return full or partial refresh flag).........................................78
Halt (immediately shut down the Server) ............................................................. 79
Init (initialize the WebServerClass object) ............................................................80
Kill (shut down the WebServerClass object) .........................................................81
62 IBC LIBRARY REFERENCE

Quit (shut down the Server normally) ...................................................................82

SetDialogPageBackground (set MESSAGE Web page background) ....................83
SetDialogWinBackground (set MESSAGE Web page window background) .......84
SetSendWholePage (force full page refresh) ........................................................ 85
SetNewPageDisable (suppress outgoing Web pages) ............................................86
SetNextAction (return Web page field information) ..............................................87
TakeEvent (process WebServerClass object events) .............................................88
TakePageSent (prepare WebServerClass object for next page) .............................89
ShutDownClass Methods 90
Close (a virtual shut down the Web-enabled application) .....................................90
CHAPTER 3 WEBSERVERCLASSES 63

Overview
If you have not already done so, please take a moment to read Internet
Connect Terms and Concepts. This short topic contains information and
terms that are prerequisite to the following material.

WebServerClassConcepts

The WebServerClass establishes a communication channel with the

ShutDownClassConcepts

The WebServerClass uses the ShutDownClass to shut down other IBC

Library objects when the Server (Web-enabled application) undergoes a
normal shut down, including end user request and time outs.

Relationship toOther Internet Builder Classes

The WebServerClass uses the SubmitItemClass to do much of its work. That

is, the WebServerClass uses theSubmitItemClass to process information
from the Client’s browser.

The WebServerClass uses the ShutDownClass to shut down other IBC

Library objects when the Server (Web-enabled application) undergoes a
normal shut down, including end user request and time outs.

The WebServerClass also references the BrokerClass, the WebFilesClass,

and the WebClientManagerClass. Therefore, if your program uses the
WebServerClass, it also needs these other classes. See the Conceptual
Example for more information.

The WebWindowClass and the WebReportClass rely on the WebServerClass

to communicate with the Application Broker, to supply various pieces of
information (files and process status), and to process events related to
program timeouts and Application Broker communications.
64 IBC LIBRARY REFERENCE

Internet ConnectTemplate Implementation

The Internet Connect Templates generate code to instantiate a single global

WebServerClass object for your application program. The WebServerClass
object is called WebServer. The templates generate code to initialize the
WebServer object, to establish the communication channel with the
Application Broker, and to shut down the WebServer object when the
program ends. All other references to the WebServer object are made in the
static IBC Library code and not within the template generated code.

SourceFiles

The WebServerClass source code is installed by default to the \LIBSRC

folder. The specific WebServerClass files and their respective components
are:

[Link] WebServerClass declarations

ShutDownClass declarations

[Link] WebServerClass method definitions

ShutDownClass method definitions

[Link] WebServerClass translation strings

CHAPTER 3 WEBSERVERCLASSES 65

Conceptual Example

The following example shows a typical sequence of statements to declare,

instantiate, initialize, use, and terminate a WebServerClass object and related
objects.
MyWebPgm PROGRAM

LinkBaseClasses EQUATE(1)
BaseClassDllMode EQUATE(0)
INCLUDE('[Link]') !declare TextOutputClass
INCLUDE('[Link]') !declare WebBrokerClass
INCLUDE('[Link]') !declare WebWindowClass
INCLUDE('[Link]') !declare WebClientManagerClass
INCLUDE('[Link]') !declare Internet EQUATEs
MAP
INCLUDE('[Link]') !declare Internet helper procedures
END
!data declarations
Broker BrokerClass !declare Broker object
HtmlManager HtmlClass !declare HtmlManager object
JavaEvents JslEventsClass !declare JslEvents object
WebServer WebServerClass !declare WebServer object
WebFilesManager WebFilesClass !declare WebFilesManager object
ShutDownManager CLASS(ShutDownClass) !declare ShutDownManager object
Close PROCEDURE,VIRTUAL
END

ICServerWin WINDOW,AT(-100,-100,0,0) !declare an invisible

window END
CODE
[Link](1, '') !initialize WebFilesManager object
[Link] !initialize JavaEvents object
[Link]('TREE', WebFilesManager) !initialize Broker object
[Link](WebFilesManager) !initialize HtmlManager object
[Link](Broker,ShutDownManager,,600,,WebFilesManager)!init WebServer object
IF ([Link]()) !if launched by App Broker
OPEN(ICServerWin) !open invisible window
ACCEPT
IF (EVENT() = EVENT:OpenWindow)
[Link] !set up communication w/ App Broker
Main !run as usual
BREAK
END
END
ELSE !if not launched by App Broker
Main !run as usual
END
[Link] !shut down IBC Library objects

[Link]
CODE
[Link] !shut down WebServer object
[Link] !shut down HtmlManager object
[Link]() !shut down Broker object
[Link] !shut down JavaEvents object
[Link] !shut down WebFilesManager object
66 IBC LIBRARY REFERENCE

WebServerClass Proper ties

Active(server communicateswith broker)
Active SIGNED(False)
The Active property indicates whether a communication channel is
established between the Server (your Web-enabled application) and the
Application Broker that launched it. A value of zero (False) indicates the
channel is not established and the Server cannot be run from a Web browser.
Any other value indicates the channel is established and the Server can be
run from a Web browser.

Implementation: The Connect method sets the Active property to a non-zero value when it
establishes a communication channel with the Application Broker.

SeeAlso: Connect

ArgIndex (index tobrowser request string)

ArgIndex SIGNED
The ArgIndex property indexes start and end positions of the discrete
sections of the request string forwarded to the server from the client browser
by the Application Broker.

Implementation: The SetNext Action method uses the ArgIndex property to parse browser
requests.

SeeAlso: SetNextAction

Broker (BrokerClassobject)
Broker &BrokerClass
The Broker property is a reference to a BrokerClass object. The
WebServerClass object uses this property to handle all communications with
the Application Broker.

Implementation: The Broker property handles the transmission of HTML code and Java
Support Library (JSL) data from the Server (your Web-enabled application
program) to the Application Broker.
CHAPTER 3 WEBSERVERCLASSES 67

CurSubmit (SubmitItemClassobject)
CurSubmit &SubmitItemClass, PROTECTED
The CurSubmit property is a reference to a SubmitItemClass object. The
WebServerClass object uses this property to manage incoming data from the
client browser.

This property is PROTECTED, therefore, it can only be referenced by a

WebServerClass method, or a method in a class derived from
WebServerClass.

Implementation: When the end user enters data through the Web browser, the browser submits
the data in a “request string” which the Application Broker forwards to the
Server (your Web-enabled application). The request string optionally
contains a list of field assignments of the form ‘field=value&field2=value2’.
The CurSubmit property represents a single field assignment within the
request string, including the field equate of the control, the new value entered
in the browser, and any event associated with the control (accepted, scroll,
etc.).

The Init method sets the initial value of the CurSubmit property to reference
a new SubmitItemClass object. The SetNextAction method “positions” the
CurSubmit property to the next field assignment.

SeeAlso: Init, SetNextAction

Client (WebClientManagerClassobject)
Client &WebClientManagerClass
The Client property is a reference to the WebClientManagerClass object that
supplies information about the client’s browser and IP address. The
WebServerClass object does not use the Client property, except to make it
available to other objects, such as the WebWindowClass object, that
reference the WebServerClass object.

Implementation: The Init method sets the initial value of the Client property. The TakeEvent
method refreshes the Client property in case the end user modifies the
browser capabilites in mid-session.

SeeAlso: Init, TakeEvent

68 IBC LIBRARY REFERENCE

CommandLine(commandlineparameters)
CommandLine ANY
The CommandLine property contains any parameter string specified when
the client browser requests the Server (your Web-enabled application). The
WebServerClass object does not use this property, except to make it available
to your program for parsing and processing as needed.

Implementation: The Init method sets the value of the CommandLine property. See Using
Command Line Parameters for more information on specifying parameters.

SeeAlso: Init

DialogPageBackColor (MESSAGEpagebackgroundcolor)
DialogPageBackColor LONG
The DialogPageBackColor property indicates the background color of the
Web page which displays Clarion MESSAGEs.

Implementation: The SetDialogPageBackground method sets the value of the

DialogPageBackColor property.

SeeAlso: SetDialogPageBackground

DialogPageImage(MESSAGEpagewallpaper)
DialogPageImage CSTRING(FILE:MaxFileName)
The DialogPageImage property indicates the background image (wallpaper)
of the Web page which displays Clarion MESSAGEs.

Implementation: The SetDialogPageBackground method sets the value of the

DialogPageBackColor property.

SeeAlso: SetDialogPageBackground

DialogWinBackColor (MESSAGEwindow backgroundcolor)

DialogWinBackColor LONG
The DialogWinBackColor property indicates the background color of the
Web page window which displays Clarion MESSAGEs.

Implementation: The SetDialogWindowBackground method sets the value of the

DialogWinBackColor property.

SeeAlso: SetDialogWindowBackground
CHAPTER 3 WEBSERVERCLASSES 69

DialogWinImage(MESSAGEwindowwallpaper)
DialogWinImage CSTRING(FILE:MaxFileName)
The DialogWinImage property indicates the background image (wallpaper)
of the Web page window which displays Clarion MESSAGEs.

Implementation: The SetDialogWindowBackground method sets the value of the

DialogWinImage property.

SeeAlso: SetDialogWindowBackground

Files(WebFilesClassobject)
Files &WebFilesClass
The Files property is a reference to the WebFilesClass object that locates and
identifies files shared with the client’s browser.

Implementation: The Init method sets the initial value of the Files property.

SeeAlso: Init

GotCommandLine(commandlinearguments set flag)

GotCommandLine BYTE
The GotCommandLine property indicates whether the WebServerClass has
already collected command line arguments from the first browser request
and stored them in the CommandLine property. A value of one (1 or True)
indicates the command line parameters are collected and stored. A value of
zero (0 or False) indicates the command line parameters are not yet collected
and stored.

Implementation: The Init method sets the GotCommandLine property to zero. The
TakeRequest method sets GotCommandLine to true after it processes the first
browser request.

SeeAlso: CommandLine, Init, TakeRequest

70 IBC LIBRARY REFERENCE

JavaLibraryPath (Java Support Library location)

JavaLibraryPath CSTRING(FILE:MaxFileName)
The JavaLibraryPath property contains the non-default location of the Java
Support Library. This may be a pathname relative to the Application Broker,
or it may be a URL naming another site.

The WebServerClass object does not use the JavaLibraryPath property,

except to make it available to other objects, such as the WebWindowClass
object, that reference the WebServerClass object.

Implementation: The Init method sets the initial value of the JavaLibraryPath property. This
value comes from the Internet Application Extension template’s Advanced
tab. If the Java Support Library is installed to its default location (the /public
directory below the Application Broker directory), then JavaLibraryPath is
null.

SeeAlso: Init

PageToReturnTo (return URL)

PageToReturnToCSTRING(FILE:MaxFileName)
The PageToReturnTo property contains the destination to go to when the
Server (your Web-enabled application) shuts down normally. This may be a
pathname relative to the Application Broker, or it may be a URL naming
another site.

Implementation: The Init method sets the initial value of the PageToReturnTo property. This
value comes from the Internet Application Extension template’s Advanced
tab. If the Java Support Library is installed to its default location (the /public
directory below the Application Broker directory), then JavaLibraryPath is
null.

SeeAlso: Init
CHAPTER 3 WEBSERVERCLASSES 71

ProgramName (Server pathname)

ProgramName CSTRING(FILE:MaxFileName)
The ProgramName property contains the pathname of the Server (your
Web-enabled application) relative to the Application Broker. The
WebServerClass object uses this property to determine whether the program
was launched by the Application Broker at the request of a Web browser.

Implementation: The Init method sets the initial value of the ProgramName property. This
value comes from the Application Broker when it launches the Server.

SeeAlso: Init

TimeOut (periodof inactivity after whichto shut down)

TimeOut SIGNED
The TimeOut property contains the number of seconds of inactivity, after
which the Server (your Web-enabled application) automatically shuts down.

Implementation: The Init method sets the initial value of the TimeOut property. This value
comes from the Internet Application Extension template’s Advanced tab.

SeeAlso: Init
72 IBC LIBRARY REFERENCE

WebServerClass Methods
The WebServerClass inherits all the methods of the WebDataSinkClass from
which it is derived.

In addition to (or instead of) the inherited methods, the WebServerClass

contains the methods listed below.

Functional Organization—ExpectedUse

As an aid to understanding the WebServerClass, it is useful to organize the

various WebServerClass methods into two categories according to their
expected use—the primary interface and the virtual methods. This
organization reflects what we believe is typical use of these methods.

Primary Interface Methods

The primary interface methods, which you are likely to call fairly routinely
from your program, can be further divided into three categories:

Housekeeping (one-time) Use:

Init initialize the WebServerClass object
SetDialogPageBackground set MESSAGE Web page background
SetDialogWinBackgroundset MESSAGE Web window background
GetInternetEnabled return Web/Windows mode
Connect establish communication to App Broker
Kill shut down the WebServerClass object

Mainstream Use:
-none-

Occasional Use:
GetReadyForPage return ready-to-continue flag
GetRequestedWholePage return scope of browser request
GetSendWholePage return full or partial refresh flag
Halt shut down the Server immediately
QuitV shut down the Server normally
SetSendWholePage force full page refresh
SetNewPageDisable suppress outgoing Web pages
SetNextAction return Web page field information
TakeEvent process WebServerClass object events
TakePageSent prepare WebServerClass object for page
V
These methods are also Virtual.
CHAPTER 3 WEBSERVERCLASSES 73

Virtual Methods

Typically you will not call these methods directly—other IBC Library
methods call them. However, we anticipate you will often want to override
these methods, and because they are virtual, they are very easy to override.
These methods do provide reasonable default behavior in case you do not
want to override them.

Quit shut down the Server

74 IBC LIBRARY REFERENCE

Connect (establishcommunicationwith ApplicationBroker)

Connect
The Connect method establishes a communication channel between this
instance of the Server (your Web-enabled application) and the Application
Broker that launched it.

Implementation: The Connect method sets the Active property to a non-zero value when it
successfully establishes the communication channel.

Example:
WebWindow PROGRAM
!data declarations
CODE
[Link](Broker, '', 600, '', WebFilesManager)
IF ([Link]())
OPEN(ICServerWin)
ACCEPT
IF (EVENT() = EVENT:OpenWindow)
[Link] !set up channel to App Broker
Main
BREAK
END
END
ELSE
Main
END
[Link]

SeeAlso: Active
CHAPTER 3 WEBSERVERCLASSES 75

GetInternetEnabled(returnWeb/Windowsmode)
GetInternetEnabled, BYTE
The GetInternetEnabled method returns a value indicating whether the
Server (your Web-enabled application) was launched by the Application
Broker at the request of a Web browser. A value of one (1) indicates the
Server was launched by the Application Broker (Web mode); a value of zero
(1) indicates the Server was not launched by the Application Broker
(Windows mode).

Implementation: The GetInternetEnabled method evaluates the ProgramName property to

determine whether the Server was launched by the Application Broker.

Return DataType: BYTE

Example:
WebWindow PROGRAM
!data declarations
CODE
[Link](Broker, '', 600, '', WebFilesManager)
IF ([Link]()) !launched from browser?
OPEN(ICServerWin)
ACCEPT
IF (EVENT() = EVENT:OpenWindow)
[Link]
Main
BREAK
END
END
ELSE !not launched from browser?
Main
END
[Link]

SeeAlso: ProgramName
76 IBC LIBRARY REFERENCE

GetReadyForPage(return ready-to-continueflag)
GetReadyForPage, BYTE
The GetReadyForPage method returns a value indicating whether the
Server (your Web-enabled application) is ready to refresh the client’s Web
browser display. A return value of one (1) indicates the Server is ready to
proceed; a value of zero (0) indicates the Server is not ready to proceed.

You can use the SetNewPageDisable method to instruct the

GetReadyForPage method to return a value of zero (0). This lets you delay
HTML generation based on any events or conditions you choose.

Implementation: The GetReadyForPage method returns a value of zero (0) primarily if there
are events remaining to be processed. This allows the Internet Builder Class
objects to delay the HTML generation until all normal Windows processing
is complete.

Return DataType: BYTE

Example:
[Link] PROCEDURE

CODE
IF ([Link])
CASE [Link]()
OF NET:Request
[Link]
END
CASE (EVENT())
OF EVENT:NewPage
IF ([Link]()) !ready to refresh the web page?
[Link]
END
OF EVENT:OpenWindow
[Link]
END
[Link]
IF ([Link]()) !ready to refresh the web page?
POST(EVENT:NewPage)
END
END

SeeAlso: SetNewPageDisable
CHAPTER 3 WEBSERVERCLASSES 77

GetRequestedWholePage (return scopeof browser request)

GetRequestedWholePage, BYTE
The GetRequestedWholePage method returns a value indicating whether
the Client browser requested a full page refresh or a partial page refresh. A
return value of one (1) indicates the Client requested a full page (slower); a
value of zero (0) indicates the Client requested a partial page (faster).

Return DataType: BYTE

Example:
[Link] PROCEDURE
!data declarations
Index SIGNED,AUTO
CODE
IF [Link]() !full page requested?
!clear all check boxes before sending new page
LOOP Index = 1 TO RECORDS([Link])
GET([Link], Index)
[Link]()
END
END
LOOP
!etc
END
78 IBC LIBRARY REFERENCE

GetSendWholePage(return full or partial refreshflag)

GetSendWholePage, BYTE
The GetSendWholePage method returns a value indicating whether the
Server (your Web-enabled application) will honor or ignore the Client’s
(browser) request for a partial page. A return value of one (1) indicates the
Server will ignore the partial page request and send a full page; a value of
zero (0) indicates the Server will send whatever the Client requested.

You can use the SetSendWholePage method to determine the value

GetSendWholePage returns. This lets you force a full page refresh based on
any events or conditions you choose.

Return DataType: BYTE

Example:
[Link] PROCEDURE

Client &WebClientManagerClass
Filename CSTRING(FILE:MaxFilePath),AUTO

CODE
Client &= [Link]

[Link]([Link]())
IF ([Link]()) !full page refresh?
Filename = [Link](Content:Html)
IF ([Link]())
[Link]
[Link]([Link],Filename)
ELSE
[Link]([Link],Filename)
END
[Link](Filename, [Link](),FALSE)
ELSE !or partial page refresh?
[Link]([Link](),[Link])
[Link]([Link])
[Link]
END
[Link]()

SeeAlso: SetSendWholePage
CHAPTER 3 WEBSERVERCLASSES 79

Halt (immediately shut down theServer)

Halt
The Halt method shuts down the Server (your Web-enabled application)
immediately. It does not attempt to preserve pending transactions or offer the
end user an opportunity to continue the session.

Implementation: The Halt method calls the [Link] method to shutdown the
Server.

You can call the Halt method to let the end user exit the Server from any of
its generated Web pages, rather than requiring the end user to navigate to the
Server’s opening page before exiting.

SeeAlso: [Link]
80 IBC LIBRARY REFERENCE

Init (initialize theWebServerClassobject)

Init( broker, shut down [,return page], timeout [,JSL path], files )

Init Initializes the WebServerClass object.

broker The label of the BrokerClass object that handles the
transmission of HTML code and Java Support Library
(JSL) data from the Server (your Web-enabled applica-
tion program) to the Application Broker.
shut down The label of the ShutDownClass object that handles the
Server’s normal shut down.
return page A string constant, variable, EQUATE, or expression
containing the destination to go to when the Server shuts
down normally. If omitted, the Server supplies a stan-
dard termination page indicating it is no longer running.
timeout An integer constant, variable, EQUATE, or expression
containing the number of seconds of inactivity after
which the Server automatically shuts down.
JSL path A string constant, variable, EQUATE, or expression
containing the non-default location of the Java Support
Library. If omitted, the Server looks for the Java Support
Library in its local directories.
files The label of the FilesClass object that manages the
pathname information (Java Support Library files,
temporary and permanent files, directories, aliases,
public and secure channels) for the Server.
The Init method initializes the WebServerClass object.

Implementation: The Init method sets the initial value of the Broker, Files, JavaLibraryPath,
PageToReturnTo, and TimeOut properties.

Example:
WebWindow PROGRAM
!data declarations
CODE
[Link](Broker,ShutDown,,600,'',WebFilesManager) !initialize WebServer object
OPEN(ICServerWin)
ACCEPT
IF (EVENT() = EVENT:OpenWindow)
[Link]
Main
BREAK
END
END
[Link] !shut down Server

SeeAlso: Broker, Files, JavaLibraryPath, PageToReturnTo, TimeOut

CHAPTER 3 WEBSERVERCLASSES 81

Kill (shut down theWebServerClassobject)

Kill
The Kill method frees all memory allocated during the life of the object and
performs any other required termination code.

Implementation: The Kill method removes all temporary files created during the remote
computing session, sends the browser to the appropriate return page, and
closes the communication channel with the Application Broker.

[Link] PROCEDURE
CODE
[Link] !shut down WebServer object
82 IBC LIBRARY REFERENCE

Quit (shut down theServer normally)

Quit, VIRTUAL
The Quit method initiates normal shut down of the Server (your Web-
enabled application). This allows executing procedures to attempt to preserve
pending transactions or offer the end user an opportunity to continue the
session.

Quit is a VIRTUAL method so that other base class methods can directly call
the Quit virtual method in a derived class. This lets you easily implement
your own custom version of this method.

Implementation: The Quit method sets a flag to begin normal program shut down.

You can call the Quit method to let the end user exit the Server from any of
its generated Web pages, rather than requiring the end user to navigate to the
Server’s opening page before exiting.

Example:
[Link] PROCEDURE
!data declarations

CODE
IF ([Link])
IF [Link] THEN RETURN Net:Terminate.

CASE EVENT()
OF EVENT:Terminate !on end user request
[Link] ! initiate normal shut down
RETURN Net:Terminate
OF EVENT:Request
IF [Link]
[Link] = FALSE
RETURN [Link](IC:GetRequestText())
END
OF EVENT:Timer
IF ([Link])
IF (CLOCK()-[Link]>[Link]*100) !on program time out
[Link] ! initiate normal shut down
END
END
OF EVENT:OpenWindow
IF [Link]
POST(EVENT:Request)
END
IF 0{PROP:timer}=0
0{PROP:timer} = [Link] * 10
END
END
END
RETURN NET:Unknown

SeeAlso: Kill
CHAPTER 3 WEBSERVERCLASSES 83

SetDialogPageBackground(set MESSAGEWebpagebackground)
SetDialogPageBackground( [color] [,image] )

SetDialogPageBackground
Sets the MESSAGE Web page background color and
image.
color An integer constant, variable, EQUATE, or expression
indicating the PAGE color.
image A string constant, variable, EQUATE, or expression
containing a filename. The WebWindowClass object
displays (tiles) the image in the specified file as the
background to the Web page.
The SetDialogPageBackground method sets the background color and
image for the Web page that displays Clarion MESSAGEs.

Implementation: The SetDialogPageBackground method sets the DialogPageBackColor

property and the DialogPageImage properties.

Example:
MyWebPgm PROGRAM
!data declarations
CODE
[Link](1, '')
[Link]
[Link]('TREE', WebFilesManager
[Link](WebFilesManager)
[Link](Broker,ShutDownManager,,600,,WebFilesManager)
[Link](,’[Link]’)!set global MESSAGEs logo
[Link](COLOR:Blue) !set global MESSAGEs window color
!program code

SeeAlso: DialogPageBackColor, DialogPageImage

84 IBC LIBRARY REFERENCE

SetDialogWinBackground(set MESSAGEWebpage windowbackground)

SetDialogWinBackground( [color] [,image] )

SetDialogWinBackground
Sets the MESSAGE Web page window background
color and image.
color An integer constant, variable, EQUATE, or expression
indicating the PAGE color.
image A string constant, variable, EQUATE, or expression
containing a filename. The WebWindowClass object
displays (tiles) the image in the specified file as the
background to the Web page window.
The SetDialogWinBackground method sets the background color and
image for the Web page window that displays Clarion MESSAGEs.

Implementation: The SetDialogWinBackground method sets the DialogWinBackColor

property and the DialogWinImage properties.

SeeAlso: DialogWinBackColor, DialogWinImage

CHAPTER 3 WEBSERVERCLASSES 85

SetSendWholePage(forcefull pagerefresh)
SetSendWholePage( force )

SetSendWholePage
Determines whether the Server honors or ignores Client
(browser) requests for a partial page update.
force An integer constant, variable, EQUATE, or expression
indicating whether the Server (your Web-enabled
application) sends a full page refresh, regardless of
whether the Client browser requested a full page or a
partial page. A value of one (1) forces the Server to send
a full page; a value of zero (0) lets the Server send
whatever the Client requested.
The SetSendWholePage method determines whether the Server honors
Client (browser) requests for a partial page update by sending only a partial
page, or ignores the partial page request and sends a full page instead.

You can use the SetSendWholePage method to force a full page refresh
based on any events or conditions you choose. Conversely, you can use the
SetSendWholePage method to return control to the Client based on any
events or conditions you choose.

Example:
[Link] PROCEDURE(*WebServerClass Server,*HtmlClass HtmlTarget)

CODE
! initialize WebWindow object
[Link](True) !Always force full page on a new window

SeeAlso: GetSendWholePage
86 IBC LIBRARY REFERENCE

SetNewPageDisable (suppressoutgoingWebpages)
SetNewPageDisable( ignore )

SetNewPageDisable
Determines whether the Server (your Web-enabled
application) honors or ignores Client (browser) requests
for information.
ignore An integer constant, variable, EQUATE, or expression
indicating whether the Server honors or ignores Client
(browser) requests for information. A value of one (1)
ignores Client requests for information; a value of zero
(0) honors Client requests.
The SetNewPageDisable method determines whether the Server honors or
ignores Client (browser) requests for information. This lets you delay HTML
generation based on any events or conditions you choose.

An ignore value of one (1) tells the Server continue to receive and process
incoming information, but suppresses any outgoing information (Web
pages).

The GetReadyForPage method implements the behavior set by the

SetNewPageDisable method.

Example:
CASE EVENT()
OF EVENT:StupidQuestion
[Link](True) !suppress outgoing information
OF EVENT:Apology
[Link](False) !enable outgoing information
END

SeeAlso: GetReadyForPage
CHAPTER 3 WEBSERVERCLASSES 87

SetNextAction(returnWebpage field information)

SetNextAction, SubmitItemClass
The SetNextItem method sets the CurSubmit property to the next incoming
Web page field, then returns either a NULL reference, indicating there are no
more incoming items to process, or returns a valid reference to the
CurSubmit property (a SubmitItemClass object), indicating the referenced
object is ready to process the next incoming item.

Implementation: The SetNextItem method calls the [Link] method to set the
CurSubmit property to the next incoming item.

When the end user enters data through the Web browser, the browser submits
the data in a “request string” which the Application Broker forwards to the
Server (your Web-enabled application). The request string optionally
contains a list of field assignments of the form ‘field=value&field2=value2’.
The CurSubmit property represents a single field assignment within the
request string, including the field equate of the control, the new value entered
in the browser, and any event associated with the control (accepted, scroll,
etc.).

Return DataType: SubmitItemClass reference

Example:
[Link] PROCEDURE

NextSubmit &SubmitItemClass
Curfeq SIGNED,AUTO
Index SIGNED,AUTO
CODE
LOOP
NextSubmit &= [Link]() !return Web page field info
IF (NextSubmit &= NULL) !if NULL,
BREAK ! no more fields to process
END
CurFeq = [Link] !otherwise, process the field
CASE (CurFeq)
OF FEQ:UNKNOWN
[Link](NextSubmit)
ELSE
IF ([Link](CurFeq))
IF ([Link])
IF (NOT CurFeq{PROP:disable}) AND (NOT CurFeq{PROP:readonly})
[Link](NextSubmit)
END
END
END
END
END

SeeAlso: CurSubmit, [Link]

88 IBC LIBRARY REFERENCE

TakeEvent (processWebServerClassobject events)

TakeEvent, SIGNED
The TakeEvent method process all events for the WebServerClass object
and returns a value indicating whether the event originated from the Client or
from the Server (internally). A return value of NET:Request indicates the
event originated from the Client; a return value of NET:Unknown indicates
the event originated elsewhere.

Implementation: EQUATEs for the return value are declared in [Link] as follows:
NET:Unknown EQUATE(0)
NET:Terminate EQUATE(1)
NET:Request EQUATE(2)

The TakeEvent method handles any events that originated from the Client,
that is, any events forwarded to the Server by the Application Broker through
the communication channel established by the Connect method.

The TakeEvent method also handles other events that may be significant to
the WebServerClass object, such as EVENT:OpenWindow events (the
WebServerClass object initiates a timer to support automatic shut down after
an idle period), or EVENT:Timer events (the WebServerClass object
monitors timer events to support automatic shut down after an idle period).
This does not interfere with any other timer events and processing for the
Window.

Return DataType: SIGNED

Example:
[Link] PROCEDURE

CODE
IF ([Link])
CASE [Link]()
OF NET:Request
[Link]
END
CASE (EVENT())
OF EVENT:NewPage
IF ([Link]())
[Link]
END
OF EVENT:OpenWindow
[Link]
END
[Link]
IF ([Link]())
POST(EVENT:NewPage)
END
END
CHAPTER 3 WEBSERVERCLASSES 89

TakePageSent (prepareWebServerClassobject for next page)

TakePageSent
The TakePageSent method prepares the WebServerClass object to process
the next request from the Client (browser).

Implementation: The TakePageSent method reinitializes some internal flags.

Example:
[Link] PROCEDURE

Client &WebClientManagerClass
Filename CSTRING(FILE:MaxFilePath),AUTO

CODE
Client &= [Link]

[Link]([Link]())
IF ([Link]())
Filename = [Link](Content:Html)
IF ([Link]())
[Link]
[Link]([Link], Filename)
ELSE
[Link]([Link], Filename)
END
[Link](Filename, [Link](), FALSE)
ELSE
[Link]([Link](), [Link])
[Link]([Link])
[Link]
END
[Link]() !reset for next page
90 IBC LIBRARY REFERENCE

ShutDownClass Methods
The WebServerClass uses the ShutDownClass to shut down other IBC
Library objects when the Server (Web-enabled application) undergoes a
normal shut down, including end user request and time outs.

The ShutDownClass is an abstract class. Its methods are not implemented;

rather they are placeholders for derived classes. The ShutDownClass
contains the methods listed below.

Close(a virtual shut down theWeb-enabledapplication)

Close, VIRTUAL
The Close method is a virtual placeholder to shut down the Web-enabled
application, including other IBC Library objects.

Example:
MyWebPgm PROGRAM
!data declarations
Broker BrokerClass !declare Broker object
HtmlManager HtmlClass !declare HtmlManager object
JavaEvents JslEventsClass !declare JslEvents object
WebServer WebServerClass !declare WebServer object
WebFilesManager WebFilesClass !declare WebFilesManager object
ShutDownManager CLASS(ShutDownClass) !declare ShutDownManager object
Close PROCEDURE,VIRTUAL
END
ICServerWin WINDOW,AT(-100,-100,0,0) !declare an invisible
window END
CODE
[Link](1, '') !initialize WebFilesManager object
[Link] !initialize JavaEvents object
[Link]('TREE', WebFilesManager) !initialize Broker object
[Link](WebFilesManager) !initialize HtmlManager object
[Link](Broker,ShutDownManager,,600,,WebFilesManager)!init ShutDown object
OPEN(ICServerWin) !open invisible window
ACCEPT
IF (EVENT() = EVENT:OpenWindow)
[Link] !set up communication w/ App Broker
Main !run as usual
BREAK
END
END
[Link] !shut down IBC Library objects

WEB CLIENT MANAGER CLASS

WebClientManagerClassConcepts

The WebClientManagerClass helps the WebWindowClass generate

The WebClientManagerClass also communicates with the BrokerClass on

behalf of the WebWindowClass. The BrokerClass instantiates and manages a
single WebClientManagerClass object.

Relationship toOther Internet Builder Classes

The WebClientManagerClass is derived from the WebDataSinkClass. The

WebDataSinkClass is an abstract class whose methods are not defined. The
WebDataSinkClass does provides a reference to all its derived classes.

The BrokerClass creates and manages the WebClientManagerClass object to

represent the Client computer.

Internet ConnectTemplate Implementation

The BrokerClass creates and manages a single global

WebClientManagerClass object. The template generated code does not
directly reference the WebClientManagerClass object.

SourceFiles

The WebClientManagerClass source code is installed by default to the

\LIBSRC folder. The specific WebClientManagerClass files and their
respective components are:

[Link] WebClientManagerClass declarations

94 IBC LIBRARY REFERENCE

WebClientManagerClass Proper ties

Broker (BrokerClassobject)
Broker &BrokerClass, PROTECTED
The Broker property is a reference to the BrokerClass object that represents
the Application Broker. The Broker property handles the transmission of
HTML code and Java Support Library (JSL) data from the Server (Web-
enabled application) to the Application Broker.

This property is PROTECTED, therefore, it can only be referenced by a

WebClientManagerClass method, or a method in a class derived from
WebClientManagerClass.

Implementation: The Init method sets the value of the Broker property.

SeeAlso: Init

Browser (BrowserManagerClassobject)
Browser &BrowserManagerClass
The Browser property is a reference to the BrowserManagerClass object that
represents the Client’s Web browser within the Server (Web-enabled
application). The Browser property contains information about the specific
features the Web browser supports.

The HtmlClass object, HttpClass object, and WebWindowClass object all

modify their output based on the contents of the Browser property and the
specific features the Web browser supports.

Implementation: The Init method sets the value of the Browser property.

SeeAlso: Init
CHAPTER 4 WEBCLIENTMANAGERCLASS 95

IP (client IP address)
IP CSTRING(255)
The IP property contains the Client’s IP address. The
WebClientManagerClass does not use this property, but makes it available
for other code that may need it.

Implementation: The [Link] method sets the value of the IP property. The value
comes from the Application Broker that launches the Server (Web-enabled
application).

SeeAlso: [Link]

Jsl (JslManagerClassobject)
Jsl &JslManagerClass
The Jsl property is a reference to the JslManagerClass that represents the
Java Support Library (JSL). The Jsl property allows dynamic updates to the
contents of an HTML page without refreshing the entire page.

Implementation: The Init method instantiates a JslManagerClass object for the Jsl property.

SeeAlso: Init
96 IBC LIBRARY REFERENCE

WebClientManagerClass Methods
The WebClientManagerClass contains the methods listed below.

Functional Organization—ExpectedUse

As an aid to understanding the WebClientManagerClass, it is useful to

organize its methods into two categories according to their expected use—
the primary interface and the virtual methods. This organization reflects
what we believe is typical use of these methods.

Primary Interface Methods

The primary interface methods, which you are likely to call fairly routinely
from your program, can be further divided into three categories:

Housekeeping (one-time) Use:

Init initialize the WebClientManagerClass object
Kill shut down the WebClientManagerClass object

Mainstream Use:
-none-

Occasional Use:
Feq2Id return HTML control Id
NextHtmlPage prepare for next HTML page

Virtual Methods

TakeFile send HTML code or JSL data

TakeHtmlPage send HTML code
TakeJslData send JSL data
TakeUnauthorized send access denied page
CHAPTER 4 WEBCLIENTMANAGERCLASS 97

Feq2Id (return HTML control Id)

Feq2Id( control ), UNSIGNED, VIRTUAL

Feq2Id Returns the HTML control Id for the corresponding

Clarion WINDOW or REPORT control.
control An integer variable, constant, EQUATE, or expression
containing a Clarion control number. This is typically
the Field Equate label of the control.
The Feq2Id method returns the HTML control Id for the corresponding
Clarion WINDOW or REPORT control.

Feq2Id is a VIRTUAL method so that other base class methods can directly
call the Feq2Id virtual method in a derived class. This lets you easily
implement your own custom version of this method.

Implementation: The [Link] calls the Feq2Id method to generate

unique control Ids within the generated HTML.

Example:
[Link] PROCEDURE |
(SIGNED Feq,STRING ClassName,SIGNED Width,SIGNED Height)

Id SIGNED,AUTO

CODE
Id = [Link].Feq2Id(Feq)
[Link](Feq, '_X' & Id, ClassName, Width, Height)

SeeAlso: [Link]
98 IBC LIBRARY REFERENCE

Init (initialize theWebClientManagerClassobject)

Init( broker, browser )

Init Initializes the WebClientManagerClass object.

broker The label of the BrokerClass object that handles the
transmission of HTML code and Java Support Library
(JSL) data from the Server (Web-enabled application) to
the Application Broker.
browser The label of the BrowserManagerClass object that
contains information about the specific features the
Client’s Web browser supports.
The Init method initializes the WebClientManagerClass object.

Implementation: The Init method sets the value of the Broker, Browser, and Jsl properties.

Example:
[Link] PROCEDURE
CODE
IF ([Link] &= NULL)
[Link] &= NEW WebClientManagerClass !instantiate client object
[Link](SELF, UnknownBrowser) !initialize client object
END
[Link]

SeeAlso: Broker, Browser, Jsl

CHAPTER 4 WEBCLIENTMANAGERCLASS 99

Kill (shut down theWebClientManagerClassobject)

Kill
The Kill method frees any memory allocated during the lifeof the object and
performs any other required termination code.

Example:
[Link] PROCEDURE
CODE
[Link]
IF (NOT ([Link] &= NULL))
[Link]
DISPOSE([Link])
END
IF (NOT [Link] &= NULL)
[Link] !shut down client object
DISPOSE([Link])
END
100 IBC LIBRARY REFERENCE

NextHtmlPage (prepare for next HTML page)

NextHtmlPage
The NextHtmlPage method prepares the WebClientManagerClass object to
process a new HTML page.

Implementation: The NextHtmlPage method increments a counter used to generate unique IDs
for HTML controls.

Example:
[Link] PROCEDURE

Client &WebClientManagerClass
Filename CSTRING(FILE:MaxFilePath),AUTO

CODE
Client &= [Link]

[Link]([Link]())
IF [Link]() !if sending whole page
Filename = [Link](Content:Html)
[Link] !prepare Client object for new page
[Link]([Link],Filename) !WebWindow object creates new page
[Link](Filename,[Link](),FALSE) !Client takes it
ELSE
[Link]([Link](),[Link])
[Link]([Link])
[Link]
END
[Link]() !prepare Server object for next page
CHAPTER 4 WEBCLIENTMANAGERCLASS 101

TakeFile (sendHTML codeor JSLdata)

TakeFile( filename, secure, dontmove ), VIRTUAL

TakeFile Requests the BrokerClass object to send HTML code or

JSL data to the Client browser.
filename A string constant, variable, EQUATE, or expression
naming the file containing the HTML code or JSL data
to transmit.
secure An integer constant, variable, EQUATE, or expression
indicating whether to transmit over a secure channel or
public channel. A value of Secure:Full indicates a secure
channel; a value of Secure:None indicates a public
channel; and a value of Secure:Default indicates the
default channel.
dontmove An integer constant, variable, EQUATE, or expression
indicating ...
The TakeFile method requests the BrokerClass object to send HTML code
or JSL data to the Client browser.

TakeFile is a VIRTUAL method so that other base class methods can directly
call the TakeFile virtual method in a derived class. This lets you easily
implement your own custom version of this method.

Implementation: The TakeFile method calls the [Link] method.

EQUATEs for the secure parameter are declared in [Link] as follows:

ITEMIZE,PRE(Secure)
Default EQUATE
None EQUATE
Full EQUATE
Last EQUATE(Secure:Full)
END

SeeAlso: [Link]
102 IBC LIBRARY REFERENCE

TakeHtmlPage(sendHTML code)
TakeHtmlPage( filename, secure, dontmove ), VIRTUAL

TakeHtmlPage Requests the BrokerClass object to send an HTML page

to the Client browser.
filename A string constant, variable, EQUATE, or expression
naming the file containing the HTML code to transmit.
secure An integer constant, variable, EQUATE, or expression
indicating whether to transmit over a secure channel or
public channel. A value of Secure:Full indicates a secure
channel; a value of Secure:None indicates a public
channel; and a value of Secure:Default indicates the
default channel.
dontmove An integer constant, variable, EQUATE, or expression
indicating ...
The TakeHtmlPage method requests the BrokerClass object to send an
HTML page to the Client browser.

TakeHtmlPage is a VIRTUAL method so that other base class methods can

directly call the TakeHtmlPage virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: TakeHtmlPage calls the [Link] method.

EQUATEs for the secure parameter are declared in [Link] as follows:

ITEMIZE,PRE(Secure)
Default EQUATE
None EQUATE
Full EQUATE
Last EQUATE(Secure:Full)
END
CHAPTER 4 WEBCLIENTMANAGERCLASS 103

Example:
[Link] PROCEDURE

Client &WebClientManagerClass
Filename CSTRING(FILE:MaxFilePath),AUTO

CODE
Client &= [Link]

SeeAlso: [Link]
104 IBC LIBRARY REFERENCE

TakeJslData (sendJSLdata)
TakeJslData( filename, secure ), VIRTUAL

TakeJslData Requests the BrokerClass object to send JSL data to the

Client browser.
filename A string constant, variable, EQUATE, or expression
naming the file containing the JSL data to send.
secure An integer constant, variable, EQUATE, or expression
indicating whether to transmit over a secure channel or
public channel. A value of Secure:Full indicates a secure
channel; a value of Secure:None indicates a public
channel; and a value of Secure:Default indicates the
default channel.
The TakeJslData method requests the BrokerClass object to send JSL data
to the Client browser.

TakeJslData is a VIRTUAL method so that other base class methods can

directly call the TakeJslData virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: TakeJslData calls the [Link] method.

EQUATEs for the secure parameter are declared in [Link] as follows:

ITEMIZE,PRE(Secure)
Default EQUATE
None EQUATE
Full EQUATE
Last EQUATE(Secure:Full)
END

SeeAlso: [Link]
CHAPTER 4 WEBCLIENTMANAGERCLASS 105

TakeUnauthorized (sendaccessdeniedpage)
TakeUnauthorized( filename, secure ), VIRTUAL

TakeUnauthorized Requests the BrokerClass object to send an “access

denied” page to the Client browser.
filename A string constant, variable, EQUATE, or expression
naming the file containing the “access denied” page to
transmit.
secure An integer constant, variable, EQUATE, or expression
indicating whether to transmit over a secure channel or
public channel. A value of Secure:Full indicates a secure
channel; a value of Secure:None indicates a public
channel; and a value of Secure:Default indicates the
default channel.
The TakeUnauthorized method requests the BrokerClass object to send an
“access denied” page to the Client browser.

TakeUnauthorized is a VIRTUAL method so that other base class methods

can directly call the TakeUnauthorized virtual method in a derived class.
This lets you easily implement your own custom version of this method.

Implementation: TakeUnauthorized calls the [Link] method.

EQUATEs for the secure parameter are declared in [Link] as follows:

ITEMIZE,PRE(Secure)
Default EQUATE
None EQUATE
Full EQUATE
Last EQUATE(Secure:Full)
END
106 IBC LIBRARY REFERENCE

Example:
[Link] PROCEDURE

Client &WebClientManagerClass
Filename CSTRING(FILE:MaxFilePath),AUTO

CODE
Client &= [Link]

[Link]([Link]())
IF ([Link]() OR NOT [Link])
IF ([Link] AND NOT [Link]())
Filename = [Link](Content:UnAuthorized)
[Link]([Link], Filename)
[Link](Filename,[Link]()) !access denied
[Link] = TRUE
Post(EVENT:CloseWindow)
ELSE
Filename = [Link](Content:Html)
IF ([Link]())
[Link]
[Link]([Link], Filename)
ELSE
[Link]([Link], Filename)
END
[Link](Filename, [Link](), FALSE)
END
ELSE
[Link]([Link](), [Link])
[Link]([Link])
[Link]
END
[Link]()

SeeAlso: [Link]
CHAPTER 5 BROWSER MANAGER CLASS 107

BROWSER MANAGER CLASS

BrowserManagerClassConcepts

The BrowserManagerClass object contains information about the specific

features the Client’s Web browser supports. The information is available to
any other code that needs it.

Relationship toOther Internet Builder Classes

The BrokerClass creates several instances of the BrowserManagerClass—

one for each major type of browser. When the Client browser identifies itself
(with HTTP header information), the BrokerClass references the particular
BrowserManagerClass object that represents the Client’s browser.

The HtmlClass object uses the BrowserManagerClass object to custom tailor

its generated HTML code to the specific browser the Client is running.

Internet ConnectTemplate Implementation

The BrokerClass creates and manages instances of the

BrowserManagerClass as needed. Therefore, the Internet Connect Template
generated code does not directly reference the BrowserManagerClass object.

SourceFiles

The BrowserManagerClass source code is installed by default to the

\LIBSRC folder. The BrowserManagerClass declarations reside in the
following files and their method definitions reside in the corresponding
.CLW files.

[Link] BrowserManagerClass
110 IBC LIBRARY REFERENCE

BrowserManagerClass Proper ties

Kind(browser type)
Kind BYTE
The Kind property indicates the major category the represented Web
browser falls into. Valid Web browser categories include:
Internet Explorer version 3.0
Internet Explorer version 4.0
NetScape version 3
Mozilla version 4
Unknown
The HtmlClass object uses the Kind property to configure generated HTML
to the Client’s particular browser.

Implementation: The Init method sets the value of the Kind property. The
[Link] method alters its output based on the value of
the Kind property.

EQUATEs for the Kind property are declared in [Link] as follows:

ITEMIZE,PRE(BROWSER)
IE30 EQUATE
IE40 EQUATE
NetScape3 EQUATE
Mozilla4 EQUATE
Unknown EQUATE
END

SeeAlso: Init

SetNoCache(external cachecontrol support)

SetNoCache BYTE
The SetNoCache property indicates whether the represented browser
accepts external requests to suppress caching. A value of one (1) indicates
the browser accepts external (HTTP) requests to suppress caching; a value of
zero (0) indicates the browser caching mode cannot be set externally.

The HttpClass object uses the SetNoCache property to configure generated

HTTP to the Client’s particular browser.

Implementation: The [Link] method sets the value of the SetNoCache property. The
HttpClass object alters its output based on the value of the SetNoCache
property.

SeeAlso: [Link]
CHAPTER 5 BROWSER MANAGER CLASS 111

SupportsStyleSheets (style sheet support)

SupportsStyleSheets BYTE
The SupportsStyleSheets property indicates whether the represented
browser supports style sheets. A value of one (1) indicates the browser
supports style sheets; a value of zero (0) indicates the browser does not
support style sheets.

Implementation: The Init method sets the value of the SupportsStyleSheets property. The
HtmlClass and the WebWindowClass alter their output based on the value of
the SupportsStyleSheets property.

SeeAlso: Init

SubmitFromJava (applet communicationmode)

SubmitFromJava BYTE
The SubmitFromJava property indicates how the represented browser
channels Java applet requests to the Web server. A value of one (1) indicates
the browser’s applets communicate directly with the Web server; a value of
zero (0) indicates the browser’s applets communicate indirectly with the Web
server, by going through the browser’s usual channels.

The HtmlClass object uses the SubmitFromJava property to configure

generated HTML to the represented browser.

Implementation: The Init method sets the value of the SubmitFromJava property. The
[Link] method alters its output based on the value of the
SubmitFromJava property.

SeeAlso: Init
112 IBC LIBRARY REFERENCE

BrowserManagerClass Methods
The BrowserManagerClass contains only one method.

Init (initialize theBrowserManagerClassobject)

Init( kind, style sheets, applet submit ), VIRTUAL

Init Initializes the BrowserManagerClass object.

kind An integer constant, variable, EQUATE, or expression
indicating the major category the Web browser falls into.
Valid Web browser categories include Internet Explorer
3 and 4, NetScape 3, Mozilla 4, and other.
style sheets An integer constant, variable, EQUATE, or expression
indicating whether the browser supports style sheets. A
value of one (1) indicates the browser supports style
sheets; a value of zero (0) indicates the browser does not
support style sheets.
applet submit An integer constant, variable, EQUATE, or expression
indicating how the browser channels Java applet requests
to the Web server. A value of one (1) indicates the
browser’s applets communicate directly with the Web
server; a value of zero (0) indicates the browser’s applets
communicate indirectly with the Web server, by going
through the browser’s usual channels.
The Init method initializes the BrowserManagerClass object.

Implementation: The Init method sets the values of the Kind, SupportsStyleSheets, and
SubmitFromJava properties.

EQUATEs for the kind parameter are declared in [Link] as follows:

ITEMIZE,PRE(BROWSER)
IE30 EQUATE
IE40 EQUATE
NetScape3 EQUATE
Mozilla4 EQUATE
Unknown EQUATE
END
CHAPTER 5 BROWSER MANAGER CLASS 113

Example:
[Link] PROCEDURE(STRING ProgramName, WebFilesClass Files)

CODE
[Link](BROWSER:IE30,TRUE,FALSE) !init Internet Explorer 3.0 browser
[Link](BROWSER:IE40,TRUE,FALSE) !init Internet Explorer 4.0 browser
[Link](BROWSER:NetScape3,FALSE,TRUE) !init NetScape 3x browser
[Link] = TRUE
[Link](BROWSER:Mozilla4,FALSE,TRUE) !init Mozilla 4 browser
[Link] = TRUE
[Link](BROWSER:Unknown,FALSE,FALSE)!init generic Java enabled browser

[Link] !point Client to appropriate browser

SeeAlso: Kind, SupportsStyleSheets, SubmitFromJava

114 IBC LIBRARY REFERENCE
CHAPTER 6 WEB FRAME CLASS 115

WEB FRAME CLASS

WebFrameClassConcepts

Typically, your Web-enabled application instantiates a WebFrameClass

object to represent the mergeable controls on the APPLICATION frame.

The WebFrame Class provides methods to “merge” these global toolbar and
menu controls onto the Web pages representing the application’s child
windows. Finally, WebFrame Class provides methods to handle any events
associated with the merged controls.

Relationship toOther Internet Builder Classes

The WebFrameClass is independent of other Internet Builder Classes.

Internet ConnectTemplate Implementation

The Internet Connect Templates generate code to derive a WebFrameClass

object to represent the mergeable controls on the APPLICATION frame.

The derived WebFrameClass object is called MainFrame. The Internet

Connect Templates generate virtual methods within the MainFrame class to
simulate standard Windows menu and toolbar merging behavior on the Web
pages generated by the Server (your Web enabled application).

SourceFiles

The WebWindowClass source code is installed by default to the \LIBSRC

folder. The source files and their components are as follows:

[Link] WebFrameClass class declarations

[Link] WebFrameClass method definitions

118 IBC LIBRARY REFERENCE

Conceptual Example

The following example uses the WebFrameClass object to simulate merging

menus onto a “child” Web page.
PROGRAM
!data
MainFrame CLASS(WebFrameClass)
CopyControlsToWindow PROCEDURE(*WebWindowClass,BYTE,BYTE),VIRTUAL
FrameWindow &WINDOW
END
CODE
!program code

[Link] PROCEDURE|
(*WebWindowClass OwnerWindow, BYTE MergeMenu, BYTE MergeTool)
CODE
IF MergeMenu
[Link](OwnerWindow, ?Exit)
[Link](OwnerWindow, ?BrowseCustomer)
[Link](OwnerWindow, ?BrowseProduct)
[Link](OwnerWindow, ?BrowseState)
[Link](OwnerWindow, ?Print)
[Link](OwnerWindow, ?PrintInvoice)
[Link](OwnerWindow, ?PrintMailingLabels)
[Link](OwnerWindow, ?PrintPriceList)
[Link](OwnerWindow, ?ReadMe)
END

BrowseCustomer PROCEDURE
!data
CODE
!procedure code
PrepareProcedure ROUTINE
IF ([Link])
IC:CurFrame &= GetWebActiveFrame()
IC:[Link](WebWindow, TRUE, TRUE)
END
CHAPTER 6 WEB FRAME CLASS 119

WebFrameClass Proper ties

The WebFrameClass contains the following properties.

FrameWindow (MDI framewindow)

FrameWindow &WINDOW
The FrameWindow property is a reference to the program’s APPLICATION
(main window). The WebFrameClass uses the FrameWindow property to
reference the program’s main window.

MenubarFeq(menubar control number)

MenubarFeq SIGNED
The MenubarFeq property contains the control number (field equate) of the
MENUBAR. The WebFrameClass uses this property to refer to the
WINDOW’s MENUBAR structure.

Implementation: The GetMenubarFeq method returns the value of the MenubarFeq property.

SeeAlso: GetMenubarFeq

ToolbarFeq(Toolbar control number)

ToolbarFeq SIGNED
The ToolbarFeq property contains the control number (field equate) of the
TOOLBAR. The WebFrameClass uses this property to refer to the
WINDOW’s TOOLBAR structure.

Implementation: The GetToolbarFeq method returns the value of the ToolbarFeq property.

SeeAlso: GetToolbarFeq
120 IBC LIBRARY REFERENCE

WebFrameClass Methods
The WebFrameClass contains the methods listed below.

CopyControlsToWindow (avirtual to copy frame controls tochildwindow)

CopyControlsToWindow( window object, merge menu, merge toolbar), VIRTUAL

CopyControlsToWindow
Is a virtual placeholder method to copy controls from the
application frame to another window.
window object The label of the WebWindowClass object that represents
the WINDOW that receives the copied controls.
merge menu An integer constant, variable, EQUATE, or expression
indicating whether to copy menu controls. A value of
one (1) copies menu controls; a value of zero (0) does
not copy menu controls.
merge toolbar An integer constant, variable, EQUATE, or expression
indicating whether to copy toolbar controls. A value of
one (1) copies toolbar controls; a value of zero (0) does
not copy toolbar controls.
The CopyControlsToWindow method s a virtual placeholder method to
copy controls from the application frame to another (child) window. This
allows the simulation of standard Windows (menu and toolbar) merging
behavior within Web pages as seen through the Client browser.

CopyControlsToWindow is a VIRTUAL method so that other base class

methods can directly call the CopyControlsToWindow virtual method in a
derived class. This lets you easily implement your own custom version of
this method.

Implementation: The CopyControlsToWindow method does nothing. It is a virtual placeholder

for derived classes. In particular, the Internet Connect Templates generate a
custom CopyControlsToWindow method for each Web-enabled application.
The Internet Connect Template generated CopyControlsToWindow calls the
CopyControlToWindow method for each merged control.
CHAPTER 6 WEB FRAME CLASS 121

Example:
BrowseCustomer PROCEDURE
!data
CODE
!procedure code
PrepareProcedure ROUTINE
IF ([Link])
IC:CurFrame &= GetWebActiveFrame()
IC:[Link](WebWindow, TRUE, TRUE)
END

SeeAlso: CopyControlToWindow
122 IBC LIBRARY REFERENCE

CopyControlToWindow (copy frame control to childwindow)

CopyControlToWindow( window object, control ), PROTECTED

CopyControlToWindow
Copies the specified control from the application frame
to another window.
window object The label of the WebWindowClass object that represents
the WINDOW that receives the copied control.
control An integer constant, variable, EQUATE, or expression
containing the number (field equate) of the control to
copy.
The CopyControlToWindow method CREATEs a copy of the specified
frame control on the current (child) WINDOW. This allows the simulation of
standard Windows (menu and toolbar) merging behavior within Web pages
as seen through the Client browser.

This method is PROTECTED, therefore, it can only be called by a

WebFrameClass method, or a method in a class derived from
WebFrameClass.

Implementation: The CopyControlToWindow method CREATEs a copy of the specified frame

control on the current (child) WINDOW. The CopyControlToWindow
method calls the [Link] method for the CREATEd
control.

Example:
[Link] PROCEDURE|
(*WebWindowClass OwnerWindow, BYTE MergeMenu, BYTE MergeTool)
CODE
IF MergeMenu
[Link](OwnerWindow, ?Exit)
[Link](OwnerWindow, ?BrowseCustomer)
[Link](OwnerWindow, ?BrowseProduct)
[Link](OwnerWindow, ?BrowseState)
[Link](OwnerWindow, ?Print)
[Link](OwnerWindow, ?PrintInvoice)
[Link](OwnerWindow, ?PrintMailingLabels)
[Link](OwnerWindow, ?PrintPriceList)
[Link](OwnerWindow, ?ReadMe)
END

SeeAlso: [Link]
CHAPTER 6 WEB FRAME CLASS 123

GetMenubarFeq(returnmenubar control number)

GetMenubarFeq, SIGNED, VIRTUAL
The GetMenubarFeq method returns the control number (field equate) of
the window’s MENUBAR.

GetMenubarFeq is a VIRTUAL method so that other base class methods can

directly call the GetMenubarFeq virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: The GetMenubarFeq method returns the value of the MenubarFeq property.

Return DataType: SIGNED

Example:
GetParentFeq PROCEDURE(SIGNED Feq, *WebWindowBaseClass OwnerWindow)
ParentFeq SIGNED,AUTO
CODE
ParentFeq = Feq{PROP:Parent}
IF (ParentFeq = 0)
CASE (Feq{PROP:Type})
OF CREATE:MENU
OROF CREATE:ITEM
ParentFeq = [Link]()
ELSE
IF (Feq{PROP:intoolbar})
ParentFeq = [Link]()
ELSE
ParentFeq = FEQ:ClientArea
END
END
END
RETURN ParentFeq

SeeAlso: MenubarFeq
124 IBC LIBRARY REFERENCE

GetToolbarFeq(returnToolbar control number)

GetToolbarFeq, SIGNED, VIRTUAL
The GetToolbarFeq method returns the control number (field equate) of the
window’s TOOLBAR.

GetToolbarFeq is a VIRTUAL method so that other base class methods can

directly call the GetToolbarFeq virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: The GetToolbarFeq method returns the value of the ToolbarFeq property.

Return DataType: SIGNED

SeeAlso: ToolbarFeq
CHAPTER 6 WEB FRAME CLASS 125

TakeEvent (a virtual to handlemenu andtoolbar events)

TakeEvent, SIGNED, VIRTUAL, PROC
The TakeEvent method is a virtual placeholder method to handle any global
menu and toolbar events from a child window. This allows the simulation of
standard Windows (menu and toolbar) merging behavior within Web pages
as seen through the Client browser.

The TakeEvent return value indicates whether the calling entity should
CYCLE to the top, BREAK out of, or continue through the current ACCEPT
loop.

TakeEvent is a VIRTUAL method so that other base class methods can

directly call the TakeEvent virtual method in a derived class. This lets you
easily implement your own custom version of this method.

This method has the PROC attribute so you can call it like a PROCEDURE
and ignore the return value.

Implementation: The [Link] method calls the

[Link] method. The Internet Connect Templates derive a
[Link] method for each Web-enabled application.

Return value EQUATEs are declared in [Link] as follows:

REPLY:NONE EQUATE(0)
REPLY:CYCLE EQUATE(1)
REPLY:BREAK EQUATE(2)

Return DataType: SIGNED

Example:
[Link] FUNCTION
FirstIteration SIGNED(1)
CODE
LOOP
IF (NOT FirstIteration)
RETURN REPLY:CYCLE
END
FirstIteration = FALSE
CASE FIELD()
OF ?BrowseCustomer
CASE EVENT()
OF EVENT:Accepted
START(BrowseCustomer,050000)
END
END
RETURN REPLY:NONE
END
RETURN REPLY:BREAK

SeeAlso: [Link]
126 IBC LIBRARY REFERENCE
CHAPTER 7 WEB WINDOW CLASSES 127

WEB WINDOW CLASSES

Overview 131
WebWindowClass Concepts ............................................................................... 131
Relationship to Other Internet Builder Classes ................................................... 132
Internet Connect Template Implementation .........................................................132
Source Files..........................................................................................................133
WebControlListClass Methods 134
Functional Organization—Expected Use ............................................................134
AddControlsToLayout (set controls for HTML generation) ...............................135
CreateHtml (generate HTML for controls) ......................................................... 136
Init (initialize the WebControlListClass object) ..................................................138
Kill (shut down the WebControlListClass object) .............................................. 138
SetParentDefaults (set a control’s children) ........................................................139
WebWindowBaseClass Properties 140
AllowJava (generate or suppress JavaScript) .......................................................140
Background (window background color) ........................................................... 140
BackImage (window wallpaper) ..........................................................................140
BorderWidth (Web page border width) ...............................................................141
CloseImage (close button graphic) ..................................................................... 141
CreateCaption (include a titlebar on the Web page) ........................................... 141
CreateClose (include a close button on the Web page) ........................................142
CreateToolbar (include a toolbar on the Web page) ............................................142
DefaultButton (enter key button) ........................................................................ 143
DefaultButtonNeeded (simulate default button) ................................................. 143
DisabledAction (default HTML for disabled controls) ...................................... 144
Files (WebClientManagerClass object) ...............................................................144
FormatBorderWidth (HTML table cell border width) .........................................145
GroupBorderWidth (group box border width).................................................... 145
HelpDocument (HTML help document) .............................................................145
HelpEnabled (HTML help enabled flag) .............................................................146
HelpRelative (remote or local help document) ....................................................146
HelpStyle (HTML help style) ..............................................................................146
HtmlOption (window/control scaling information) ............................................ 147
IsSplash (splash screen flag) ................................................................................147
MenubarFeq (menubar control number) ..............................................................148
128 IBC LIBRARY REFERENCE

MenubarType (menu placement) .........................................................................148

OptionBorderWidth (option box border width) .................................................. 148
PageBackground (web page background color) ................................................. 149
PageImage (web page wallpaper) ........................................................................149
Server (WebServerClass object) ..........................................................................149
SheetBorderWidth (sheet border width) ............................................................. 150
SnapX (horizontal control alignment factor) .......................................................150
SnapY (vertical control alignment factor) ...........................................................150
TimerAction (time released browser action) .......................................................151
TimerDelay (time interval for browser action) ....................................................151
ToolbarFeq (toolbar control number) ..................................................................152
WebWindowBaseClass Methods 153
Functional Organization—Expected Use ............................................................153
CreateChildHtml (create HTML for control’s children) .................................... 153
GetBackgroundColor (return Web window background color) ...........................154
GetBackgroundImage (return Web window wallpaper) ......................................154
GetControl (return control information) ..............................................................155
GetCreateClose (return close button flag) ...........................................................155
GetChildren (return all child controls).................................................................156
GetFirstChild (return first child control) ............................................................ 157
GetHelpHandler (return HTML to show help document) .................................. 157
GetHelpReference (return HTML help document reference)............................. 158
GetHelpTarget (return HTML HREF for help display) ...................................... 158
GetMenubarFeq (return menubar control number) .............................................158
GetPageImage (return Web page wallpaper) .......................................................159
GetShowMenubar (return menubar include/omit flag) ...................................... 159
GetShowToolbar (return toolbar include/omit flag) ........................................... 159
GetToolbarFeq (return Toolbar control number) .................................................160
GetToolbarMode (return toolbar entity) ..............................................................160
GetWebActiveFrame (return WebFrameClass reference) .................................. 161
WebWindowClass Properties 162
Authorize (require username and password) ...................................................... 162
AuthorizeArea (name of password protected Web page) ................................... 163
HtmlTarget (HtmlClass object) ............................................................................163
IsCentered (center or left-justify web window) ...................................................163
IsSecure (public or secure channel) .................................................................... 164
SentHtml (first time process) ...............................................................................164
CHAPTER 7 WEB WINDOW CLASSES 129

WebWindowClass Methods 165

Functional Organization—Expected Use ............................................................165
AddControl (add control information) ................................................................ 167
AddControlsToLayout (set controls for HTML generation) ...............................169
BodyFooter (generate HTML BODY footer) ..................................................... 170
BodyHeader (generate HTML BODY header) ....................................................171
CreateChildHtml (create HTML for control’s children) .................................... 172
CreateDummyHtmlPage (write empty Html page) ............................................ 173
CreateHtmlPage (generate HTML for a window) .............................................. 174
CreateJslData (generate Java Support Library data) ............................................175
CreatePageFooter (generate HTML page footer) ................................................176
CreatePageHeader (generate HTML page footer) .............................................. 176
CreateUnauthorizedPage (create unauthorized user page) ..................................177
GetAuthorized (check user authorization) .......................................................... 179
GetBackgroundColor (return Web window background color) ...........................180
GetBackgroundImage (return Web page wallpaper)............................................181
GetButtonInClientArea (return button present indicator) ....................................182
GetChildren (return all child controls).................................................................183
GetControl (return control information) ..............................................................184
GetControlInfo (return control reference) .......................................................... 185
GetCreateClose (return close button flag) ...........................................................186
GetFirstChild (return first child control) ............................................................ 187
GetHelpHandler (return HTML to show help document) .................................. 188
GetHelpReference (return HTML help document reference)............................. 189
GetHelpTarget (return HTML HREF for help display) ...................................... 190
GetMenubarFeq (return menubar control number) .............................................191
GetPageImage (return Web page wallpaper) .......................................................192
GetShowMenubar (return menubar include/omit flag) ...................................... 192
GetShowToolbar (return toolbar include/omit flag) ........................................... 193
GetTableAttributes (return window HTML <STYLE>) .................................... 194
GetTargetSecurity (return public or secure flag) .................................................195
GetToolbarFeq (return Toolbar control number) .................................................196
GetToolbarMode (return toolbar entity) ..............................................................197
GetWebActiveFrame (return WebFrameClass reference) ...................................198
Init (initialize the WebWindowClass object) ...................................................... 199
Kill (shut down the WebWindowClass object) ....................................................200
ResetFromControls (set control information) ..................................................... 200
SetBackground (set Web page window background) ..........................................201
SetCentered (center window in Web page) ..........................................................202
130 IBC LIBRARY REFERENCE

SetChildDefaults (set children of each control) ...................................................202

SetFormatOptions (set Web page scale and alignment) .......................................203
SetHelpDocument (enable single document Web page help) ..............................204
SetHelpURL (enable multiple document Web page help) ...................................205
SetPageBackground (set Web page background) ............................................... 206
SetPassword (require Web page password) ........................................................ 207
SetSplash (make this a splash window) .............................................................. 208
SetTimer (set Web page timer and action) ...........................................................209
SuppressControl (omit control from Web page) ................................................. 210
TakeCreatePage (fill Client request for page) .....................................................211
TakeEvent (handle browser and ACCEPT loop events) ......................................212
TakeRequest (process browser event/request) .................................................... 213
TakeUnknownSubmit (a virtual to handle unexpected requests) ....................... 214
TitleContents (set browser titlebar) .................................................................... 215
ValidatePassword (verify password) ................................................................... 216
CHAPTER 7 WEB WINDOW CLASSES 131

WebWindowClassConcepts

Typically, your Web-enabled application instantiates a local

WebWindowClass object for each Window you want to display with the
client browser. The WebWindowClass has two jobs:
• It “translates” a Clarion WINDOW to its HTML equivalent,
control by control.
• It processes requests (submit strings) from the Client. This
request processing is in addition to your application’s normal
event processing.
HTML Translation

The WebWindowClass contains a variety of properties and methods that

determine how the translation to HTML is accomplished. For example it
contains properties to specify background, menu, toolbar, and client area
colors, to specify the action to take for disabled controls, any special events
to generate for enabled controls, and many others.

The WebWindowClass creates and manages instances of the

WebControlClass as needed to translate each control in the WINDOW. See
Web Control Classes for more information.

Event Processing

The WebWindowClass handles all additional events that arise when the
Server is running at the request of a Client. This event handling is in addition
to your application’s normal event handling. Conceptually, the
WebWindowClass event processing does the following:
1 Handles any events generated by the Application Broker. The
Application Broker generates events that tell the Server what
action occurred on the Client (mouse-click, data entry, etc.), the
new contents of data fields on the Client, and what information
is requested by the Client.
2 Translates the events in item 1 to Clarion events that fall under
the application’s normal event handling. For example, an
EVENT:CloseWindow, or an EVENT:Accepted to a control.
132 IBC LIBRARY REFERENCE

3 After the normal event handling is done, sends the appropriate

HTML code and JSL data to the Application Broker for
forwarding to the Client.

Relationship toOther Internet Builder Classes

The WebWindowClass is derived from the WebWindowBaseClass, which is

in turn derived from the WebControlListClass. The WebControlListClass
manages a list of controls and their HTML equivalents. The
WebWindowBaseClass adds parent/child relationships between controls,
plus a variety of default HTML translation properties, plus a reference to the
WebClientManagerClass object and WebServerClass object.

Finally, the WebWindowClass adds the ability to generate HTML

representing the entire window, plus security, plus the “Web” event
processing for the window.

The WebWindowClass uses many of the other Internet Builder Classes.

Therefore, if your program uses the WebWindowClass, it also needs these
other classes. The declaration of these other classes is automatic when you
INCLUDE the WebWindowClass header ([Link]) in your
program’s data section.

The WebWindowClass also provides a variety of information about the

Client, the HTML translation defaults, the parents and children of controls,
etc. to the WebControlClass objects so they can generate appropriate HTML
for the represented control.

The WebWindowClass uses the WebFrameClass to “merge” global toolbar

and menu controls onto MDI windows.

Internet ConnectTemplate Implementation

The Internet Connect Templates generate code to instantiate a local

WebWindowClass object for each window your application program displays
in the client browser.

The WebWindowClass object is called WebWindow. The template generated

code “sets up” the WebWindow object at the beginning of the procedure,
“shuts down” the object at the end of the procedure, and inserts the
WebWindow object’s event handling into the procedure’s ACCEPT loop.
CHAPTER 7 WEB WINDOW CLASSES 133

SourceFiles

The WebWindowClass source code is installed by default to the \LIBSRC

folder. The source files and their components are as follows:

[Link] WebControlListClass class declarations

WebWindowBaseClass class declarations
WebWindowClass class declarations

[Link] WebControlListClass method definitions

WebWindowBaseClass method definitions
WebWindowClass method definitions

[Link] WebWindowClass translation strings

134 IBC LIBRARY REFERENCE

WebControlListClass Methods
The WebControlListClass contains the methods listed below.

Functional Organization—ExpectedUse

Typically, you will not use the WebControlListClass independently. Its

properties and methods are designed to be inherited and used by derived
classes such as the WebWindowClass. See WebWindowClass Methods—
Functional Organization for more information.
CHAPTER 7 WEBCONTROLLISTCLASS 135

AddControlsToLayout (set controls for HTMLgeneration)

AddControlsToLayout( control list, layout object ), VIRTUAL

AddControlsToLayout
Sets the controls to include in the HTML layout and
generation process.
control list The label of the structure containing the list of controls
to include in the HTML layout and generation process.
layout object The label of the LayoutHtmlClass object that optimally
arranges the controls on the generated Web page.
The AddControlsToLayout method sets the controls to include in the
HTML layout and generation process. Any controls omitted from the
generated Web page are not included in this process, for example, disabled or
hidden controls may be omitted from the generated Web page.

AddControlsToLayout is a VIRTUAL method so that other base class

methods can directly call the AddControlsToLayout virtual method in a
derived class. This lets you easily implement your own custom version of
this method.

Implementation: AddControlsToLayout assumes the control list has already been built by
appropriate calls to the [Link] method, and includes
only the “visible” controls from this list into the HTML layout process. The
[Link] method evaluates whether a control is visible.

The control list parameter must name a QUEUE with a structure the same as
the WebControlQueue declared in [Link]:
WebControlQueue QUEUE,TYPE
Feq SIGNED
ThisControl &WebControlClass
END

Example:
[Link] PROCEDURE(*LayoutHtmlClass Layout, SIGNED ParentFeq)

Children WebControlQueue

CODE
[Link](Children, ParentFeq)
[Link](Children, Layout)

SeeAlso: [Link], [Link]

136 C L A R I O N  IBC LIBRARY REFERENCE

CreateHtml (generate HTMLfor controls)

CreateHtml( control list, html object, style, snapX, snapY ), VIRTUAL

CreateHtml Generates HTML code to represent each visible control

in the control list.
control list The label of the structure containing the list of controls
to include in the HTML layout and generation process.
html object The label of the HtmlClass object that writes the HTML
code.
style A string constant, variable, EQUATE, or expression
containing any HTML STYLE specifications to apply to
all the controls.
snapX An integer constant, variable, EQUATE, or expression
containing a horizontal scaling factor used in the layout
process. Typically, the [Link] prop-
erty.
snapY An integer constant, variable, EQUATE, or expression
containing a vertical scaling factor used in the layout
process. Typically, the [Link] prop-
erty.
The CreateHtml method generates HTML code to represent each visible
control in the control list. The HTML code generation includes intelligent
layout of the controls on the resulting Web page.

CreateHtml is a VIRTUAL method so that other base class methods can

directly call the CreateHtml virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: Typically, the [Link] method builds the control list

prior to the call to CreateHTml. CreateHtml instantiates a LayoutHtmlClass
to arrange the controls and calls the AddControlsToLayout method to include
only the appropriate controls in the layout process.

The control list parameter must name a QUEUE with a structure the same as
the WebControlQueue declared in [Link]:
WebControlQueue QUEUE,TYPE
Feq SIGNED
ThisControl &WebControlClass
END
CHAPTER 7 WEBCONTROLLISTCLASS 137

Example:
[Link] PROCEDURE|
(*HtmlClass Target, SIGNED ParentFeq, STRING Style)

Controls WebControlQueue

CODE
[Link](Controls, ParentFeq)
[Link](Controls, Target, Style, [Link], [Link])

SeeAlso: AddControlsToLayout, [Link],

[Link], [Link], LayoutHtmlClass
138 C L A R I O N  IBC LIBRARY REFERENCE

Init (initialize theWebControlListClassobject)

Init, VIRTUAL
The Init method is only a virtual placeholder method to initialize the
WebControlListClass object.

Init is a VIRTUAL method so that other base class methods can directly call
the Init virtual method in a derived class. This lets you easily implement your
own custom version of this method.

SeeAlso: [Link]

Kill (shut down theWebControlListClassobject)

Kill, VIRTUAL
The Kill method is only a virtual placeholder method to shut down the
WebControlListClass object.

Kill is a VIRTUAL method so that other base class methods can directly call
the Kill virtual method in a derived class. This lets you easily implement
your own custom version of this method.
CHAPTER 7 WEBCONTROLLISTCLASS 139

SetParentDefaults (set a control’s children)

SetParentDefaults( control list, parent, coordinates )

SetParentDefaults Identifies all the children of a parent.

control list The label of a structure containing a list of controls.
parent The label of the WebControlClass object whose children
are identified.
coordinates The label of a structure containing the positional coordi-
nates of the parent.
The SetParentDefaults method identifies each child of the parent. A child is
any control in the control list whose coordinates fall entirely within
coordinates. This positional determination of parent/child relationships
results in proper alignment and processing of controls on the Web page.

Implementation: The ConfirmParent method identifies each child of the parent by setting the
child’s ParentFeq property equal to the parent’s Feq property. The
SetParentDefaults method calls the [Link]
method for each control in the control list.

The control list parameter must name a QUEUE with a structure the same as
the WebControlQueue QUEUE declared in [Link]:
WebControlQueue QUEUE,TYPE
Feq SIGNED
ThisControl &WebControlClass
END

The coordinates parameter names a GROUP with a structure the same as the
Rect GROUP declared in [Link]:
Rect GROUP,TYPE
x SIGNED
y SIGNED
width SIGNED
height SIGNED
END

Example:
[Link] PROCEDURE

Children WebControlQueue
MyRect GROUP(Rect)
END

CODE
[Link](MyRect.x, MyRect.y, [Link], [Link])
[Link](Children, [Link], CREATE:Region)
[Link](Children, SELF, MyRect)

SeeAlso: [Link]
140 C L A R I O N  IBC LIBRARY REFERENCE

WebWindowBaseClass Proper ties

The WebWindowBaseClass contains the properties listed below.

AllowJava (generate or suppressJavaScript)

AllowJava BYTE
The AllowJava property indicates whether to generate any JavaScript within
the generated HTML code. A value of one (1) allows generation of
JavaScript; a value of zero (0) suppresses generation of JavaScript.

Tip: It isa goodideato suppressJavaScript for splashscreens

becausethecombinationof Java applets andtheClarion
TIMERattribute cantrigger bugsin somebrowsers,causing
themto lockup.
Implementation: You can use the AllowJava property to suppress all JavaScript throughout
your Web-enabled application to produce a limited function program that is
accessible from non-Java browsers.

The Init method sets the initial value of the AllowJava property to TRUE.

SeeAlso: Init

Background(window backgroundcolor)
Background LONG(COLOR:None)
The Background property indicates the background color of the Web page
window. Discrete areas of the window (caption, menubar, toolbar, and client
area) inherit this color unless overriden.

Implementation: The SetBackground method sets the value of the Background property.

SeeAlso: SetBackground

BackImage(windowwallpaper)
BackImage ANY
The BackImage property indicates the background image (wallpaper) to
apply to the Web page window. Discrete areas of the window (caption,
menubar, toolbar, and client area) inherit this image unless overriden.

Implementation: The SetBackground method sets the value of the BackImage property.

SeeAlso: SetBackground
CHAPTER 7 WEBWINDOWBASECLASS 141

BorderWidth (Webpageborder width)

BorderWidth BYTE
The BorderWidth property indicates the width or thickness of the Web page
border. A value of zero (0) displays no border. Larger values result in wider
borders.

Implementation: The Init method sets the initial value of the BorderWidth property to two (2).

SeeAlso: Init

CloseImage(closebuttongraphic)
CloseImage STRING(FILE:MaxFileName)
The CloseImage property contains the pathname of the image to display on
the Close Button generated by the WebWindowClass object.

Implementation: The WebWindowClass object creates the Close Button (or not) based on the
value of the CreateClose property. The Init method sets the value of the
CloseImage property. The default CloseImage value is ‘[Link].’

SeeAlso: CreateClose, Init

CreateCaption(includea titlebar ontheWebpage)

CreateCaption BYTE
The CreateCaption property indicates whether to include a caption (titlebar)
on the Web page. A value of one (1) includes a caption; a value of zero (0)
omits the caption.

Tip: TheWINDOW’stitle text alwaysdisplaysin thebrowser’s

[Link], includinga captiononyourWebpagedoes
not supply anyadditional informationto theenduser;
however, it doespreservea consistent appearancebetween
theapplicationwhenrunningunderWindows andwhen
runningunder abrowser.

Implementation: The Init method sets the initial value of the CreateCaption property to TRUE.
The ResetFromControls method creates the caption.

SeeAlso: Init, ResetFromControls

142 C L A R I O N  IBC LIBRARY REFERENCE

CreateClose(includea closebuttonontheWebpage)
CreateClose BYTE
The CreateClose property indicates under what circumstances to include a
close button on the Web page. Circumstances include always, never, when
the WINDOW has a system menu (the SYSTEM attribute), and when the
WINDOW has a system menu and no “visible” BUTTONs.

The WebWindowClass provides this automatic close button primarily as a

substitute for the system menu because system menus are not supported by
HTML.

Implementation: EQUATEs for the CreateClose property are declared in [Link] as

follows:
ITEMIZE(0),PRE(CLOSE)
Never EQUATE
IfSystem EQUATE
SystemNoButton EQUATE
Always EQUATE
END

The Init method sets the initial value of the CreateClose property to
CLOSE:Always. The ResetFromControls method creates the close button.

The CloseImage property specifies the image to display on the close button.

SeeAlso: CloseImage, Init, ResetFromControls

CreateToolbar (includea toolbar ontheWebpage)

CreateToolbar BYTE
The CreateToolbar property indicates whether to include a toolbar on the
Web page. A value of one (1) includes a toolbar if there is at least one visible
toolbar control; a value of zero (0) omits the toolbar even if the window
contains visible toolbar controls.

Implementation: The Init method sets the CreateToolbar property to TRUE. The
ResetFromControls method creates the toolbar.

SeeAlso: Init, ResetFromControls

CHAPTER 7 WEBWINDOWBASECLASS 143

DefaultButton(enter key button)

DefaultButton SIGNED
The DefaultButton property contains the control number of the WINDOW’s
default button (DEFAULT attribute). The WebWindowClass uses this
property to invoke the button’s associated action when the end-user presses
the ENTER key.

DefaultButtonNeeded(simulate default button)

DefaultButtonNeeded BYTE
The DefaultButtonNeeded property indicates whether the
WebWindowClass object must simulate a default button on the Web page
where no default button exists. This property helps the WebWindowClass
object synchronize the behavior of the ENTER key when running the Server
application under Windows versus running it under a Web browser.

Under Standard Windows Behavior, pressing the ENTER key when there is no
default button does nothing. Under most browsers pressing the ENTER key
when there is no default button invokes an action roughly equivalent to the
typical Windows OK button (submits data from the current Web page and
optionally requests a new page). The DefaultButtonNeeded property allows
the WebWindowClass object to accurately simulate a default button on a
Web page that doesn’t actually have one.
144 C L A R I O N  IBC LIBRARY REFERENCE

DisabledAction(default HTMLfordisabledcontrols)
DisabledAction BYTE
The DisabledAction property sets the default treatment of any disabled
controls for generating HTML to represent them. This property lets you
determine how to handle controls that are disabled under Windows, but
cannot be disabled under a browser, because the HTML control does not
support disabling.

Valid treatments include, always display the disabled control, always hide
the disabled control, and disable the control if HTML supports it, otherwise
hide the control.

Tip: [Link]
[Link] any individual
control.

Implementation: EQUATEs for the DisabledAction property are declared in [Link]

as follows:
ITEMIZE,PRE(DISABLE)
Hide EQUATE !always hide disabled control
OptHide EQUATE !hide if HTML control won’t disable
Show EQUATE !always show disabled
control END

The Init method sets the DisabledAction property to DISABLE:Hide.

SeeAlso: Init, [Link]

Files(WebClientManagerClassobject)
Files &WebFilesClass
The Files property is a reference to the WebFilesClass object that manages
pathnames for the WebWindowClass object. The WebWindowClass uses this
property to generate appropriate pathnames whereever needed.

Implementation: The Init method sets the Files property to reference the [Link] property.

SeeAlso: Init, [Link]

CHAPTER 7 WEBWINDOWBASECLASS 145

FormatBorderWidth (HTML table cell border width)

FormatBorderWidth BYTE
The FormatBorderWidth property indicates the width or thickness of each
HTML table cell in the Web page. A value of zero (0) displays no borders.
Larger values result in wider borders.

This property is primarily a debugging tool to help you see how and why
each control is placed where it is on the generated Web page.

Implementation: The Init method sets the FormatBorderWidth property to zero (0).

SeeAlso: Init

GroupBorderWidth (groupbox border width)

GroupBorderWidth BYTE
The GroupBorderWidth property indicates the width or thickness of Web
page Group box borders. A value of zero (0) displays no border. Larger
values result in wider borders.

Implementation: The Init method sets the GroupBorderWidth property to two (2).

SeeAlso: Init

HelpDocument (HTML help document)

HelpDocument ANY
The HelpDocument property contains the pathname or the URL of the
HTML help document for the Server (Web-enabled application).

Implementation: The SetHelpDocument method or the SetHelpURL method sets the value of
the HelpDocument property.

SeeAlso: SetHelpDocument, SetHelpURL

146 C L A R I O N  IBC LIBRARY REFERENCE

HelpEnabled(HTML help enabledflag)

HelpEnabled BYTE
The HelpEnabled property indicates whether a help document is specified
for the WebWindowClass object. A value of one (1 or True) indicates a help
document; a value of zero (0 or False) indicates no help document.

Implementation: The SetHelpDocument method or the SetHelpURL method sets the value of
the HelpDocument property to True.

SeeAlso: HelpDocument, SetHelpDocument, SetHelpURL

HelpRelative(remote or local help document)

HelpRelative BYTE
The HelpRelative property indicates whether the HelpDocument property
contains a pathname relative to the Application Broker or an independent
URL. A value of one (1 or True) indicates a pathname relative to the
Application Broker; a value of zero (0 or False) indicates an independent
URL.

Implementation: The SetHelpDocument method sets the HelpRelative property to True. The
SetHelpURL method sets the HelpRelative property to False.

SeeAlso: HelpDocument, SetHelpDocument, SetHelpURL

HelpStyle (HTML help style)

HelpStyle ANY
The HelpStyle property contains...

Implementation: The SetHelpDocument and SetHelpURL methods set the HelpStyle property.

SeeAlso: SetHelpDocument, SetHelpURL

CHAPTER 7 WEBWINDOWBASECLASS 147

HtmlOption(window/control scalinginformation)
HtmlOption LIKE(HtmlOptionGroup)
The HtmlOption property contains information for proper scaling and
positioning of controls on the Web page. The actual effect of this property is
determined by the HtmlClass object that applies the information.

Implementation: The SetFormatOptions method sets the values of the HtmlOption property.
These values are used for converting dialog units to pixels for scaling
purposes.

The HtmlOptionGroup is declared in [Link] as follows:

HtmlOptionGroup GROUP,TYPE
ScaleX REAL !horizontal conversion factor
ScaleY REAL !vertical conversion
factor END

The HtmlClass object stores HtmlOption information in the

[Link] property.

SeeAlso: SetFormatOptions, [Link]

IsSplash(splashscreenflag)
IsSplash BYTE
The IsSplash property indicates whether the WINDOW serves as a splash
screen. A value of one (1) indicates a splash screen; a value of zero (0)
indicates some other purpose. The WebWindowClass uses this property to
generate any HTML unique to splash screens.

Implementation: The SetSplash method sets the value of the IsSplash property.

By convention, Windows splash screens close immediately upon an end user

mouse-click anywhere in the window. Browsers and HTML do not support
this behavior; therefore, the WebWindowClass generates an HTML control to
accept the mouse-click and close the window.

SeeAlso: SetSplash
148 C L A R I O N  IBC LIBRARY REFERENCE

MenubarFeq(menubar control number)

MenubarFeq SIGNED
The MenubarFeq property contains the control number (field equate) of the
MENUBAR. The WebWindowClass uses this property to refer to the
WINDOW’s MENUBAR structure.

Implementation: The Init method sets the initial value of the MenubarFeq property. The
GetMenubarFeq method returns the value of the MenubarFeq property.

SeeAlso: Init, GetMenubarFeq

MenubarType(menu placement)
MenubarType SIGNED
The MenubarType property indicates where the WebWindowClass places
the menu items on the Web page. Valid options are above the toolbar, left
side of the window, or omit the menu items from the Web page.

Implementation: The Init method sets the MenubarType property to PROP:none which omits
menu items. To include menu items on the Web page, you must assign a
value to the MenubarType property after the Init method executes.

EQUATEs for the MenubarType property are declared in [Link]

as follows:
PROP:none EQUATE(0)

and in [Link] as follows:

PROP:above EQUATE(7C0AH) ! 0 = off, else on
PROP:left EQUATE(7C08H) ! 0 = off, else on

SeeAlso: Init

OptionBorderWidth (optionbox border width)

OptionBorderWidth BYTE
The OptionBorderWidth property indicates the width or thickness of Web
page Optin box borders. A value of zero (0) displays no border. Larger
values result in wider borders.

Implementation: The Init method sets the OptionBorderWidth property to two (2).

SeeAlso: Init
CHAPTER 7 WEBWINDOWBASECLASS 149

PageBackground(webpage backgroundcolor)
PageBackground LONG(COLOR:None)
The PageBackground property indicates the background color of the Web
page.

Implementation: The SetPageBackground method sets the value of the PageBackground

property.

SeeAlso: SetPageBackground

PageImage(webpagewallpaper)
PageImage ANY
The PageImage property indicates the background image (wallpaper) to
apply to the Web page.

Implementation: The SetPageBackground method sets the value of the PageImage property.

SeeAlso: SetPageBackground

Server (WebServerClassobject)
Server &WebServerClass
The Server property is a reference to the WebServerClass object that
represents the Server application for the WebWindowClass object. The
WebWindowClass relies on this property to supply information about the
Client browser, to supply appropriate pathnames, to handle events
originating from the Client browser, and to interact with the BrokerClass
object as needed.

Implementation: The Init method sets the initial value of the Server property—typically to
reference a global instance of the WebServerClass.

SeeAlso: Init
150 C L A R I O N  IBC LIBRARY REFERENCE

SheetBorderWidth (sheet border width)

SheetBorderWidth BYTE
The SheetBorderWidth property indicates the width or thickness of Web
page Sheet borders. A value of zero (0) displays no border. Larger values
result in wider borders.

Implementation: The Init method sets the SheetBorderWidth property to two (2).

SeeAlso: Init

SnapX(horizontal control alignment factor)

SnapX SIGNED
The SnapX property contains a horizontal “snap to” factor for aligning or
laying out controls on the Web page. The actual effect of the this property is
determined by the LayoutHtmlClass object that arranges the window
controls and applies the factor.

Implementation: The SetFormatOptions method sets the initial value of the SnapX property.

SeeAlso: SetFormatOptions, [Link]

SnapY(vertical control alignment factor)

SnapY SIGNED
The SnapY property contains a vertical “snap to” factor for aligning or
laying out controls on the Web page. The actual effect of the this property is
determined by the LayoutHtmlClass object that arranges the window
controls and applies the factor.

Implementation: The SetFormatOptions method sets the initial value of the SnapY property.

SeeAlso: SetFormatOptions, [Link]

CHAPTER 7 WEBWINDOWBASECLASS 151

TimerAction(time releasedbrowser action)

TimerAction BYTE, PROTECTED
The TimerAction property specifies an action the browser takes after the
time interval set by the TimerDelay property. The action is repeated each
time the TimerDelay interval expires.

There are four valid actions, three of which consist of a request to the Server
for an update of the Web page. Update:Full submits any entered items and
requests a complete screen redraw. Update:Partial submits any entered items
and requests only the data to fill Java controls (see JSL Manager Class).
Update:Refresh is only valid for the windows with a TimerDelay. It submits
no items but requests a complete screen redraw when the timer runs out.
Update:OnBrowser updates the Web page as far as possible without
contacting the Server.

This property is PROTECTED, therefore, it can only be referenced by a

WebWindowClass method, or a method in a class derived from
WebWindowClass.

Implementation: EQUATEs for the TimerAction property are declared in [Link] as

follows:
Update:OnBrowser EQUATE(0)
Update:Partial EQUATE(1)
Update:Full EQUATE(2)
Update:Refresh EQUATE(3)

The Init method sets the initial value of the TimerAction property to zero (0).
The SetTimer method sets subsequent values of the TimerAction property.

SeeAlso: Init, SetSplash, SetTimer, TimerDelay

TimerDelay (time interval forbrowser action)

TimerDelay SIGNED, PROTECTED
The TimerDelay property contains the time period for Java applets to wait
before initiating the action specified by the TimerAction property.

This property is PROTECTED, therefore, it can only be referenced by a

WebWindowClass method, or a method in a class derived from
WebWindowClass.

Implementation: The Init method sets the initial value of the TimerDelay property to zero (0).
The SetTimer method sets subsequent values of the TimerDelay property.

SeeAlso: Init, SetSplash, SetTimer, TimerAction

152 C L A R I O N  IBC LIBRARY REFERENCE

ToolbarFeq(toolbar control number)

ToolbarFeq SIGNED
The ToolbarFeq property contains the control number (field equate) of the
TOOLBAR. The WebWindowClass uses this property to refer to the
WINDOW’s TOOLBAR structure.

Implementation: The Init method sets the initial value of the ToolbarFeq property. The
GetToolbarFeq method returns the value of the ToolbarFeq property.

SeeAlso: Init, GetToolbarFeq

CHAPTER 7 WEBWINDOWBASECLASS 153

WebWindowBaseClass Methods
The WebWindowBaseClass inherits all the methods of the
WebControlListClass from which it is derived.

In addition to (or instead of) the inherited methods, the

WebWindowBaseClass contains the methods listed below.

Functional Organization—ExpectedUse

The WebWindowBaseClass is an abstract class. Its methods are not

implemented; rather, they are simply placeholders for derived classes such as
the WebWindowClass. See WebWindowClass Methods—Functional
Organization—Expected Use for more information.

CreateChildHtml (create HTMLfor control’s children)

CreateChildHtml( html target, parent control [, border width] ), VIRTUAL

CreateChildHtml A virtual placeholder to generate HTML codefor each

child control of the parent control.
html target The label of the HtmlClass object that writes the HTML
code.
parent control An integer constant, variable, EQUATE, or expression
containing parent control’s the field equate number, or
the WINDOW’s field equate number, that is, zero (0).
border width An integer constant, variable, EQUATE, or expression
containing the border width for the parent control. If
omitted, border width defaults to zero (0).
The CreateChildHtml method is only a virtual placeholder to generate
HTML codefor each child control of the parent control.

CreateChildHtml is a VIRTUAL method so that other base class methods can

directly call the CreateChildHtml virtual method in a derived class. This lets
you easily implement your own custom version of this method.

SeeAlso: [Link]
154 C L A R I O N  IBC LIBRARY REFERENCE

GetBackgroundColor (returnWebwindow backgroundcolor)

GetBackgroundColor( [default color] ), LONG, VIRTUAL

GetBackgroundColor
A virtual placeholder to return the background color of
the Web page window.
default color An integer variable, constant, EQUATE, or expression
containing the color to return if there is no background
color. If omitted, default color defaults to Color:None.
The GetBackgroundColor method is only a virtual placeholder to return the
background color of the Web page.

GetBackgroundColor is a VIRTUAL method so that other base class

methods can directly call the GetBackgroundColor virtual method in a
derived class. This lets you easily implement your own custom version of
this method.

Return DataType: LONG

SeeAlso: Background, [Link]

GetBackgroundImage (returnWebwindowwallpaper)
GetBackgroundImage, STRING, VIRTUAL
The GetBackgroundImage method is only a virtual placeholder to return
the filename containing the background image of the Web page window.

GetBackgroundImage is a VIRTUAL method so that other base class

methods can directly call the GetBackgroundImage virtual method in a
derived class. This lets you easily implement your own custom version of
this method.

Return DataType: STRING

SeeAlso: BackImage, [Link]

CHAPTER 7 WEBWINDOWBASECLASS 155

GetControl (return control information)

GetControl( control [, control information] ), BYTE, VIRTUAL

GetControl A virtual placeholder to return information for the

specified control.
control An integer constant, variable, EQUATE, or expression
containing the control’s field equate number.
control information The label of a structure to contain the control informa-
tion. If omitted, GetControl returns a true or false value
indicating whether the WebWindowClass object
“knows” about the control.
The GetControl method is only a virtual placeholder to return information
for the specified control.

GetControl is a VIRTUAL method so that other base class methods can

directly call the GetControl virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The control information parameter names a structure like the

WebControlRefGroup GROUP declared in [Link] as follows:
WebControlRefGroup GROUP,TYPE
Control &WebControlClass
END

Return DataType: BYTE

SeeAlso: [Link]

GetCreateClose(return closebuttonflag)
GetCreateClose, BYTE, VIRTUAL
The GetCreateClose method is only a virtual placeholder. It returns a value
indicating whether to create a close button on the Web page.
GetCreateClose is a VIRTUAL method so that other base class methods can
directly call the GetCreateClose virtual method in a derived class. This lets
you easily implement your own custom version of this method.
Return DataType: BYTE
SeeAlso: [Link]
156 C L A R I O N  IBC LIBRARY REFERENCE

GetChildren(return all child controls)

GetChildren( children, parent control [, control type] ), VIRTUAL

GetChildren A virtual placeholder to return information about the

children of the specified parent control.
children The label of a structure to contain the references or
control numbers of the child controls.
parent control An integer constant, variable, EQUATE, or expression
containing the parent control’s control number, or zero
(0) if the WINDOW is the parent.
control type An integer constant, variable, EQUATE, or expression
indicating the type of control to include, or exclude. A
negative control type excludes controls of the specified
type. A positive control type includes controls of the
specified type. If omitted, all control types are included.
The GetChildren method is only a virtual placeholder to return information
about the children of the specified parent control.
GetChildren is a VIRTUAL method so that other base class methods can
directly call the GetChildren virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The children parameter is a QUEUE with the same structure as the
WebControlQueue declared in [Link] as follows:
WebControlQueue QUEUE,TYPE
Feq SIGNED
ThisControl &WebControlClass
END

EQUATEs for the control type parameter are declared in [Link].

Each control type EQUATE is prefixed with CREATE:.

SeeAlso: [Link]
CHAPTER 7 WEBWINDOWBASECLASS 157

GetFirstChild (return first child control)

GetFirstChild( parent control [, control type] ), SIGNED, VIRTUAL

GetFirstChild A virtual placeholder to return the control number of the

first visible child of the specified parent control.
parent control An integer constant, variable, EQUATE, or expression
containing the parent control’s control number, or zero
(0) if the WINDOW is the parent.
control type An integer constant, variable, EQUATE, or expression
containing the type of child control for which to search.
If omitted, any control type is valid.
The GetFirstChild method is only a virtual placeholder to return the control
number of the first visible child of the specified parent control.

GetFirstChild is a VIRTUAL method so that other base class methods can

directly call the GetFirstChild virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: EQUATEs for the control type parameter are declared in [Link].
Each control type EQUATE is prefixed with CREATE:.

Return DataType: SIGNED

SeeAlso: [Link]

GetHelpHandler (return HTML to showhelp document)

GetHelpHandler, STRING, VIRTUAL
The GetHelpHandler method is only a virtual placeholder to return the
HTML to request the help document associated with the Web page.

GetHelpHandler is a VIRTUAL method so that other base class methods can

directly call the GetHelpHandler virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Return DataType: STRING

SeeAlso: HelpDocument, [Link]

158 C L A R I O N  IBC LIBRARY REFERENCE

GetHelpReference(return HTML help document reference)

GetHelpReference, STRING, VIRTUAL
The GetHelpReference method is only a virtual placeholder to return the
HTML reference for a specific help display. The returned value depends on
the values of the HelpDocument and HelpRelative properties.

GetHelpReference is a VIRTUAL method so that other base class methods

can directly call the GetHelpReference virtual method in a derived class.
This lets you easily implement your own custom version of this method.

Return DataType: STRING

SeeAlso: HelpDocument, HelpRelative, [Link]

GetHelpTarget (return HTMLHREF for help display)

GetHelpTarget, STRING, VIRTUAL
The GetHelpTarget method is only a virtual placeholder to return the
HTML <HREF> for a specific help display. The returned value depends on
the values of the HelpDocument and HelpRelative properties.

GetHelpTarget is a VIRTUAL method so that other base class methods can

directly call the GetHelpTarget virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Return DataType: STRING

SeeAlso: GetHelpReference, HelpDocument, HelpRelative,

[Link]

GetMenubarFeq(returnmenubar control number)

GetMenubarFeq, SIGNED, VIRTUAL
The GetMenubarFeq method is only a virtual placeholder to return the
control number (field equate) of the window’s MENUBAR.

GetMenubarFeq is a VIRTUAL method so that other base class methods can

directly call the GetMenubarFeq virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Return DataType: SIGNED

SeeAlso: MenubarFeq, [Link]

CHAPTER 7 WEBWINDOWBASECLASS 159

GetPageImage(returnWebpagewallpaper)
GetPageImage, STRING, VIRTUAL
The GetPageImage method is only a virtual placeholder to return the
filename of the file containing the background image of the Web page.

GetPageImage is a VIRTUAL method so that other base class methods can

directly call the GetPageImage virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Return DataType: STRING

SeeAlso: PageImage, [Link]

GetShowMenubar (returnmenubar include/omit flag)

GetShowMenubar, BYTE, VIRTUAL
The GetShowMenubar method is only a virtual placeholder to return a
value indicating whether to include a menubar on the window.

GetShowMenubar is a VIRTUAL method so that other base class methods

can directly call the GetShowMenubar virtual method in a derived class. This
lets you easily implement your own custom version of this method.

Return DataType: BYTE

SeeAlso: [Link]

GetShowToolbar (return toolbar include/omit flag)

GetShowToolbar, BYTE, VIRTUAL
The GetShowToolbar method is only a virtual placeholder to return a value
indicating whether to include a toolbar on the window.

GetShowToolbar is a VIRTUAL method so that other base class methods can

directly call the GetShowToolbar virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Return DataType: BYTE

SeeAlso: [Link]
160 C L A R I O N  IBC LIBRARY REFERENCE

GetToolbarFeq(returnToolbar control number)

GetToolbarFeq, SIGNED, VIRTUAL
The GetToolbarFeq method is only a virtual placeholder to return the
control number (field equate) of the window’s TOOLBAR.

GetToolbarFeq is a VIRTUAL method so that other base class methods can

directly call the GetToolbarFeq virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Return DataType: SIGNED

SeeAlso: ToolbarFeq, [Link]

GetToolbarMode(return toolbar entity)

GetToolbarMode, BYTE, VIRTUAL
The GetToolbarMode method is only a virtual placeholder to return a value
indicating what the toolbar is driving. For example, a BrowseBox, a Relation
Tree, or an update form.

GetToolbarMode is a VIRTUAL method so that other base class methods can

directly call the GetToolbarMode virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: EQUATEs for GetToolbarMode return values are declared in [Link]

as follows:
FormMode EQUATE(1)
BrowseMode EQUATE(2)
TreeMode EQUATE(3)

Return DataType: BYTE

SeeAlso: [Link]
CHAPTER 7 WEBWINDOWBASECLASS 161

GetWebActiveFrame (returnWebFrameClassreference)
GetWebActiveFrame, WebFrameClass, VIRTUAL
The GetWebActiveFrame method is only a virtual placeholder to return a
reference to the active WebFrameClass.

GetWebActiveFrame is a VIRTUAL method so that other base class methods

can directly call the GetWebActiveFrame virtual method in a derived class.
This lets you easily implement your own custom version of this method.

Return DataType: WebFrameClass

SeeAlso: [Link]
162 IBC LIBRARY REFERENCE

WebWindowClass Proper ties

The WebWindowClass inherits all the properties of the
WebWindowBaseClass from which it is derived. See WebWindowBaseClass
Properties for more information.

In addition to the inherited properties, the WebWindowClass contains the

properties listed below.

Authorize (require username andpassword)

Authorize BYTE
The Authorize property indicates whether a valid username and password
are required to access the Web page representing this window.

A value of one (1) indicates username and password are required. A value of
zero (0) indicates no username and password are required. The
WebWindowClass uses this property to provide procedure level security.

Implementation: The Init method sets the initial value of the Authorize property to False. The
SetPassword method sets the Authorize property to True.

The SetPassword method sets the Authorize property to true, to password

protect the Web page (AuthorizeArea). It also sets the authorized password
for the AuthorizeArea. The GetAuthorized method collects and validates the
end user’s password for the AuthorizeArea. The ValidatePassword method
verifies the password entered by the end user. Finally, the TakeCreatePage
method generates an “access denied” page (CreateUnauthorizedPage) for
invalid passwords.

SeeAlso: AuthorizeArea, CreateUnauthorizedPage, GetAuthorized, TakeCreatePage,

SetPassword, ValidatePassword
CHAPTER 7 WEBWINDOWCLASS 163

AuthorizeArea(name ofpassword protectedWebpage)

AuthorizeArea ANY
The AuthorizeArea property contains the identity of a Web page (procedure)
within the Server application that may be password protected. The Client
browser displays the contents of the AuthorizeArea property when
prompting the end user for an authorized username and password.

Implementation: The Init method sets the initial value of the AuthorizeArea. The Internet
Connect Templates set AuthorizeArea to window title + procedure name.

The SetPassword method sets the Authorize property to true, to password

SeeAlso: Authorize, CreateUnauthorizedPage, GetAuthorized, TakeCreatePage,

SetPassword, ValidatePassword

HtmlTarget (HtmlClassobject)
HtmlTarget &HtmlClass
The HtmlTarget property is a reference to the HtmlClass object that writes
HTML code representing the window. The WebWindowClass uses this
property to generate HTML code.

Implementation: The Init method sets the value of the HtmlTarget property.

SeeAlso: Init

IsCentered(center or left-justifywebwindow)
IsCentered BYTE
The IsCentered property indicates whether the window is centered within
the generated Web page. A value of one (1) centers the window; a value of
zero (0) left justifies the window.

Implementation: The Init method sets the value of the IsCentered property to True.

SeeAlso: Init
164 IBC LIBRARY REFERENCE

IsSecure (public or secure channel)

IsSecure BYTE
The IsSecure property determines whether HTML code and JSL data
repesenting the window are sent through a secure channel or a public
channel. A value of one (1 or True) transmits on a secure channel; a value of
zero (0 or False) transmits on a public channel.

There are significant performance penalties associated with the use of secure
channels, so we recommend using them only when circumstances demand it;
for example, when transmitting credit card numbers or other very sensitive
information.

Secure channels are not supported by all configurations of all Web-servers.

See Security in the Application Broker in the Internect Connect User’s Guide
for more information on setting up secure channels.

Implementation: The Init method sets the IsSecure property to False.

A secure channel consists of a secure Web-server directory to contain any

intermediate or temporary files, plus encryption of data prior to its
transmission, and finally, decryption of the data when it reaches its
destination.

SeeAlso: Init

SentHtml (first time process)

SentHtml BYTE
The SentHtml property indicates whether the HTML code representing the
window has been sent to the Client at least once. A value of one (1) indicates
the page was sent; a value of zero (0) indicates the page has not been sent.

The WebWindowClass uses this property to ensure a page is sent to the

browser before any updates to the page are sent (that is, when you change
procedures/windows), and to initiate any one-time only processing for the
window, such as prompting for Username and Password.

Implementation: The CreateHtmlPage method sets the SentHtml property to True.

SeeAlso: CreateHtmlPage
CHAPTER 7 WEBWINDOWCLASS 165

WebWindowClass Methods
The WebWindowClass inherits all the methods of the WebWindowBaseClass
from which it is derived.

In addition to (or instead of) the inherited methods, the WebWindowClass

contains the methods listed below.

Functional Organization—ExpectedUse

As an aid to understanding the WebWindowClass, it is useful to organize its

methods into two categories according to their expected use—the primary
interface and the virtual methods. This organization reflects what we believe
is typical use of these methods.

Primary Interface Methods

The primary interface methods, which you are likely to call fairly routinely
from your program, can be further divided into three categories:

Housekeeping (one-time) Use:

Init initialize WebWindowClass object
SetBackground set Web window background
SetPageBackground set Web page background
SetFormatOptions set Web page scale and snap to
SetHelpDocument enable Web page help
SetHelpURL enable Web page help
SetParentDefaults set default parent for each control
SetPassword require password
SetSplash make this a splash window
SetTimer set Web page timer and action
KillV shut down WebWindowClass object
V
These methods are also Virtual.

Mainstream Use:
TakeEvent handle browser & ACCEPT loop events

Occasional Use:
CreateDummyHtmlPage write empty Html page
CreateHtmlPage generate HTML for a window
CreateJslData generate Java Support Library data
CreatePageFooter generate HTML page footer
CreatePageHeader generate HTML page footer
CreateUnauthorizedPage create unauthorized user page
GetAuthorized check user authorization
GetButtonInClientArea return button present indicator
166 IBC LIBRARY REFERENCE

GetHelpHandler return HTML to show help document

GetHelpReference return help document reference
GetHelpTarget return HTML HREF for help display
GetTargetSecurity return public or secure flag
SetCentered center or left-justify window
SuppressControl omit control from Web page
ResetFromControls set control information

Virtual Methods

AddControl add control information

AddControlsToLayout set controls for HTML generation
BodyFooter generate HTML BODY footer
BodyHeader generate HTML BODY header
CreateChildHtml create HTML for control’s children
CreateHtml generate HTML for controls
GetBackgroundColor return Web window background color
GetBackgroundImage return Web window wallpaper
GetChildren return all child controls
GetControl return control information
GetControlInfo return control reference
GetCreateClose return close button flag
GetFirstChild return first child control
GetHelpHandler return HTML to show help document
GetHelpReference return HTML help reference
GetHelpTarget return HTML HREF for help display
GetMenubarFeq return MENUBAR field equate
GetPageImage return Web page wallpaper
GetShowMenubar return menubar include/omit flag
GetShowToolbar return toolbar include/omit flag
GetToolbarFeq return TOOLBAR field equate
GetToolbarMode return toolbar entity
GetWebActiveFrame return active WebFrameClass reference
Kill shut down WebWindowClass object
TakeCreatePage fill Client request for page
TakeRequest process browser event/request
TakeUnknownSubmit process unknown field assignment
TitleContents set browser titlebar
ValidatePassword verify password
CHAPTER 7 WEBWINDOWCLASS 167

AddControl (add control information)

AddControl( control [,type] ), &WebControlClass, VIRTUAL, PROC

AddControl Adds information about a control or pseudo-control for

this window.
control An integer constant, variable, EQUATE, or expression
containing a control number or the label of a
WebControlClass object.
type An integer constant, variable, EQUATE, or expression
indicating the type of control or the label of a
WebControlClass object. If omitted, AddControl intelli-
gently determines the appropriate control type.
The AddControl method adds information about a control or pseudo-control
for this window. The WebWindowClass object uses this information to
generate HTML code to represent the window in the Client browser.

The information may represent a Clarion control within the WINDOW

structure, a pseudo-control, such as the window titlebar or client area, or it
may represent a control that appears only on the Web page and not on the
WINDOW, such as a global toolbar button on an MDI child window.

AddControl is a VIRTUAL method so that other base class methods can

directly call the AddControl virtual method in a derived class. This lets you
easily implement your own custom version of this method.

This method has the PROC attribute, so you can call it like a PROCEDURE
and ignore the return value.
AddControl(control)
If control is a field equate, AddControl instantiates a
WebControlClass object of the appropriate type, adds it to the
control list, and returns a reference to the new control object.
If control is a WebControlClass object, AddControl adds the
object to the control list, but does not initialize it. There is no
return value.
AddControl(control, type)
If type is a control type, AddControl instantiates a
WebControlClass object of the specified type, then adds it to the
control list, and returns a reference to the new control object.
If type is a WebControlClass object, AddControl initializes the
object, then adds it to the control list. There is no return value.
Return DataType: &WebControlClass

Implementation: The AddControl method adds a WebControlClass object to the list of control
168 IBC LIBRARY REFERENCE

objects for this window. The AddControl method may instantiate a new
WebControlClass object then add it to the list, or it may add an existing
object to the list.

Example:
WebMenubar WebMenubarClass !declare WebMenubar control object
CODE
[Link](?InsertButton) !instantiate & add a real control
IC:CurControl &= [Link](?CustList)!instantiate & add a real control
IC:[Link](CustQ) ! and use the returned reference
[Link](?Feq:Menubar, WebMenubar) !add an existing control object
[Link](FEQ:Caption, CREATE:Caption) !instantiate & add a psuedo-control
[Link](FEQ:Close, CREATE:Close) !instantiate & add Web only control

SeeAlso: WebControlClass
CHAPTER 7 WEBWINDOWCLASS 169

AddControlsToLayout (set controls for HTMLgeneration)

AddControlsToLayout( layout object, parent control ), VIRTUAL

AddControlsToLayout
Sets the controls to include in the HTML layout and
generation process.
layout object The label of the LayoutHtmlClass object that optimally
arranges the controls on the generated Web page.
parent control An integer constant, variable, EQUATE, or expression
containing a control number of the control whose
children are included in the layout process, or zero (0) if
the window is the parent.
The AddControlsToLayout method sets the controls to include in the
HTML layout and generation process. The AddControlsToLayout method
includes only “visible” controls; that is, it excludes disabled and hidden
controls from the Web page layout process.

AddControlsToLayout is a VIRTUAL method so that other base class

methods can directly call the AddControlsToLayout virtual method in a
derived class. This lets you easily implement your own custom version of
this method.

Implementation: AddControlsToLayout selects from the WebWindowClass’ list of controls. It

assumes the control list has already been built by appropriate calls to the
AddControl method, and includes only the “visible” controls from this list
into the HTML layout process. The GetVisible method evaluates whether a
control is visible.

Example:
[Link] PROCEDURE(*WebControlQueue Source, |
*HtmlClass Target, STRING style, SIGNED SnapX, SIGNED SnapY)

Layout LayoutHtmlClass

CODE
[Link](style, SnapX, SnapY)
[Link](Source, Layout)
[Link](Target)
[Link]

SeeAlso: AddControl, GetVisible

170 IBC LIBRARY REFERENCE

BodyFooter (generate HTML BODY footer)

BodyFooter( html target ), VIRTUAL

BodyFooter A virtual placeholder to generate HTML BODY footer

code.
html target The label of the HtmlClass object that writes the HTML
code.
The BodyFooter method is a virtual placeholder to generate HTML BODY
footer code.

BodyFooter is a VIRTUAL method so that other base class methods can

directly call the BodyFooter virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The CreatePageFooter method calls the BodyFooter method.

The [Link] method does nothing. It is a placeholder

for use by derived classes. In particular, the Internet Connect Templates use
this method to support HTML code embedded in Web-enabled Clarion
applications.

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE

IF [Link]
[Link]([Link]*1000, [Link])
END
[Link]
IF [Link]
[Link]
END
[Link](Target)
IF ([Link])
[Link]('<</CENTER>')
END
[Link]('<</BODY>')

[Link]('<</HTML>')

SeeAlso: CreatePageFooter
CHAPTER 7 WEBWINDOWCLASS 171

BodyHeader (generate HTML BODY header)

BodyHeader( html target ), VIRTUAL

BodyHeader A virtual placeholder to generate HTML BODY header

code.
html target The label of the HtmlClass object that writes the HTML
code.
The BodyHeader method is a virtual placeholder to generate HTML BODY
header code.

BodyHeader is a VIRTUAL method so that other base class methods can

directly call the BodyHeader virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The CreatePageHeader method calls the BodyHeader method.

The [Link] method does nothing. It is a placeholder

for use by derived classes. In particular, the Internet Connect Templates use
this method to support HTML code embedded in Web-enabled Clarion
applications.

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE
[Link]('<<HTML>')
[Link]()
[Link]('<<HEAD>')
[Link]('<<TITLE>')
[Link](Target)
[Link]('<</TITLE>')
[Link]('<</HEAD>')
[Link]('<<BODY')
IF ([Link] <> COLOR:None)
[Link](' BGCOLOR="' & IC:ColorText([Link]) & '"')
END
[Link](' onLoad="setuptimer()" onUnload="killtimer()">')
[Link]('<<CENTER>')
[Link]()
[Link](Target)

SeeAlso: CreatePageHeader
172 IBC LIBRARY REFERENCE

CreateChildHtml (create HTMLfor control’s children)

CreateChildHtml( html target, parent control [, border width] ), VIRTUAL

CreateChildHtml Generates HTML codefor each child control of the

specified parent control.
html target The label of the HtmlClass object that writes the HTML
code.
parent control An integer constant, variable, EQUATE, or expression
containing the parent control’s field equate number, or
zero (0) if the WINDOW is the parent.
border width An integer constant, variable, EQUATE, or expression
containing the border width for the parent control. If
omitted, border width defaults to zero (0).
The CreateChildHtml method generates HTML codefor each child control
of the parent control. The generated HTML code includes JavaScript where
appropriate.

The WebWindowClass uses the CreateChildHtml method to generate HTML

code for each parent control within the WINDOW, until the entire WINDOW
is represented by the generated HTML.

CreateChildHtml is a VIRTUAL method so that other base class methods can

directly call the CreateChildHtml virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: The CreateHtmlPage method calls the CreateChildHtml method.

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE
[Link](Target, [Link], [Link]())
[Link]
CHAPTER 7 WEBWINDOWCLASS 173

CreateDummyHtmlPage(write empty Html page)

CreateDummyHtmlPage( html target, filename )

CreateDummyHtmlPage
Generates an empty HTML page.
html target The label of the HtmlClass object that writes the HTML
code.
filename A string constant, variable, EQUATE, or expression
containing the HTML code filename.
The CreateDummyHtmlPage method generates an empty HTML page for
transmittal to the client browser.

Implementation: The WebWindowClass uses the CreateDummyHtmlPage for circumstances

where the client browser requests a partial page, but the Server determines
that a full page is required. By sending a dummy page, the Server elicits a
full page request from the client browser.

Example:
[Link] PROCEDURE

Client &WebClientManagerClass
Filename CSTRING(FILE:MaxFilePath),AUTO

CODE
Client &= [Link]
[Link]([Link]())
IF ([Link]() OR NOT [Link])
Filename = [Link](Content:Html)
IF ([Link]())
[Link]
[Link]([Link], Filename)
ELSE
Filename = [Link]() & '[Link]'
[Link]([Link], Filename)
END
[Link](Filename, [Link](), FALSE)
ELSE
[Link]([Link](), [Link])
[Link]([Link])
[Link]
END
[Link]()
174 IBC LIBRARY REFERENCE

CreateHtmlPage(generate HTMLforawindow)
CreateHtmlPage( html target, filename )

CreateHtmlPage Generates HTML code representing the WINDOW.

html target The label of the HtmlClass object that writes the HTML
code.
filename A string constant, variable, EQUATE, or expression
containing the filename of the file containing the HTML
code.
The CreateHtmlPage method generates HTML code representing the entire
WINDOW. The generated HTML code includes intelligent arrangement of
the controls on the resulting Web page, plus JavaScript (Java applet controls)
where appropriate.

Implementation: The CreateHtmlPage method generates a page header and footer surrounding
the HTML code for all the window controls. The CreateHtmlPage method
sets the SentHtml property to one (True).

Example:

[Link] PROCEDURE

Client &WebClientManagerClass
Filename CSTRING(FILE:MaxFilePath),AUTO

SeeAlso: SentHtml
CHAPTER 7 WEBWINDOWCLASS 175

CreateJslData (generate Java Support Library data)

CreateJslData( JSL manager )

CreateJslData Generates Java Support Library (JSL) data for the

window.
JSL manager The label of the JslManagerClass object that generates
the JSL data.
The CreateJslData method generates Java Support Library protocol and
data for the Java applet controls on the window. This allows very fast partial
updates to the Web page.

Implementation: The CreateJslData method calls the CreateJslData method for each visible
control in the window.

Example:

[Link] PROCEDURE

Client &WebClientManagerClass
Filename CSTRING(FILE:MaxFilePath),AUTO

SeeAlso: [Link]
176 IBC LIBRARY REFERENCE

CreatePageFooter (generate HTML page footer)

CreatePageFooter( html target )

CreatePageFooter
Generates the HTML page footer for the window.
html target The label of the HtmlClass object that writes the HTML
code.
The CreatePageFooter method generates the HTML page footer, including
any page-ending JavaScript needed by Java controls.

Example:
[Link] PROCEDURE(*HtmlClass Target, STRING HtmlFilename)
CODE
[Link](HtmlFilename,[Link],[Link],[Link])
[Link](Target)
[Link](Target, 0, [Link]())
[Link](Target)
[Link]
[Link] = TRUE

CreatePageHeader (generate HTML page footer)

CreatePageHeader( html target )

CreatePageHeaderGenerates the HTML page header for the window.

html target The label of the HtmlClass object that writes the HTML
code.
The CreatePageHeader method generates the HTML page header,
including any setup JavaScript needed by Java controls.

Example:
[Link] PROCEDURE(*HtmlClass Target, STRING HtmlFilename)
CODE
[Link](HtmlFilename,[Link],[Link],[Link])
[Link](Target)
[Link](Target, 0, [Link]())
[Link](Target)
[Link]
[Link] = TRUE
CHAPTER 7 WEBWINDOWCLASS 177

CreateUnauthorizedPage(create unauthorizeduser page)

CreateUnauthorizedPage( html target, filename )

CreateUnauthorizedPage
Generates an HTML page showing an access denied
message.
html target The label of the HtmlClass object that writes the HTML
code.
filename A string constant, variable, EQUATE, or expression
containing the filename of the file containing the HTML
code.
The CreateUnauthorizedPage method generates an HTML page showing
an access denied message.

CreateUnauthorizedPage is a VIRTUAL method so that other base class

methods can directly call the CreateUnauthorizedPage virtual method in a
derived class. This lets you easily implement your own custom version of
this method.

Implementation: The default message is “Access denied. Click here to return to previous
screen, or wait for 10 seconds.” This default page is installed by default to
the \LIBSRC\[Link].

The SetPassword method sets the Authorize property to true, to password

Example:
[Link] PROCEDURE
Client &WebClientManagerClass
Filename CSTRING(FILE:MaxFilePath),AUTO
CODE
Client &= [Link]
[Link]([Link]())
IF ([Link] AND NOT [Link]())
Filename = [Link](Content:UnAuthorized)
[Link]([Link], Filename)
[Link](Filename, [Link]())
[Link] = TRUE
Post(EVENT:CloseWindow)
ELSE
Filename = [Link](Content:Html)
[Link]
[Link]([Link], Filename)
[Link](Filename, [Link](), FALSE)
END
[Link]()

SeeAlso: Authorize, AuthorizeArea, GetAuthorized, TakeCreatePage, SetPassword,

ValidatePassword
CHAPTER 7 WEBWINDOWCLASS 179

GetAuthorized(check user authorization)

GetAuthorized, BYTE
The GetAuthorized method collects the username and password and
validates it, then returns a value indicating whether the end user is authorized
to proceed. A return value of one (1) indicates the end user is authorized; a
return value of zero (0) indicates the end user is not authorized.

Implementation: The SetPassword method sets the Authorize property to true, to password
protect the Web page (AuthorizeArea). It also sets the authorized password
for the AuthorizeArea. The GetAuthorized method collects and validates the
end user’s password for the AuthorizeArea. The ValidatePassword method
verifies the password entered by the end user. Finally, the TakeCreatePage
method generates an “access denied” page (CreateUnauthorizedPage) for
invalid passwords.

Return DataType: BYTE

SeeAlso: Authorize, AuthorizeArea, CreateUnauthorizedPage, TakeCreatePage,

SetPassword, ValidatePassword
180 IBC LIBRARY REFERENCE

GetBackgroundColor (returnWebwindow backgroundcolor)

GetBackgroundColor( [default color] ), LONG, VIRTUAL

GetBackgroundColor
Returns the background color of the Web page window.
default color An integer variable, constant, EQUATE, or expression
containing the color to return if there is no background
color. If omitted, default color defaults to Color:None.
The GetBackgroundColor method returns the background color of the Web
page window.

GetBackgroundColor is a VIRTUAL method so that other base class

methods can directly call the GetBackgroundColor virtual method in a
derived class. This lets you easily implement your own custom version of
this method.

Implementation: The GetBackgroundColor method returns the value of the Background

property if it contains a color; otherwise it returns the COLOR attribute of
the WINDOW.

EQUATEs for the default color parameter are declared in

\LIBSRC\[Link].

Return DataType: LONG

Example:
[Link] PROCEDURE
CODE
IF ([Link] <> COLOR:None)
RETURN [Link]
END
RETURN [Link]()

SeeAlso: Background
CHAPTER 7 WEBWINDOWCLASS 181

GetBackgroundImage (returnWebpagewallpaper)
GetBackgroundImage, STRING, VIRTUAL
The GetBackgroundImage method returns the filename of the file
containing the background image of the Web page window.

GetBackgroundImage is a VIRTUAL method so that other base class

methods can directly call the GetBackgroundImage virtual method in a
derived class. This lets you easily implement your own custom version of
this method.

Implementation: The GetBackgroundImage method returns the value of the BackImage

property.

Return DataType: STRING

SeeAlso: BackImage
182 IBC LIBRARY REFERENCE

GetButtonInClientArea (return buttonpresent indicator)

GetButtonInClientArea, SIGNED
The GetButtonInClientArea method returns a value indicating whether
there are any visible (enabled and not hidden) buttons within the client area.
A return value of zero (0) indicates no visible buttons; any other value
indicates the presence of a visible button.

Implementation: The GetButtonInClientArea returns the control number of the first visible
button in the client area. The GetCreateClose method calls the
GetButtonInClientArea method to determine whether to create a close button
for the window.

Return DataType: SIGNED

Example:
[Link] PROCEDURE
CODE
CASE [Link]
OF CLOSE:Never
RETURN FALSE
OF CLOSE:IfSystem
RETURN 0{PROP:System}
OF CLOSE:SystemNoButton
IF 0{PROP:System} AND NOT [Link]()
RETURN TRUE
END
RETURN FALSE
OF CLOSE:Always
RETURN TRUE
END

SeeAlso: GetCreateClose, CreateClose

CHAPTER 7 WEBWINDOWCLASS 183

GetChildren(return all child controls)

GetChildren( children, parent control [, control type] ), VIRTUAL

GetChildren Returns information about the child controls of the

specified parent control.
children The label of a structure to contain the information about
the child controls.
parent control An integer constant, variable, EQUATE, or expression
containing the parent control’s control number, or zero
(0) if the WINDOW is the parent.
control type An integer constant, variable, EQUATE, or expression
indicating the type of child control to include, or ex-
clude. A negative control type excludes controls of the
specified type. A positive control type includes controls
of the specified type. If omitted, all control types are
included.
The GetChildren method returns information about the child controls of the
specified parent control. The information may be limited to controls of a
specific type (for example, TAB controls only), or it may be limited controls
excluding a specific type (for example, all controls except TAB controls).

The WebWindowClass object uses the GetChildren method to identify

related controls for various purposes, including appropriate positioning of
child controls in relation to their parent controls.

GetChildren is a VIRTUAL method so that other base class methods can

directly call the GetChildren virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The children parameter names a QUEUE with the same structure as the
WebControlQueue declared in [Link] as follows:
WebControlQueue QUEUE,TYPE
Feq SIGNED
ThisControl &WebControlClass
END

EQUATEs for the control type parameter are declared in [Link].

Each control type EQUATE is prefixed with CREATE:.

Example:
[Link] PROCEDURE|
(*HtmlClass Target,SIGNED ParentFeq,STRING Style)
Controls WebControlQueue
CODE
[Link](Controls, ParentFeq)
[Link](Controls, Target, Style, [Link], [Link])
184 IBC LIBRARY REFERENCE

GetControl (return control information)

GetControl( control [, control information ] ), BYTE, VIRTUAL

GetControl Returns information about the specified control.

control An integer constant, variable, EQUATE, or expression
containing the control’s field equate number.
control information The label of a structure to contain information about the
specified control. If omitted, GetControl returns a value
indicating whether the WebWindowClass already
“knows” about the control. A return value of one (1)
indicates the control is known; a return value of zero (0)
indicates the control is unknown.
The GetControl method returns information about the specified control. If
the control information parameter is present, GetControl fills it with the
control information. If the control reference parameter is omitted,
GetControl returns a true or false value indicating whether the
WebWindowClass object is “aware” of the control.

GetControl is a VIRTUAL method so that other base class methods can

directly call the GetControl virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The control information parameter names a GROUP with the same structure
as the WebControlRefGroup GROUP declared in [Link] as
follows:
WebControlRefGroup GROUP,TYPE
Control &WebControlClass
END

If the control information parameter is present, GetControl calls the

GetControlInfo method to set the reference to the WebControlClass object.

Return DataType: BYTE

Example:
[Link] PROCEDURE
ParentControlGroup GROUP(WebControlRefGroup)
END
CODE
[Link]([Link], ParentControlGroup)
IF (NOT [Link] &= NULL)
RETURN [Link]()
END
RETURN [Link]()

SeeAlso: GetControlInfo
CHAPTER 7 WEBWINDOWCLASS 185

GetControlInfo (return control reference)

GetControlInfo( control ), &WebControlClass, VIRTUAL

GetControlInfo Returns a reference to the specified control.

control An integer constant, variable, EQUATE, or expression
containing the control’s field equate number.
The GetControlInfo method returns a reference to the specified control. If
the WebWindowClass object is “unaware” of the control t, GetControlInfo
returns a NULL reference.

GetControlInfo is a VIRTUAL method so that other base class methods can

directly call the GetControlInfo virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: The WebControlClass maintains a QUEUE of WebControlClass objects and

their corresponding control (field equate) numbers. The GetControlInfo
method simply returns a reference to the specified WebControlClass object.

Return DataType: &WebControlClass

Example:
[Link] PROCEDURE(SIGNED Feq, *WebControlRefGroup Result)
CODE
[Link] &= [Link](Feq)
186 IBC LIBRARY REFERENCE

GetCreateClose(return closebuttonflag)
GetCreateClose, BYTE, VIRTUAL
The GetCreateClose method returns a value indicating whether to create a
close button on the Web page. A return value of one (1) indicates a close
button should be created; a return value of zero (0) indicates a close button
should not be created.

GetCreateClose is a VIRTUAL method so that other base class methods can

directly call the GetCreateClose virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: The ResetFromControls method calls the GetCreateClose method to

determine whether to create the close button. The GetCreateClose method
considers the CreateClose property and the state of the window (presence of
system menu or other enabled buttons) in order to return the appropriate
value.

Return DataType: BYTE

Example:
[Link] PROCEDURE
CurFeq SIGNED,AUTO
CODE
CurFeq = 0{PROP:nextfield}
LOOP WHILE (CurFeq)
IF (CurFeq)
[Link](CurFeq, IC:GetControlType(CurFeq))
END
CurFeq = 0{PROP:nextfield, CurFeq}
END
CurFeq = 04000H
LOOP WHILE (CurFeq{PROP:type})
[Link](CurFeq, IC:GetControlType(CurFeq))
CurFeq += 1
END
[Link](FEQ:ClientArea, CREATE:ClientArea)
IF ([Link]())
[Link](FEQ:Close, CREATE:Close)
END
[Link]

SeeAlso: CreateClose, ResetFromControls

CHAPTER 7 WEBWINDOWCLASS 187

GetFirstChild (return first child control)

GetFirstChild( parent control [, control type] ), SIGNED, VIRTUAL

GetFirstChild Returns the control number of the first visible child of

the specified parent control and control type.
parent control An integer constant, variable, EQUATE, or expression
containing the parent control’s control number, or zero
(0) if the WINDOW is the parent.
control type An integer constant, variable, EQUATE, or expression
containing the type of child control for which to search.
If omitted, any control type is valid.
The GetFirstChild method returns the control number of the first “visible”
child control of the specified parent control and control type. A visible
control is one that is not hidden or disabled.

The WebWindowClass uses the GetFirstChild method primarily to determine

whether an area of the Web page has no visible controls and can therefore be
omitted. For example, if all toolbar controls are disabled, then the toolbar
itself can be omitted from the Web page.

GetFirstChild is a VIRTUAL method so that other base class methods can

directly call the GetFirstChild virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The GetShowToolbar and GetShowMenubar methods call the GetFirstChild

method. The GetFirstChild method calls the [Link]
method for each control.

EQUATEs for the control type parameter are declared in [Link].

Each control type EQUATE is prefixed with CREATE:.

Return DataType: SIGNED

Example:
[Link] PROCEDURE

CODE
IF ([Link]() AND [Link]([Link]))
RETURN TRUE
END
RETURN FALSE

SeeAlso: GetShowMenubar, GetShowToolbar, [Link]

188 IBC LIBRARY REFERENCE

GetHelpHandler (return HTML to showhelp document)

GetHelpHandler, STRING, VIRTUAL
The GetHelpHandler method returns the HTML to request the help
document associated with the Web page.

GetHelpHandler is a VIRTUAL method so that other base class methods can

directly call the GetHelpHandler virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: The GetHelpHandler method writes HTML to invoke the JavaScript

ShowHelp function which submits a request to the Server for a specific help
document or document section. The GetHelpReference method supplies the
help document to use.

Return DataType: STRING

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE
[Link]('<<INPUT TYPE=SUBMIT VALUE="')
[Link](IC:QuoteText([Link](), IC:RESET:HotValue) & '"')
[Link]([Link](Target))
IF [Link]{PROP:std} = STD:Help
[Link]([Link]())
END
[Link]('>')

SeeAlso: GetHelpReference
CHAPTER 7 WEBWINDOWCLASS 189

GetHelpReference(return HTML help document reference)

GetHelpReference, STRING, VIRTUAL
The GetHelpReference method returns the HTML reference for a specific
help display. The returned value depends on the values of the HelpDocument
and HelpRelative properties, and the WINDOW’s HLP attribute.

GetHelpReference is a VIRTUAL method so that other base class methods

can directly call the GetHelpReference virtual method in a derived class.
This lets you easily implement your own custom version of this method.

Implementation: If HelpRelative is true, GetHelpReference returns a reference like:

Document#HelpId

otherwise, GetHelpReference returns a reference like:

URL/[Link]

Where Document or URL comes from the HelpDocument property and

HelpId is derived from the HLP attribute for the WINDOW. HelpId is
derived by discarding any HLP attribute characters except A-Z, a-z, 0-9, and
underscore (_).

Return DataType: STRING

Example:
[Link] PROCEDURE
CODE
RETURN ' onClick="' & IC:QuoteJsl('ShowHelp(''' & |
[Link]() & ''',''' & [Link] & ''')') & '"'

[Link] PROCEDURE
CODE
RETURN ' HREF="' & [Link]() & '"'

SeeAlso: [Link], [Link]

190 IBC LIBRARY REFERENCE

GetHelpTarget (return HTMLHREF for help display)

GetHelpTarget, STRING, VIRTUAL
The GetHelpTarget method returns the HTML <HREF> for a specific help
display.

GetHelpTarget is a VIRTUAL method so that other base class methods can

directly call the GetHelpTarget virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: The GetHelpTarget method embeds the reference returned by the

GetHelpReference method in an HTML <HREF> statement.

Return DataType: STRING

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE
[Link]('<<NOBR>')
[Link](([Link]()-1)*2)
[Link]('<<A')
IF [Link]{PROP:std} = STD:Help
[Link](' TARGET="_blank"' & [Link]())
ELSE
[Link](' HREF="' & [Link]([Link]) & '"')
END
[Link]('>')
[Link]([Link]() & '<</A>')
[Link]('<</NOBR><<BR>')

SeeAlso: GetHelpReference
CHAPTER 7 WEBWINDOWCLASS 191

GetMenubarFeq(returnmenubar control number)

GetMenubarFeq, SIGNED, VIRTUAL
The GetMenubarFeq method returns the control number (field equate) of
the window’s MENUBAR.

GetMenubarFeq is a VIRTUAL method so that other base class methods can

directly call the GetMenubarFeq virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: The GetMenubarFeq method returns the value of the MenubarFeq property.

Return DataType: SIGNED

SeeAlso: [Link]
192 IBC LIBRARY REFERENCE

GetPageImage(returnWebpagewallpaper)
GetPageImage, STRING, VIRTUAL
The GetPageImage method returns the filename of the file containing the
background image of the Web page.

GetPageImage is a VIRTUAL method so that other base class methods can

directly call the GetPageImage virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: The GetPageImage method returns the value of the PageImage property.

Return DataType: STRING

SeeAlso: PageImage

GetShowMenubar (returnmenubar include/omit flag)

GetShowMenubar, BYTE, VIRTUAL
The GetShowMenubar method returns a value indicating whether to
include a menubar area on the Web page.

GetShowMenubar is a VIRTUAL method so that other base class methods

can directly call the GetShowMenubar virtual method in a derived class. This
lets you easily implement your own custom version of this method.

Implementation: The GetShowMenubar method calls the GetFirstChild method to determine

if the Web page menubar is empty.

Return DataType: BYTE

Example:
[Link] PROCEDURE
CODE
RETURN [Link]()

SeeAlso: GetFirstChild
CHAPTER 7 WEBWINDOWCLASS 193

GetShowToolbar (return toolbar include/omit flag)

GetShowToolbar, BYTE, VIRTUAL
The GetShowToolbar method returns a value indicating whether to include
a toolbar on the Web page.

GetShowToolbar is a VIRTUAL method so that other base class methods can

directly call the GetShowToolbar virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: The GetShowToolbar method calls the GetFirstChild method to determine if

the Web page toolbar is empty.

Return DataType: BYTE

Example:
[Link] PROCEDURE
CODE
RETURN [Link]()

SeeAlso: GetFirstChild
194 IBC LIBRARY REFERENCE

GetTableAttributes (returnwindowHTML <STYLE>)

GetTableAttributes, STRING, VIRTUAL
The GetTableAttributes method returns the HTML <STYLE> string for the
HTML <TABLE> representing the WINDOW.

GetTableAttributes is a VIRTUAL method so that other base class methods

can directly call the GetTableAttributes virtual method in a derived class.
This lets you easily implement your own custom version of this method.

Implementation: The <STYLE> returned by GetTableAttributes includes the <TABLE>

<BORDER> (BorderWidth property), <BGCOLOR> (Background
property), and <BACKGROUND> (BackImage property).

Return DataType: STRING

Example:
[Link] PROCEDURE(*HtmlClass Target, STRING HtmlFilename)
CODE

[Link](HtmlFilename,[Link],[Link],[Link])
[Link](Target)
[Link](Target, 0, [Link]())
[Link](Target)
[Link]
[Link] = TRUE

SeeAlso: Background, BackImage, BorderWidth

CHAPTER 7 WEBWINDOWCLASS 195

GetTargetSecurity (return public or secure flag)

GetTargetSecurity, SIGNED
The GetTargetSecurity method returns a value indicating whether to use a
secure channel or a public channel. A return value of Secure:Full indicates a
secure channel; and a return value of Secure:None indicates a public
directory.

The WebWindowClass uses this method to develop appropriate pathnames

for temporary files and to support secure channels as needed.

Implementation: The GetTargetSecurity method evaluates the IsSecure property and returns
Secure:Full if IsSecure is True.

EQUATEs for GetTargetSecurity return values are declared in [Link]

as follows:
ITEMIZE,PRE(Secure)
Default EQUATE
None EQUATE
Full EQUATE
Last EQUATE(Secure:Full)
END

Return DataType: SIGNED

SeeAlso: IsSecure
196 IBC LIBRARY REFERENCE

GetToolbarFeq(returnToolbar control number)

GetToolbarFeq, SIGNED, VIRTUAL
The GetToolbarFeq method returns the control number (field equate) of the
window’s TOOLBAR.

GetToolbarFeq is a VIRTUAL method so that other base class methods can

directly call the GetToolbarFeq virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: The GetToolbarFeq method returns the value of the ToolbarFeq property.

Return DataType: SIGNED

SeeAlso: [Link]
CHAPTER 7 WEBWINDOWCLASS 197

GetToolbarMode(return toolbar entity)

GetToolbarMode, SIGNED, VIRTUAL
The GetToolbarMode method returns a value indicating what the toolbar is
driving. For example, a BrowseBox, a Relation Tree, or an update form. The
WebWindowClass uses this method to decide whether a toolbar button
warrants a full page update or a partial page update.

GetToolbarMode is a VIRTUAL method so that other base class methods can

directly call the GetToolbarMode virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: EQUATEs for GetToolbarMode return values are declared in [Link]

as follows:
FormMode EQUATE(1)
BrowseMode EQUATE(2)
TreeMode EQUATE(3)

Return DataType: BYTE

Example:
[Link] PROCEDURE(SIGNED EventNo)

CODE
IF (EventNo = EVENT:Accepted)
IF ([Link]() = FormMode)
RETURN Update:Full
ELSE
RETURN Update:Partial
END
END
RETURN Update:OnBrowser
198 IBC LIBRARY REFERENCE

GetWebActiveFrame (returnWebFrameClassreference)
GetWebActiveFrame, WebFrameClass, VIRTUAL
The GetWebActiveFrame method returns a reference to the active
WebFrameClass. The WebWindowClass uses this method to pass events to
the WebFrameClass for processing.

GetWebActiveFrame is a VIRTUAL method so that other base class methods

can directly call the GetWebActiveFrame virtual method in a derived class.
This lets you easily implement your own custom version of this method.

Return DataType: WebFrameClass

Example:
[Link] PROCEDURE(*SIGNED x,*SIGNED y,*SIGNED width,*SIGNED height)

ActiveFrame &WebFrameClass

CODE
ActiveFrame &= [Link]()
IF [Link]=[Link]()
x = [Link]{PROP:childindex} * 40
y = 0
ELSE
x = 0
y = [Link]{PROP:childindex} * 40
END
width = 10
height = 10

SeeAlso: WebFrameClass
CHAPTER 7 WEBWINDOWCLASS 199

Init (initialize theWebWindowClassobject)

Init( server, html target [,area] )

Init Initializes the WebWindowClass object.

server The label of the WebServerClass object that establishes
communications with the Application Broker and
handles the information coming through the channel.
html target The label of the HtmlClass object that writes the HTML
code representing the window.
area A string constant, variable, EQUATE, or expression
containing the identity of a Web page generated by the
Server application that may be password protected. The
Client browser displays this value when prompting the
end user for an authorized username and password.
The Init method initializes the WebWindowClass object.

Implementation: The Init method sets the default values of all the WebWindowClass
properties, including the properties that control HTML code generation. You
may override these default values by subsequent (after init method)
assignments to the WebWindowClass properties.

Example:
PrepareProcedure ROUTINE
[Link](WebServer, HtmlManager, window{PROP:text} & ' (BrowseCustomer)')
!etc.

SeeAlso: AllowJava, Authorize, AuthorizeArea, Background, BackImage,

BorderWidth, CloseImage, CreateCaption, CreateClose, CreateToolbar,
DisabledAction, Files, FormatBorderWidth, GroupBorderWidth, HtmlTarget,
IsCentered, MenubarType, OptionBorderWidth, PageBackground,
PageImage, Server, SheetBorderWidth, TimerDelay, TimerAction, IsSecure
200 IBC LIBRARY REFERENCE

Kill (shut down theWebWindowClassobject)

Kill, VIRTUAL
The Kill method frees any memory allocated during the life of the object and
performs any other necessary termination code.

Kill is a VIRTUAL method so that other base class methods can directly call
the Kill virtual method in a derived class. This lets you easily implement
your own custom version of this method.

Example:
ProcedureReturn ROUTINE
[Link]
!etc.

ResetFromControls (set control information)

ResetFromControls
The ResetFromControls method dynamically builds the WebWindowClass
object’s knowledge of the WINDOW’s controls and pseudo-controls from
the present state of the WINDOW.

You may call this method to accomodate dynamically created or destroyed

controls.

Implementation: The ResetFromControls method calls the AddControl method for each
control and pseudo-control in the opened WINDOW. When all controls are
set, ResetFromControls establishes relationships between controls by calling
the SetParentDefaults method.

Example:
[Link] PROCEDURE
CODE
!procedure code
CASE (EVENT())
OF EVENT:NewPage
IF ([Link]())
[Link]
END
OF EVENT:OpenWindow
[Link]
END
!etc,

SeeAlso: AddControl, SetParentDefaults

CHAPTER 7 WEBWINDOWCLASS 201

SetBackground(setWebpagewindowbackground)
SetBackground( [color] [,image] )

SetBackground Sets the Web page window background color and image.
color An integer constant, variable, EQUATE, or expression
indicating the PAGE color. This color is inherited by the
window components, such as the toolbar and client area,
unless a specific color is set for the component.
image A string constant, variable, EQUATE, or expression
containing a filename. The WebWindowClass object
displays (tiles) the image in the specified file as the
background to the Web page.
The SetBackground method sets the Web page window background color
and image. Other window components (caption, menubar, toolbar, and client
area) inherit the color and image unless overriden.

Implementation: The SetBackground method sets the Background property and the
BackImage property. The GetBackgroundColor method returns the value of
the Background property.

Example:
PrepareProcedure ROUTINE
[Link](4227200, '[Link]')
!etc.

SeeAlso: Background, BackImage, GetBackgroundColor

202 IBC LIBRARY REFERENCE

SetCentered(center window inWebpage)

SetCentered( [center] )

SetCentered Centers or left-justifes the window in the generated Web

page.
center An integer constant, variable, EQUATE, or expression
indicating whether to horizontally center or left-justify
the window within the generated Web page. A value of
one (1 or True) centers the window; a value of zero (0 or
False) left-justifies the window. If omitted, center
defaults to True.
The SetCentered method prepares the WebWindowClass object to center or
left-justify the window within the generated Web page, depending on the
value of the center parameter.

Implementation: The SetCentered method sets the IsCentered property.

Example:
PrepareProcedure ROUTINE
[Link](True)
!etc.

SeeAlso: IsCentered

SetChildDefaults (set childrenof each control)

SetChildDefaults
The SetChildDefaults method sets the child controls for each control on the
Web page. This positional determination of parent/child relationships results
in proper alignment and processing of controls on the Web page.

Implementation: The SetChildDefaults method calls the [Link] method

for each control on the WINDOW.

Example:
[Link] PROCEDURE
CurFeq SIGNED,AUTO
CODE
!procedure code
[Link]

SeeAlso: [Link]
CHAPTER 7 WEBWINDOWCLASS 203

SetFormatOptions(setWebpagescale andalignment)
SetFormatOptions( snaptoX, snaptoY, scaleX, scaleY )

SetFormatOptions
Sets the control scaling and alignment factors for the
Web page.
snaptoX An integer constant, variable, EQUATE, or expression
containing a horizontal “snap to” factor for aligning
controls on the Web page.
snaptoY An integer constant, variable, EQUATE, or expression
containing a vertical “snap to” factor for aligning
controls on the Web page.
scaleX An integer constant, variable, EQUATE, or expression
containing a horizontal scaling factor for sizing Java
controls on the Web page.
scaleY An integer constant, variable, EQUATE, or expression
containing a vertical scaling factor for sizing Java
controls on the Web page.
The SetFormatOptions method sets the control scaling and alignment
factors for the Web page. The precise effect of these properties is determined
by the LayoutHtmlClass and HtmlClass objects that actually apply the
factors.

Implementation: The SetFormatOptions method sets the initial value of the SnapX and SnapY
properties, and the initial values of the HtmlOption property.

Example:
[Link] PROCEDURE(*WebServerClass Server, |
*HtmlClass HtmlTarget, <STRING AuthorizeArea>)
CODE
!procedure code
[Link](2, 2, 6, 13)

SeeAlso: SnapX, SnapY, HtmlOption

204 IBC LIBRARY REFERENCE

SetHelpDocument (enable single documentWebpagehelp)

SetHelpDocument( filename, style )

SetHelpDocument Lets the generated Web page request topics within a

single HTML help document, and lets the Server proce-
dure respond to the help requests.
filename A string constant, variable, EQUATE, or expression
containing the pathname of an HTML document relative
to the Application Broker root directory.
style A string constant, variable, EQUATE, or expression
containing ...
The SetHelpDocument method prepares the WebWindowClass object to
generate a Web page that can request page-specific help topics within a
single HTML help document, and to respond to the requests by supplying the
requested material to the Client.

Implementation: The SetHelpDocument method sets the HelpDocument property to filename,

the HelpEnabled property to True, the HelpRelative property to True, and the
HelpStyle property to style.

The GetHelpReference method derives the help topic from the WINDOW’s
HLP attribute.

Example:
PrepareProcedure ROUTINE
[Link](‘Widgets/OrdHelp,htm’, ‘’)

SeeAlso: GetHelpReference, HelpDocument, HelpEnabled, HelpRelative, HelpStyle

CHAPTER 7 WEBWINDOWCLASS 205

SetHelpURL (enablemultiple documentWebpagehelp)

SetHelpURL( URL, style )

SetHelpURL Lets the generated Web page request a single HTML

help document, and lets the Server procedure respond to
the help requests.
URL A string constant, variable, EQUATE, or expression
containing the URL of an HTML document.
style A string constant, variable, EQUATE, or expression
containing ...
The SetHelpURL method prepares the WebWindowClass object to generate
a Web page that can request a page-specific HTML help document, and to
respond to the requests by supplying the requested document to the Client.

Implementation: The SetHelpURL method sets the HelpDocument property to URL, the
HelpEnabled property to True, the HelpRelative property to False, and the
HelpStyle property to style.

The GetHelpReference method derives the help document name from the
WINDOW’s HLP attribute.

Example:
PrepareProcedure ROUTINE
[Link](‘http//[Link]/Widgets’, ‘’)

SeeAlso: GetHelpReference, HelpDocument, HelpEnabled, HelpRelative, HelpStyle

206 IBC LIBRARY REFERENCE

SetPageBackground(setWebpage background)
SetPageBackground( [color] [,image] )

SetPageBackground
Sets the Web page background color and image.
color An integer constant, variable, EQUATE, or expression
indicating the PAGE color.
image A string constant, variable, EQUATE, or expression
containing a filename. The WebWindowClass object
displays (tiles) the image in the specified file as the
background to the Web page.
The SetPageBackground method sets the Web page background color and
image.

Implementation: The SetPageBackground method sets the PageBackground property and the
PageImage property.

Example:
PrepareProcedure ROUTINE
[Link](4227200, '[Link]')
!etc.

SeeAlso: PageBackground, PageImage

CHAPTER 7 WEBWINDOWCLASS 207

SetPassword (requireWebpage password)

SetPassword( password [,case sensitive] )

SetPassword Sets the password required to access the Web page

representing the WINDOW.
password A string constant, variable, EQUATE, or expression
containing the password.
case sensitive A Boolean constant, variable, EQUATE, or expression
indicating whether password verification is case sensi-
tive.
The SetPassword method sets the password required to access the Web page
representing the WINDOW.

Example:
PrepareProcedure ROUTINE
!routine code
[Link](WebServer, HtmlManager, window{PROP:text} & ' (BrowseCustomer)')
[Link](UserPassword, FALSE)

SeeAlso: Authorize, AuthorizeArea, CreateUnauthorizedPage, GetAuthorized,

TakeCreatePage, ValidatePassword
208 IBC LIBRARY REFERENCE

SetSplash(makethis a splashwindow)
SetSplash( timer delay )

SetSplash Marks the window as a splash window.

timer delay A string constant, variable, EQUATE, or expression
containing the password.
The SetSplash method designates the window is a splash window. By
convention, a splash window opens automatically at program startup,
providing the end-user with a sense of familiarity and confidence, and
perhaps an introduction to the program.

Tip: Splashscreensshouldn’t containbuttons(or regions) that

causethemto close. If it does,andthecontrol number (feq) of
thebuttonmatchesa control numberontheframe procedure,
thentheframe control’s actionis invokedrather thanthe
splashscreencontrol’s action.

Implementation: The SetSplash method sets the IsSplash property to true, the TimerAction
property to Update:Refresh, and the TimerDelay property to timer delay.

Example:
Splash PROCEDURE
!procedure data
CODE
!procedure code

PrepareProcedure ROUTINE
!routine code
[Link](10)

SeeAlso: IsSplash, TimerAction, TimerDelay

CHAPTER 7 WEBWINDOWCLASS 209

SetTimer (setWebpagetimer andaction)

SetTimer( timer delay, timer action )

SetTimer Sets a time interval and the action to take when the time
interval expires.
timer delay An integer constant, variable, EQUATE, or expression
indicating the time period for Java applets to wait before
initiating the timer action.
timer action An integer constant, variable, EQUATE, or expression
indicating the action the browser takes after the timer
delay interval. The action is repeated each time the timer
delay interval expires.
The SetTimer method sets a time interval and the action to take when the
time interval expires. Both the timer delay interval and the timer action are
implemented by the Client browser, not the Server.

Tip: Usethismethodsparinglytominimizenetwork traffic.

There are four valid timer actions, three of which consist of a request to the
Server for an update of the Web page. Update:Full submits any entered items
and requests a complete screen redraw. Update:Partial submits any entered
items and requests only the data to fill Java controls (see JSL Manager
Class). Update:Refresh submits no items, but requests a complete screen
redraw. Update:OnBrowser updates the Web page as far as possible without
contacting the Server.

Implementation: The SetTimer method sets the TimerAction and TimerDelay properties.

EQUATEs for the TimerAction property are declared in [Link] as

follows:
Update:OnBrowser EQUATE(0)
Update:Partial EQUATE(1)
Update:Full EQUATE(2)
Update:Refresh EQUATE(3) !Splash screen only

The Init method sets the initial value of the TimerAction property to zero (0).
The SetTimer method sets subsequent values of the TimerAction property.

Example:
PrepareProcedure ROUTINE
!routine code
[Link](10, Update:Partial)

SeeAlso: TimerAction, TimerDelay

210 IBC LIBRARY REFERENCE

SuppressControl (omit control fromWebpage)

SuppressControl( control )

SuppressControl Omits the specified control from the Web page.

control An integer constant, variable, EQUATE, or expression
containing the control’s field equate number.
The SuppressControl method omits the specified control from the generated
Web page.

Implementation: The SuppressControl method instantiates a WebNullControlClass object to

represent the control. You must call the SuppressControl method before the
corresponding AddControl method; that is, before calling
ResetFromControls.

Example:
PrepareProcedure ROUTINE
!routine code
[Link](?Insert)
[Link](?Change)
[Link](?Delete)

SeeAlso: AddControl, ResetFromControls

CHAPTER 7 WEBWINDOWCLASS 211

TakeCreatePage (fill Client request for page)

TakeCreatePage, VIRTUAL
The TakeCreatePage method prepares a page in response to a Client
request, then notifies the WebClientManagerClass object and the
WebServerClass object that the page is ready.

TakeCreatePage is a VIRTUAL method so that other base class methods can

directly call the TakeCreatePage virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: The TakeEvent method calls the TakeCreatePage method.

The TakeCreatePage method may generate a complete Web page (HTML

representation of the WINDOW), a page of JSL data to partially update the
Web page, an “access denied” page, or a dummy page if the Client requested
a partial page and the Server determines a full page is necessary.

Example:
[Link] PROCEDURE
CODE
IF ([Link])
CASE [Link]()
OF NET:Request
[Link]
OF NET:Terminate
RETURN 1
END
CASE (EVENT())
OF EVENT:NewPage
IF ([Link]())
[Link]
END
OF EVENT:OpenWindow
[Link]
END
[Link]
IF ([Link]())
POST(EVENT:NewPage)
END
END
RETURN 0

SeeAlso: TakeEvent
212 IBC LIBRARY REFERENCE

TakeEvent (handle browser andACCEPT loopevents)

TakeEvent, VIRTUAL
The TakeEvent method handles all ACCEPT loop events for the
WebWindowClass object, including events channeled from the Client to the
Server through the Broker.

A return value of one (1) indicates the calling entity should BREAK out of
the current ACCEPT loop. A return value of zero (0) indicates the calling
entity should continue through the current ACCEPT loop.

TakeEvent is a VIRTUAL method so that other base class methods can

directly call the TakeEvent virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: When the WINDOW is opened, the TakeEvent method builds the
WebWindowClass object’s knowledge of the WINDOW’s controls and
pseudo-controls from the present state of the WINDOW.

Thereafter, it processes requests from the Client browser by translating them

to appropriate Clarion EVENTs. After the Clarion EVENTs are processed by
the ACCEPT loop code, it sends information (HTML code or JSL data) to
the Broker for forwarding to the Client.

Example:
AlmostAny PROCEDURE
!procedure data
CODE
DO PrepareProcedure
ACCEPT
IF [Link]()
BREAK
END
CASE EVENT()
!etc
END
DO ProcedureReturn
CHAPTER 7 WEBWINDOWCLASS 213

TakeRequest (processbrowser event/request)

TakeRequest, VIRTUAL
The TakeRequest method handles ACCEPT loop events channeled from the
Client browser to the Server through the Broker.

TakeRequest is a VIRTUAL method so that other base class methods can

directly call the TakeRequest virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: TakeRequest processes requests from the Client browser by accepting field
values from the browser and updating the corresponding Clarion controls’
USE variables, then POSTing the associated event to the appropriate control
([Link]).

SeeAlso: TakeEvent, [Link]

214 IBC LIBRARY REFERENCE

TakeUnknownSubmit (avirtual to handle unexpectedrequests)

TakeUnknownSubmit( control name, new value ),VIRTUAL

TakeUnknownSubmit
A virtual placeholder method to handle unexpected
Client requests.
control name A string constant, variable, EQUATE, or expression
containing the HTML control identifier.
new value A string constant, variable, EQUATE, or expression
containing the new value of the HTML control.
The TakeUnknownSubmit method is a virtual placeholder method to handle
Client data assignments to unrecognized Web page fields.

TakeUnknownSubmit is a VIRTUAL method so that other base class

methods can directly call the TakeUnknownSubmit virtual method in a
derived class. This lets you easily implement your own custom version of
this method.

Implementation: The TakeRequest method calls the TakeUnknownSubmit method.

Example:
[Link] PROCEDURE
NextSubmit &SubmitItemClass
Curfeq SIGNED,AUTO
Index SIGNED,AUTO
CODE
IF ([Link]())
LOOP Index = 1 TO RECORDS([Link])
GET([Link], Index)
[Link]()
END
END
LOOP
NextSubmit &= [Link]()
IF (NextSubmit &= NULL) THEN BREAK.
CurFeq = [Link]
CASE (CurFeq)
OF FEQ:UNKNOWN
[Link]([Link], [Link])
ELSE
IF ([Link](CurFeq))
IF ([Link])
IF (NOT CurFeq{PROP:disable}) AND (NOT CurFeq{PROP:readonly})
[Link](NextSubmit)
END
END
END
END
END

SeeAlso: TakeRequest
CHAPTER 7 WEBWINDOWCLASS 215

TitleContents (set browser titlebar)

TitleContents( html object ),VIRTUAL

TitleContents Generates the HTML representation of the WINDOW’s

titlebar text.
html target The label of the HtmlClass object that writes the HTML
code representing the window.
The TitleContents method generates the HTML representation of the
WINDOW’s titlebar text, primarily for use in the Client browser’s titlebar.

TitleContents is a VIRTUAL method so that other base class methods can

directly call the TitleContents virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The TitleContents method surrounds the WINDOW’s PROP:Text value with
quotations suitable for the Client browser.

The CreatePageHeader method calls the TitleContents method.

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE
[Link]('<<HTML>')
[Link]()
IF ([Link] = Update:Refresh)
[Link]([Link])
END
[Link]('<<HEAD>')
[Link]('<<TITLE>')
[Link](Target)
[Link]('<</TITLE>')
!etc.

SeeAlso: CreatePageHeader
216 IBC LIBRARY REFERENCE

ValidatePassword (verify password)

ValidatePassword( username, password ), BYTE. VIRTUAL

ValidatePassword Sets the password required to access the Web page

representing the WINDOW.
username A string constant, variable, EQUATE, or expression
containing the username.
password A string constant, variable, EQUATE, or expression
containing the password.
The ValidatePassword method verifies that the password entered by the end
user matches the authorized password for the Web page. ValidatePassword
ignores the username; however, the Internet Connect Templates provide the
Internet, password validation - data section and the Internet, password
validation - code section embed points so you can validate the username if
you choose.

ValidatePassword is a VIRTUAL method so that other base class methods

can directly call the ValidatePassword virtual method in a derived class. This
lets you easily implement your own custom version of this method.

Return DataType: BYTE

Example:
[Link] PROCEDURE
Password STRING(255)
UserName STRING(255)
CODE
[Link]([Link], UserName, Password)
RETURN [Link](UserName, Password)

SeeAlso: Authorize, AuthorizeArea, CreateUnauthorizedPage, GetAuthorized,

TakeCreatePage, SetPassword
CHAPTER 8 WEB CONTROL CLASS 217

WEB CONTROL CLASS

GetFont (add font information)........................................................................... 240

GetHasHotkey (control text contains ‘&’)...........................................................240
GetIsChild (return family identity) ......................................................................241
GetLevel (return nesting level)................................................................................242
GetNameAttribute (return HTML control name) ................................................242
GetParentBackgroundColor (return parent background color) ...........................243
GetPosition (get control coordinates) ................................................................. 244
GetQuotedText (return control text in quotes) ....................................................245
GetTableAttributes (return HTML STYLE)........................................................245
GetText (return control text) ................................................................................245
GetUseChanged (return contents changed indicator) ......................................... 246
GetVisible (return control status flag) .................................................................247
Init (initialize the WebControlClass object) ........................................................248
Kill (shut down the WebControlClass object) .....................................................249
PopFont (restore pre-PushFont font) .................................................................. 250
PushFont (implement control font) ......................................................................251
RefreshDisabled (update Web page control status) .............................................252
ResetControl (update server control) ...................................................................253
ResetFromQueue (record changes to Server LIST queue) ................................. 254
SetAutoSpotLink (a virtual to set AutoSpotLink) .............................................. 255
SetBorderWidth (a virtual to set BorderWidth) ...................................................255
SetBreakable (allow word wrap) .........................................................................256
SetChildDefaults (a virtual to set Web page control children) ............................256
SetDescription (a virtual to set AltText) .................................................................257
SetEventAction (associate browser action with control event) .......................... 258
SetParentDefaults (confirm parent) .....................................................................260
SetQueue (a virtual to set the FromQ property) ..................................................261
UpdateCopyChoice (save selected item number) ................................................261
UpdateCopyUse (save copy of control contents).................................................262
CHAPTER 8 WEB CONTROL CLASS 219

WebControlClassConcepts

The WebControlClass analyzes a single Clarion control and generates the

HTML code to duplicate the Clarion control on a Web page.

The WebControlClass manages the HTML equivalent of a Clarion control, or

other window component such as a window titlebar or client area. This class
manages control attributes (color, font, position, enable/disable, etc.), parent/
child relationships (for positioning and property inheritence purposes), and
any special browser events or actions associated with the control. For
example, you may associate a “partial page update” action with a check box
so that a filter invoked by the check box immediately displays in the Client
browser.

The WebControlClass manages the control attributes and behaviors that are
common to all Clarion controls. For example, MSG attributes are handled
the same for all controls; however, the HTML code generated for a CHECK
is different than for an ENTRY. Therefore, each specific type of Clarion
control also has its own class derived from the WebControlClass to
implement type-specific behavior. For example, the WebHtmlPromptClass
represents a PROMPT, and the WebHtmlEntryClass represents an ENTRY,
etc. These derived classes are documented in the WebControlClass Derived
Classes chapter.

Relationship toOther Internet Builder Classes

HtmlItemClass

The WebControlClass is derived from the HtmlItemClass. The

HtmlItemClass is an abstract class that does no real work; it simply provides
a means for other classes to reference any of its derived classes. The
WebControlClass and its derived control-specific classes
(WebHTMLPromptClass, WebHTMLEntryClass, etc.) provide all of the
WebControlClass object’s functionality.

WebWindowClass

The WebWindowClass creates and manages instances of the

WebControlClass as needed to generate HTML for each control in the
WINDOW.
220 IBC LIBRARY REFERENCE

LayoutHtmlClass

The LayoutHtmlClass uses instances of the WebControlClass to optimally

format, position, and align the Web page controls on the Web page generated
by the WebWindowClass object.

Internet ConnectTemplate Implementation

The WebWindowClass creates and manages instances of the

WebControlClass as needed to generate HTML for each control in the
WINDOW. Therefore, the template generated code generally only references
a few WebControlClass objects during procedure initialization, for example:
PrepareProcedure ROUTINE
!routine code
IC:CurControl &= [Link](?Browse:1)
IC:[Link](Queue:Browse:1)

SourceFiles

The WebControlClass source code is installed by default to the \LIBSRC

folder. The WebControlClass declarations are in the following .INC files.
The corresponding method definitions are in the corresponding .CLW file.

[Link] HtmlItemClass

[Link] WebControlClass
CHAPTER 8 WEB CONTROL CLASS 221

WebControlClass Proper ties

ActionOnAccept (browser actionfor control)
ActionOnAccept BYTE
The ActionOnAccept property indicates the action the browser takes when
the Web page control is accepted.

There are three valid actions. Update:Full submits any entered items and
requests a complete screen redraw. Update:Partial submits any entered items
and requests only the data to fill Java controls (see JSL Manager Class).
Update:OnBrowser updates the Web page as far as possible without
contacting the Server.

Implementation: The Init method sets the initial value of the ActionOnAccept property. The
SetEventAction method sets subsequent values of ActionOnAccept. The
GetEventAction returns the action the browser takes when the control is
accepted.

EQUATEs for the ActionOnAccept property are declared in [Link] as

follows:
Update:OnBrowser EQUATE(0)
Update:Partial EQUATE(1)
Update:Full EQUATE(2)

Update:Refresh is only valid for windows with a TimerDelay. It is not

appropriate for the [Link] property.

SeeAlso: Init, GetEventAction, SetEventAction

222 IBC LIBRARY REFERENCE

Container (container control)

Container &WebControlClass
The Container property is a reference to another WebControlClass object
that is the container of this WebControlClass object.

The WebControlClass object uses this property to allow controls to inherit

properties from their container controls.

Implementation: The Init method sets the Container property to NULL.

The IBC Library objects use container controls to group multiple Java
controls into a single Java container control. Grouping these controls
optimizes the performance of the Server (Web-enabled application). The
Server generates and transmits less HTML code, and the containerized Java
applets initialize and display faster on the Client machine.

SeeAlso: Init

DisabledAction(HTML fordisabledcontrol)
DisabledAction BYTE
The DisabledAction property indicates how the disabled control is
represented on the Web page. This property lets you determine how to handle
controls that are disabled under Windows, but cannot be disabled under a
browser, because the HTML control does not support disabling.

Valid actions include, always display the disabled control, always hide the
disabled control, and disable the control if HTML supports it, otherwise hide
the control.

Implementation: The Init method sets the initial value of the DisabledAction property to equal
the [Link] property. You may override the
DisabledAction for a control with a simple assignment statement.

EQUATEs for the DisabledAction property are declared in [Link]

as follows:
ITEMIZE,PRE(DISABLE)
Hide EQUATE !always hide disabled control
OptHide EQUATE !hide if HTML control won’t disable
Show EQUATE !always show disabled
control END

SeeAlso: Init, [Link]

CHAPTER 8 WEB CONTROL CLASS 223

Feq(control number)
Feq SIGNED
The Feq property contains the control’s control number (field equate). The
WebWindowClass uses this property to uniquely identify the control.

Implementation: The Init method sets the value of the Feq property.

SeeAlso: Init

IsDynamic (memoryallocatedflag)
IsDynamic BYTE
The IsDynamic property indicates whether memory was allocated for the
WebControlClass object. The WebWindowClass object uses this property to
free the allocated memory.

Implementation: The [Link] method DISPOSEs the WebControlClass object

based on the value of the IsDynamic property.

SeeAlso: [Link]

OwnerWindow (owner window)

OwnerWindow &WebWindowBaseClass
The OwnerWindow property is a reference to the WebWindowClass object
that instantiated this WebControlClass object. The WebControlClass object
uses this property to reference WebWindowClass methods and properties.

Implementation: The Init method sets the value of the OwnerWindow property.

SeeAlso: Init
224 IBC LIBRARY REFERENCE

ParentFeq(Webpage parent control )

ParentFeq SIGNED
The ParentFeq property contains the control number (field equate) of the
parent control for Web page purposes. The WebWindowClass uses this
property to maintain a position-based parent/child relationship that allows
proper positioning and processing of controls on the Web page.

Implementation: The SetChildDefaults method sets the value of the ParentFeq property.

SeeAlso: SetChildDefaults

RealParentFeq(windowparent control)
RealParentFeq SIGNED, PROTECTED
The RealParentFeq property contains the control number (field equate) of
the parent control for window purposes. The WebWindowClass uses this
property to allow child controls inherit properties from their parents.

This property is PROTECTED, therefore, it can only be referenced by a

WebControlClass method, or a method in a class derived from
WebControlClass.

Implementation: The Init method sets the value of the ParentFeq property.

SeeAlso: Init
CHAPTER 8 WEB CONTROL CLASS 225

WebControlClass Methods
The WebControlClass inherits all the methods of the HtmlItemClass from
which it is derived.

In addition to (or instead of) the inherited methods, the WebControlClass

contains the methods listed below.

Functional Organization—ExpectedUse

As an aid to understanding the WebControlClass, it is useful to organize the

its various methods into two categories according to their expected use—the
primary interface and the virtual methods. This organization reflects what we
believe is typical use of these methods.

Primary Interface Methods

The primary interface methods are called from outside the WebControlClass.
That is, the WebWindowClass methods call these methods fairly routinely.
These primary interface methods can be further divided into three categories
according to their use:

Housekeeping (one-time) Use:

InitV initialize WebControlClass object
SetAutoSpotLinkV generate live hypertext links
SetBorderWidthV set control border width
SetQueueV set list data source queue
KillV shut down WebControlClass object

Mainstream Use:
BeforeResetControlV preprocess control
CreateHtmlV write HTML for control and children
CreateJslDataV update Web page control
RefreshDisabled update Web page control status
ResetFromQueueV record changes to Server LIST queue
ResetControlV update Server control
UpdateCopyUse save copy of control contents
UpdateCopyChoice save selected item number
V
These methods are also Virtual.
226 IBC LIBRARY REFERENCE

Occasional Use:
CreateColorParameters write Java applet color parameters
CreateCellHeader begin HTML for control attributes
CreateCellFooter end HTML for control attributes
DoSetChildDefaults set nested child controls
GetChoiceChanged return selection change
GetFont add font information
GetLevel return nesting level
GetNameAttribute return HTML control name
GetQuotedText return control text in quotes
GetUseChanged return contents changed indicator
SetDirty force list refresh

Virtual Methods

BeforeResetControl preprocess control

CreateCellContents write HTML for control
CreateHtml write HTML for control and children
CreateJslData update Web page control
GetBackgroundColor return background color
GetCanDisable return disable-ability flag
GetCellAttributes return control attributes
GetEventAction return browser action
GetHasHotkey control text may contain &
GetIsChild return family identity
GetPosition get control coordinates
GetText return control text
GetVisible return control status flag
Init initialize WebControlClass object
Kill shut down WebControlClass object
PopFont restore pre-PushFont font
PushFont implement control font
ResetFromQueue record changes to Server LIST queue
ResetControl update server control
SetAutoSpotLink generate live hypertext links
SetBorderWidth set control border width
SetChildDefaults set Web page control children
SetDirty force list refresh
SetEventAction associate browser action with control
SetParentDefaults confirm parent control
SetQueue set list data source queue
CHAPTER 8 WEB CONTROL CLASS 227

BeforeResetControl (avirtual for control preprocessing)

BeforeResetControl, VIRTUAL
The BeforeResetControl method is a virtual placeholder to do any control
specific processing prior to synchronizing the window control with its
corresponding Web page control.

BeforeResetControl is a VIRTUAL method so that other base class methods

can directly call the BeforeResetControl virtual method in a derived class.
This lets you easily implement your own custom version of this method.

CreateCellContents (write HTMLfor control)

CreateCellContents( html object ), VIRTUAL, PROTECTED

CreateCellContents
A virtual placeholder to write the HTML code represent-
ing the control.
html object The label of the HtmlClass object that writes the HTML
code.
The CreateCellContents method is a virtual placeholder to write the HTML
code representing the control.

CreateCellContents is a VIRTUAL method so that other base class methods

can directly call the CreateCellContents virtual method in a derived class.
This lets you easily implement your own custom version of this method.

This method is PROTECTED, therefore, it can only be called by a

WebControlClass method, or a method in a class derived from
WebControlClass.

Implementation: The proper positioning of each Web page control is accomplished by using
HTML <TABLE> and <CELL> statements. CreateCellContents writes only
the HTML code representing the control. The HTML code defining the
<TABLE> and the <CELL> containing the control is written by other
methods including [Link], CreateCellHeader, and
CreateCellFooter.

SeeAlso: CreateHtml, CreateCellHeader, CreateCellFooter,

[Link]
228 IBC LIBRARY REFERENCE

CreateCellFooter (endHTML for control attributes)

CreateCellFooter( html object ), PROTECTED

CreateCellFooter Ends the HTML representing control attributes.

html object The label of the HtmlClass object that writes the HTML
code.
The CreateCellFooter method ends the HTML representing control
attributes.

This method is PROTECTED, therefore, it can only be called by a

WebControlClass method, or a method in a class derived from
WebControlClass.

Implementation: CreateCellHeader ends the HTML Font specifications for the control.

Example:
[Link] PROCEDURE(*HtmlClass Target)
CODE
[Link](Target)
[Link](Target)
[Link](Target)

CreateCellHeader (begin HTMLfor control attributes)

CreateCellHeader( html object ), PROTECTED

CreateCellHeader
Begins the HTML representing control attributes.
html object The label of the HtmlClass object that writes the HTML
code.
The CreateCellHeader method begins the HTML representing control
attributes.

This method is PROTECTED, therefore, it can only be called by a

WebControlClass method, or a method in a class derived from
WebControlClass.

Implementation: CreateCellHeader begins the HTML Font specifications for the control.

Example:
[Link] PROCEDURE(*HtmlClass Target)
CODE
[Link](Target)
[Link](Target)
[Link](Target)
CHAPTER 8 WEB CONTROL CLASS 229

CreateColorParameters (write Java applet color parameters)

CreateColorParameters( html object [, autospotlink] ), PROTECTED

CreateColorParameters
Generates the HTML/JavaScript to specify the control’s
foreground and background colors.
html object The label of the HtmlClass object that writes the HTML
code.
autospotlink An integer constant, variable, EQUATE, or expression
indicating whether this control is a hyperlink. A value of
one (1 or True) indicates a hyperlink; a value of zero (0
or False) indicates no hyperlink. If omitted, autospotlink
defaults to False.
The CreateColorParameters method generates the HTML or JavaScript to
specify the control’s foreground and background colors.

This method is PROTECTED, therefore, it can only be called by a

WebControlClass method, or a method in a class derived from
WebControlClass.

Implementation: The CreateColorParameters method sets the foreground color based on the
CreateForeColorParameter method. It sets the background color based on the
GetBackgroundColor method.

The autospotlink parameter has no effect, but is provided so colors can be

adjusted for hyperlink controls.

Example:
[Link] PROCEDURE(*HtmlClass Target)
CurFont HtmlFontClass
CODE
[Link](CurFont)
[Link] = [Link]()
[Link](Target, [Link])
[Link]('Text', [Link])
[Link]('Align', [Link]())
[Link](CurFont)
IF ([Link])
[Link]('Wrap', '1')
END
IF ([Link])
[Link]('AutoSpotLink', [Link])
END

SeeAlso: CreateForeColorParameter, GetBackgroundColor

230 IBC LIBRARY REFERENCE

CreateForeColorParameter (write Java applet foregroundcolor parameter)

CreateForeColorParameter( html object ), PROTECTED

CreateForeColorParameter
Generates the HTML/JavaScript to specify the control’s
foreground color.
html object The label of the HtmlClass object that writes the HTML
code.
The CreateForeColorParameter method generates the HTML or
JavaScript to specify the control’s foreground color.

This method is PROTECTED, therefore, it can only be called by a

WebControlClass method, or a method in a class derived from
WebControlClass.

Implementation: The CreateForeColorParameter method sets the foreground color based on

the Clarion control’s FONT attribute.

Example:
[Link] PROCEDURE(*HtmlClass Target,BYTE AutoSpotLink)
BackColor LONG,AUTO
CODE
[Link](Target)
BackColor = [Link]()
IF (BackColor <> COLOR:None)
[Link]('BackColor', IC:RGB(BackColor))
END
IF (AutoSpotLink)
END
CHAPTER 8 WEB CONTROL CLASS 231

CreateHtml (write HTMLfor control andits attributes)

CreateHtml( html object ), VIRTUAL

CreateHtml Writes the HTML code representing the control and its
attributes.
html object The label of the HtmlClass object that writes the HTML
code.
The CreateHtml method writes the HTML code representing the control
and its attributes. CreateHtml also serves as a placeholder method for many
derived classes—one for each control type. See WebControlClass Derived
Classes.

CreateHtml is a VIRTUAL method so that other base class methods can

directly call the CreateHtml virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The [Link] method calls the

[Link] method.

Example:
[Link] PROCEDURE(*HtmlClass Target)
CurItem &HtmlItemClass,AUTO
!procedure data
CODE
!procedure code
LOOP Xindex = 1 TO RECORDS([Link]) !for all controls
GET([Link], Xindex)
CurCell &= [Link]
NumItems = RECORDS([Link])
[Link]('<<TD' & [Link]() & '>') !begin HTML CELL
LOOP Index = 1 TO NumItems !for all CELL items
CurItem &= [Link](Index) !set WebControl object
Style = [Link](Target) !get control attributes
IF (Style)
[Link]('<<P ' & Style & '>') !begin HTML STYLE
END
[Link](Target) !write HTML control
IF (Style)
[Link]('<</P>') !end HTML STYLE
END
END
[Link]('<</TD>') !end HTML CELL
END
!procedure code

SeeAlso: [Link]
232 IBC LIBRARY REFERENCE

CreateHtmlExtra (write HTMLfor relatedcontrol)

CreateHtmlExtra( html object ), VIRTUAL

CreateHtmlExtra A virtual placeholder to write any HTML required by a

related control.
html object The label of the HtmlClass object that writes the HTML
code.
The CreateHtmlExtra method is a virtual placeholder method to write
HTML required by another, related control. For example, a
WebHtmlRegionClass object may generate some HTML code required by its
parent WebHtmlImageClass object.

CreateHtmlExtra is a VIRTUAL method so that other base class methods can

directly call the CreateHtmlExtra virtual method in a derived class. This lets
you easily implement your own custom version of this method.

SeeAlso: [Link]

CreateJslData (updateWebpagecontrols)
CreateJslData( Jsl manager ), VIRTUAL

CreateJslData Is a virtual placeholder method to write Java Support

Library (JSL) data to synchronize the Web page control
with its corresponding WINDOW control.
Jsl manager The label of the JSLManagerClass object that sends data
to Java applets on the Web page.
The CreateJslData method is a virtual placeholder method to write Java
Support Library (JSL) data to synchronize the Web page control with its
corresponding WINDOW control.

CreateJslData is a VIRTUAL method so that other base class methods can

directly call the CreateJslData virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The [Link] method calls the

[Link] method.
CHAPTER 8 WEB CONTROL CLASS 233

CreateParams (write all parameters for Java control)

CreateParams( html object ), VIRTUAL

CreateParams A virtual placeholder to write all the applet parameters

for a Java control.
html object The label of the HtmlClass object that writes the HTML
code.
The CreateParams method is a virtual placeholder method to write all the
applet parameters for a Java control.

CreateParams is a VIRTUAL method so that other base class methods can

directly call the CreateParams virtual method in a derived class. This lets you
easily implement your own custom version of this method.

DoSetChildDefaults (set nestedchild controls)

DoSetChildren, PROTECTED
The DoSetChildDefaults method sets the children of this control,
considering only controls that have the same parent. This has the effect of
properly relating layered (stacked) controls, nested controls, or both. For
example a REGION control on top of an IMAGE control (layered to
generated events for the IMAGE), or a SHEET control and its TAB controls
on top of a LIST control (layered and nested to give the appearance of a
LIST for each TAB), or a BUTTON control within an OPTION control
(simple nesting to give proper visual organization of related controls).

This method is PROTECTED, therefore, it can only be called by a

WebControlClass method, or a method in a class derived from
WebControlClass.

Implementation: The DoSetChildDefaults method calls the [Link]

method to identify siblings, and the [Link]
method to set the ParentFeq property for the children of this control.

Example:
[Link] PROCEDURE
CODE
[Link]

SeeAlso: ParentFeq, [Link],

[Link]
234 IBC LIBRARY REFERENCE

GetAlignText (return textalignment information)

GetAlignText, STRING
The GetAlignText method returns a the control text alignment information
for the WINDOW control, such as ‘LEFT,’ ‘RIGHT,’ or ‘CENTER.’
GetAlignText returns a null string if there is no alignment information.

Implementation: The GetAlignText method provides text alignment information for Java
applets that support text alignment.

Return DataType: STRING

Example:
[Link] PROCEDURE(*HtmlClass Target,SIGNED Width,SIGNED Height)
Filename CSTRING(FILE:MaxFileName)
CODE
IF (NOT [Link]) THEN RETURN.
[Link] = [Link]{PROP:enabled}
Filename = [Link]()
[Link]([Link], 'ClarionImageButton', Width, Height)
[Link]('Picture', Filename)
[Link]('Label', [Link]())
[Link]('Hint', [Link]{PROP:tooltip})
[Link]('Align', [Link]())
IF ([Link](EVENT:Accepted) = Update:Full)
[Link]('Submit', 1)
END
IF (NOT [Link])
[Link]('Disabled', '1')
END
[Link]

GetAppletType(return applet type)

GetAppletType, STRING, VIRTUAL
The GetAppletType method is a virtual placeholder method to return the
applet type for the control. The type corresponds to an applet defined in the
Java Support Library. See Jsl Manager Class for more information on the
Java Support Library.

GetAppletType is a VIRTUAL method so that other base class methods can

directly call the GetAppletType virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Return DataType: STRING

CHAPTER 8 WEB CONTROL CLASS 235

GetBackgroundColor (return backgroundcolor)

GetBackgroundColor( [default color] ), LONG, VIRTUAL

GetBackgroundColor
Returns the background color of the control.
default color An integer variable, constant, EQUATE, or expression
containing the color to return if there is no background
color. If omitted, default color defaults to Color:None.
The GetBackgroundColor method returns the background color of the
control.

GetBackgroundColor is a VIRTUAL method so that other base class

methods can directly call the GetBackgroundColor virtual method in a
derived class. This lets you easily implement your own custom version of
this method.

Implementation: The GetBackgroundColor method returns the COLOR attribute of the

window control, if there is one. Otherwise, it calls the
GetParentBackgroundColor method to supply an inherited color.

EQUATEs for the default color parameter are declared in

\LIBSRC\[Link].

Return DataType: LONG

Example:
[Link] PROCEDURE(*HtmlClass Target, BYTE AutoSpotLink)
ForeColor LONG,AUTO
BackColor LONG,AUTO
CODE
GETFONT([Link],,, ForeColor)
BackColor = [Link]()
IF (ForeColor <> 0) AND (ForeColor <> COLOR:None)
[Link]('ForeColor', IC:RGB(ForeColor))
END
IF (BackColor <> COLOR:None)
[Link]('BackColor', IC:RGB(BackColor))
END

SeeAlso: GetParentBackgroundColor
236 IBC LIBRARY REFERENCE

GetCanDisable (return disable-ability flag)

GetCanDisable, BYTE, VIRTUAL
The GetCanDisable method returns a value indicating whether the Web
page control can be disabled. A return value of one (1) indicates the control
can be disabled; a return value of zero (0) indicates the control cannot be
disabled.

GetCanDisable is a VIRTUAL method so that other base class methods can

directly call the GetCanDisable virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: The [Link] method calls the GetCanDisable method.

Return DataType: BYTE

Example:
[Link] PROCEDURE

CODE
IF ([Link] = DISABLE:Hide) OR |
(([Link] = DISABLE:OptHide) AND NOT [Link]())
IF NOT [Link]{PROP:enabled}
RETURN FALSE
END
END
RETURN [Link]{PROP:visible}

SeeAlso: [Link], [Link]

CHAPTER 8 WEB CONTROL CLASS 237

GetCellAttributes(return control attributes)

GetCellAttributes( html object ), STRING, VIRTUAL

GetCellAttributes Returns HTML to set attributes associated with the Web

page control.
html object The label of the HtmlClass object that writes the HTML
code.
The GetCellAttributes method returns HTML to set attributes associated
with the Web page control. If there are no associated attributes,
GetCellAttributes returns a null string.

GetCellAttributes is a VIRTUAL method so that other base class methods

can directly call the GetCellAttributes virtual method in a derived class. This
lets you easily implement your own custom version of this method.

Implementation: The GetCellAttributes method returns HTML to set the font typeface, size,
color, and style of the HTML <TABLE> <CELL> containing the control.

The [Link] method calls the GetCellAttributes

method.

Return DataType: STRING

Example:
[Link] PROCEDURE(*HtmlClass Target)

CurCell &LayoutCellClass,AUTO
Index SIGNED,AUTO
NumRows SIGNED,AUTO
Xindex SIGNED,AUTO
Yindex SIGNED,AUTO

CODE
NumRows = RECORDS([Link])
[Link]('<<TABLE' & [Link] & '>')
LOOP Yindex = 1 TO NumRows
GET([Link], Yindex)
[Link]('<<TR>')
LOOP Xindex = 1 TO RECORDS([Link])
GET([Link], Xindex)
CurCell &= [Link]
[Link]('<<TD' & [Link]() & '>')
[Link]('<</TD>')
END
[Link]('<</TR>')
END
[Link]('<</TABLE>')

SeeAlso: [Link]
238 IBC LIBRARY REFERENCE

GetChoiceChanged(return selectionchange)
GetChoiceChanged, BYTE
The GetChoiceChanged method returns a value indicating whether the end
user selected a different item within the control. A return value of one (1)
indicates a new selection; a return value of zero (0) indicates no change.

The WebControlClass uses this method and the UpdateCopyChoice method

to minimize the data sent to the Client browser—no Java Support Library
(JSL) data is generated for unchanged controls.

Return DataType: BYTE

Example:
[Link] PROCEDURE(*JslManagerClass Target)

CODE
IF ([Link]())
[Link]([Link], CHOICE([Link]))
[Link]
END

SeeAlso: UpdateCopyChoice
CHAPTER 8 WEB CONTROL CLASS 239

GetEventAction(return browser action)

GetEventAction( event ), SIGNED, VIRTUAL

GetEventAction Returns the browser action for the specified event.

event An integer constant, variable, EQUATE, or expression
indicating the event for which to return the action.
The GetEventAction method returns the browser action associated with the
specified event. The WebControlClass object uses this method to generate
appropriate HTML/JavaScript for the control.

The SetEventAction associates browser actions with events.

GetEventAction is a VIRTUAL method so that other base class methods can

directly call the GetEventAction virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: EQUATEs for the return values are declared in [Link] as follows:
EVENT:NewPage EQUATE(280H) ! Build a new page now
EVENT:Initialize EQUATE(281H) ! List box wants contents
EVENT:RefreshPage EQUATE(282H) ! Refresh a browse box

Update:OnBrowser EQUATE(0)
Update:Partial EQUATE(1)
Update:Full EQUATE(2)

Return DataType: SIGNED

Example:
[Link] PROCEDURE(*HtmlClass Target)
Filename CSTRING(FILE:MaxFileName)
CODE
[Link] = [Link]{PROP:enabled}
Filename = [Link]()
[Link]('Picture', Filename)
[Link]('Label', [Link]())
[Link]('Hint', [Link]{PROP:tooltip})
[Link]('Align', [Link]())
IF ([Link](EVENT:Accepted) = Update:Full)
[Link]('Submit', 1)
END
IF (NOT [Link])
[Link]('Disabled', '1')
END

SeeAlso: SetEventAction
240 IBC LIBRARY REFERENCE

GetFont (add font information)

GetFont( font object )

GetFont Adds the control’s font information to the font object.

font object The label of the HtmlFontClass object that manages font
information.
The GetFont method adds the control’s font information to the font object
for subsequent retrieval by other methods such as PushFont. The font
information includes the typeface, size, color, and style.

Example:
[Link] PROCEDURE(*HtmlClass Target)
Border SIGNED(0)
CODE
[Link]('<<INPUT TYPE=SUBMIT VALUE="')
[Link](IC:QuoteText([Link](), IC:RESET:HotValue) & '"')
[Link]([Link](Target))
[Link]('>')

SeeAlso: PushFont

GetHasHotkey (control text contains‘&’)

GetHasHotKey, BYTE, VIRTUAL
The GetHasHotKey method returns a value indicating whether the control
text may contain the Clarion hot key delimiter (&). A return value of one (1)
indicates a possible hot key; a return value of zero (0) indicates no hot key.
The WebControlClass object uses this method to remove the hot key
delimiter from Web page text.

GetHasHotKey is a VIRTUAL method so that other base class methods can

directly call the GetHasHotKey virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: The GetText method calls the GetHasHotKey method to identify controls
that may have Clarion hot key delimiters (&).

Return DataType: BYTE

Example:
[Link] PROCEDURE
CODE
IF ([Link]())
RETURN IC:StripHotkey(CLIP([Link]{PROP:ScreenText}))
END
RETURN CLIP([Link]{PROP:ScreenText})

SeeAlso: GetText
CHAPTER 8 WEB CONTROL CLASS 241

GetIsChild (return family identity)

GetIsChild( parent control [,control type] ), SIGNED, VIRTUAL

GetIsChild Returns a value indicating whether this WebControlClass

object is a visible child control of the specified parent
control and control type.
parent control An integer constant, variable, EQUATE, or expression
containing the parent control’s control number, or zero
(0) if the WINDOW is the parent.
control type An integer constant, variable, EQUATE, or expression
containing the type of control sought. If omitted, any
control type is valid.
The GetIsChild method returns a value indicating whether this
WebControlClass object is a visible child control of the specified parent
control and control type. If this WebControlClass object meets the specified
criteria it returns its own control number (Feq property), otherwise it returns
zero (0) to indicate it does not meet the specified criteria.

GetIsChild is a VIRTUAL method so that other base class methods can

directly call the GetIsChild virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The [Link] method calls the GetIsChild method to

find first child controls.

EQUATEs for the control type parameter are declared in [Link].

Each control type EQUATE is prefixed with CREATE:.

Return DataType: SIGNED

Example:
[Link] PROCEDURE(SIGNED ParentFeq, SIGNED Type=0)
Index SIGNED,AUTO
FirstChild SIGNED(0)
CODE
LOOP Index = 1 TO RECORDS([Link])
GET([Link], Index)
IF ([Link] = ParentFeq)
FirstChild = [Link](ParentFeq, Type)
IF (FirstChild)
BREAK
END
END
END
RETURN FirstChild

SeeAlso: Feq, [Link]

242 IBC LIBRARY REFERENCE

GetLevel (return nestinglevel)

GetLevel, SIGNED
The GetLevel method returns the control’s nesting level. The
WebControlClass object uses this method to properly position (indent)
menus and menu items.

Return DataType: SIGNED

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE
[Link]('<<NOBR>')
[Link](([Link]()-1)*2)
[Link]([Link]())
[Link]('<</NOBR><<BR>')

GetNameAttribute (return HTML control name)

GetNameAttribute( html object ), STRING

GetNameAttribute Returns the HTML name of the Web page control.

html object The label of the HtmlClass object that writes the HTML
code.
The GetNameAttribute method returns the HTML name of the Web page
control. The WebControlClass object uses this method to generate the control
name in HTML code.

Implementation: The GetNameAttribute method converts the Clarion control number (field
equate) into a valid, unique HTML control name.

Return DataType: STRING

Example:
[Link] PROCEDURE(*HtmlClass Target)

Border SIGNED(0)

CODE
[Link]('<<INPUT TYPE=SUBMIT VALUE="')
[Link](IC:QuoteText([Link](), IC:RESET:HotValue) & '"')
[Link]([Link](Target))
[Link]('>')
CHAPTER 8 WEB CONTROL CLASS 243

GetParentBackgroundColor (return parent backgroundcolor)

GetParentBackgroundColor( [default color] ), LONG, VIRTUAL

GetParentBackgroundColor
Returns the background color of the parent control.
default color An integer variable, constant, EQUATE, or expression
containing the color to return if there is no background
color. If omitted, default color defaults to Color:None.
The GetParentBackgroundColor method returns the background color of
the parent control or window. The WebControlClass object uses this method
to allow controls to inherit colors from their parent controls.

GetParentBackgroundColor is a VIRTUAL method so that other base class

methods can directly call the GetParentBackgroundColor virtual method in a
derived class. This lets you easily implement your own custom version of
this method.

Implementation: The GetParentBackgroundColor method calls the GetBackgroundColor

method for the control’s parent. The parent may be another control or the
WINDOW.

EQUATEs for the default color parameter are declared in

\LIBSRC\[Link].

Return DataType: LONG

Example:
[Link] PROCEDURE
BackColor LONG
CODE
BackColor = [Link]{PROP:background}
IF (BackColor <> COLOR:None)
RETURN BackColor
END
RETURN [Link]()

SeeAlso: GetBackgroundColor
244 IBC LIBRARY REFERENCE

GetPosition(get control coordinates)

GetPosition( x, y, width, height ), VIRTUAL

GetPosition Returns the control coordinates.

x A numeric variable to receive the control’s horizontal
position.
y A numeric variable to receive the control’s vertical
position.
width A numeric variable to receive the control’s width.
height A numeric variable to receive the control’s height.
The GetPosition method returns the control’s WINDOW coordinates. The
WebWindowClass and the WebControlClass use this method to help set
appropriate position-based parent/child relationships for the controls. The
LayoutHtmlClass uses this information to help position the control on the
Web page.

GetPosition is a VIRTUAL method so that other base class methods can

directly call the GetPosition virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The GetPosition method uses the GETPOSITION procedure. See the
Language Reference for more information.

Example:
[Link] PROCEDURE

Children WebControlQueue
MyRect GROUP(Rect)
END
CODE
[Link](MyRect.x, MyRect.y, [Link], [Link])
[Link](Children, [Link])
[Link](Children, SELF, MyRect)
CHAPTER 8 WEB CONTROL CLASS 245

GetQuotedText (return control text in quotes)

GetQuotedText, STRING
The GetQuotedText method returns control text within quotation marks
recognized by the Client browser. For example, some browsers require single
quotes (‘), while others require double quotes (“).

Implementation: GetQuotedText calls the GetText method to retrieve the control’s text.

Return DataType: STRING

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE
[Link]('<<NOBR>')
[Link](([Link]()-1)*2)
[Link]('<<A HREF="' & [Link]([Link]) & '">')
[Link]([Link]() & '<</A>')
[Link]('<</NOBR><<BR>')

SeeAlso: GetText

GetTableAttributes (return HTML STYLE)

GetTableAttributes, STRING, VIRTUAL
The GetTableAttributes method returns the HTML <STYLE> string for the
HTML <TABLE> representing the control. Several WebControlClass
objects, such as WebHtmlGroupClass and WebHtmlOptionClass objects
translate their Clarion controls to an HMTL <TABLE>.

GetTableAttributes is a VIRTUAL method so that other base class methods

can directly call the GetTableAttributes virtual method in a derived class.
This lets you easily implement your own custom version of this method.

Implementation: The <STYLE> returned by GetTableAttributes includes only the <TABLE>

<BORDER>.

Return DataType: STRING

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE
[Link](Target, [Link], [Link]())
[Link]

GetText (return control text)

246 IBC LIBRARY REFERENCE

GetText, STRING, VIRTUAL

The GetText method returns the control text minus any Clarion hot key
delimiter (&).

GetText is a VIRTUAL method so that other base class methods can directly
call the GetText virtual method in a derived class. This lets you easily
implement your own custom version of this method.

Implementation: The GetQuotedText method calls the GetText method to retrieve the text.
GetText calls the GetHasHotKey method to identify controls that may have
Clarion hot key delimiters (&). GetText returns PROP:ScreenText for the
control.

Return DataType: STRING

Example:
[Link] PROCEDURE
CODE
RETURN IC:QuoteText([Link](), IC:RESET:Text)

SeeAlso: GetHasHotKey, GetQuotedText

GetUseChanged(return contents changedindicator)

GetUseChanged, BYTE
The GetUseChanged method returns a value indicating whether the control
contents changed. A return value of one (1) indicates a change; a return value
of zero (0) indicates no change. The WebControlClass uses this method and
the UpdateCopyUse method to minimize the data sent to the Client
browser—no JSL data is generated for unchanged controls.

Return DataType: BYTE

Example:
[Link] PROCEDURE(*JslManagerClass Target)
CODE
IF ([Link]())
[Link]([Link], CONTENTS([Link]))
[Link]
END

SeeAlso: UpdateCopyUse
CHAPTER 8 WEB CONTROL CLASS 247

GetVisible (return control statusflag)

GetVisible, BYTE, VIRTUAL
The GetVisible method returns a value indicating whether the control should
appear on the Web page. A return value of one (1) indicates the control
should appear on the Web page; a return value of zero (0) indicates the
control should not appear.

GetVisible is a VIRTUAL method so that other base class methods can

directly call the GetVisible virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: A control may be omitted from the Web page for several reasons: it may be
disabled or hidden, it’s parent may be disabled or hidden, or it may be on a
TAB control that is not selected.

Return DataType: BYTE

Example:
[Link] PROCEDURE(*JslManagerClass Target)
Index SIGNED,AUTO
CODE
LOOP Index = 1 TO RECORDS([Link])
GET([Link], Index)
IF ([Link]())
[Link](Target)
END
END
248 IBC LIBRARY REFERENCE

Init (initialize theWebControlClassobject)

Init( control number, owner window ), VIRTUAL

Init Initializes the WebControlClass object.

control number An integer constant, variable, EQUATE, or expression
containing the control number (field equate).
owner window The label of the WebWindowClass object the control
belongs to.
The Init method initializes the WebControlClass object.

Init is a VIRTUAL method so that other base class methods can directly call
the Init virtual method in a derived class. This lets you easily implement your
own custom version of this method.

Implementation: The Init method sets the initial value of the ActionOnAccept,
DisabledAction, Feq, OwnerWindow, and ParentFeq properties.

The [Link] method calls the Init method.

Example:
[Link] PROCEDURE(SIGNED Feq, *WebControlClass NewControl)

CODE
ASSERT(~NewControl &= NULL)
[Link](Feq, SELF)
[Link](NewControl)

SeeAlso: ActionOnAccept, DisabledAction, Feq, OwnerWindow, ParentFeq,

[Link]
CHAPTER 8 WEB CONTROL CLASS 249

Kill (shut down theWebControlClassobject)

Kill, VIRTUAL
The Kill method frees any memory allocated during the life of the object and
performs any other required termination code.

Kill is a VIRTUAL method so that other base class methods can directly call
the Kill virtual method in a derived class. This lets you easily implement
your own custom version of this method.

Implementation: The [Link] method does nothing. It is a placeholder for

derived class methods such as [Link] and
[Link].

SeeAlso: [Link], [Link].

250 IBC LIBRARY REFERENCE

PopFont (restore pre-PushFont font)

PopFont( html object ), VIRTUAL

PopFont Restores font information to its pre-PushFont state.

html object The label of the HtmlClass object that writes the HTML
code.
The PopFont method restores font information to its pre-PushFont state.
Appropriate use of PushFont and PopFont allow child controls to correctly
inherit or override parent control font information. Appropriate use simply
means pairing a call to PushFont with a subsequent call to PopFont.

PopFont is a VIRTUAL method so that other base class methods can directly
call the PopFont virtual method in a derived class. This lets you easily
implement your own custom version of this method.

Implementation: The PopFont method calls the [Link] method.

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE
[Link](Target)
[Link](Target, FEQ:Menubar)
[Link](Target)

SeeAlso: PushFont
CHAPTER 8 WEB CONTROL CLASS 251

PushFont (implement control font)

PushFont( html object ), VIRTUAL

PushFont Implements the control’s font in the HTML generated

for the control.
html object The label of the HtmlClass object that writes the HTML
code.
The PushFont method implements the control’s font in the HTML generated
for the control. Appropriate use of PushFont and PopFont allow child
controls to correctly inherit or override parent control font information.
Appropriate use simply means pairing a call to PushFont with a subsequent
call to PopFont.

PushFont is a VIRTUAL method so that other base class methods can

directly call the PopFont virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The PopFont method calls the [Link] method.

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE
[Link](Target)
[Link](Target, FEQ:Menubar)
[Link](Target)

SeeAlso: PopFont
252 IBC LIBRARY REFERENCE

RefreshDisabled(updateWebpage control status)

RefreshDisabled( Jsl manager, Server enabled, Client enabled )

RefreshDisabled Updates the control’s enabled/disabled state.

Jsl manager The label of the JSLManagerClass object that sends data
to Java applets on the Web page.
Server enabled A Boolean constant, variable, EQUATE, or expression
indicating the state of the control in the Web-enabled
Clarion application. A value of one (1) indicates an
enabled control; a zero (0) indicates a disabled control.
Client enabled A Boolean constant, variable, EQUATE, or expression
indicating the state of the control on the browser Web
page. A value of one (1) indicates an enabled control; a
zero (0) indicates a disabled control.
The RefreshDisabled method applies the Server control’s enabled/disabled
state to the corresponding Web page control. The WebControlClass uses this
method to make sure the Web page control is enabled or disabled
concurrently with its corresponding Windows control.

Example:
[Link] PROCEDURE(*JslManagerClass Target)

CODE
[Link]([Link])
[Link](Target, 1 - [Link]{PROP:disable}, [Link])
CHAPTER 8 WEB CONTROL CLASS 253

ResetControl (update server control)

ResetControl( submit item ), VIRTUAL

ResetControl Synchronizes the Server control with its corresponding

Web page control.
submit item The label of the SubmitItem object containing the
information submitted by the Client browser for this
control.
The ResetControl method synchronizes the Server control with its
corresponding Web page control. The ResetControl method takes Web page
control information submitted by the Client browser, such as control contents
and events, and applies it to the corresponding Server control.

ResetControl is a VIRTUAL method so that other base class methods can

directly call the ResetControl virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The [Link] method calls the ResetControl method.

Example:
[Link] PROCEDURE

NextSubmit &SubmitItemClass
Curfeq SIGNED,AUTO
CODE
LOOP
NextSubmit &= [Link]()
IF (NextSubmit &= NULL)
BREAK
END
CurFeq = [Link]
IF ([Link](CurFeq))
IF ([Link])
IF (NOT CurFeq{PROP:disable}) AND (NOT CurFeq{PROP:readonly})
[Link](NextSubmit)
END
END
END
END

SeeAlso: [Link]
254 IBC LIBRARY REFERENCE

ResetFromQueue(record changesto Server LISTqueue)

ResetFromQueue( change [,offset] [,number] ), VIRTUAL

ResetFromQueue A virtual to record changes to the Server LIST control.

change An integer constant, variable, EQUATE or expression
that indicates the type of change made to the LIST’s
queue. Valid actions include insert, delete, delete all,
replace, scroll, scroll down, and scroll up.
offset An integer constant, variable, EQUATE or expression
that indicates the direction of a scroll action, or the
relative position of an insert, delete, or replace action. If
omitted, offset defaults to zero (0).
number An integer constant, variable, EQUATE or expression
that indicates the number of list items to scroll for a
scroll action; otherwise the number of list items affected
for an insert, delete, or replace action. If omitted,
number defaults to one (1).
The ResetFromQueue method is a virtual placeholder method to record
changes to the Server LIST control (its FROM attribute or data source
queue), so the same changes can be efficiently applied to the corresponding
Web page control.

ResetFromQueue is a VIRTUAL method so that other base class methods

can directly call the ResetFromQueue virtual method in a derived class. This
lets you easily implement your own custom version of this method.

Implementation: EQUATEs for the how parameter are declared in [Link] as

follows:
ITEMIZE,PRE(ACTION)
Insert EQUATE
Delete EQUATE
Replace EQUATE
DeleteAll EQUATE
Scroll EQUATE
ScrollDown EQUATE
ScrollUp EQUATE
END

SeeAlso: [Link]
CHAPTER 8 WEB CONTROL CLASS 255

SetAutoSpotLink(a virtual to set AutoSpotLink)

SetAutoSpotLink( Boolean ), VIRTUAL

SetAutoSpotLink A virtual placeholder method to set the value of the

AutoSpotLink property in derived classes.
Boolean A Boolean constant, variable, EQUATE or expression
assigned to the AutoSpotLink property. A value of one
(1) generates live hypertext links; a value of zero (0)
generates plain text.
The SetAutoSpotLink method is a virtual placeholder method to set the
value of the AutoSpotLink property in derived classes. The AutoSpotLink
property indicates whether control text that appears to be a URL, email
address, FTP site, etc. is rendered on the Web page as a live hypertext link.

SetAutoSpotLink is a VIRTUAL method so that other base class methods

can directly call the SetAutoSpotLink virtual method in a derived class. This
lets you easily implement your own custom version of this method.

SeeAlso: [Link], [Link]

SetBorderWidth (avirtual to set BorderWidth)

SetBorderWidth( width ), VIRTUAL

SetBorderWidth A virtual placeholder method to set the value of the

BorderWidth property in derived classes.
width An integer constant, variable, EQUATE or expression
assigned to the BorderWidth property.
The SetBorderWidth method is a virtual placeholder method to set the
value of the BorderWidth property in derived classes. The BorderWidth
property determines the Web page control’s border width.

SetBorderWidth is a VIRTUAL method so that other base class methods can

directly call the SetBorderWidth virtual method in a derived class. This lets
you easily implement your own custom version of this method.

SeeAlso: [Link],
[Link], [Link]
256 IBC LIBRARY REFERENCE

SetBreakable (allowwordwrap)
SetBreakable( value ), VIRTUAL

SetBreakable A virtual placeholder method to set the value of the

CanBreak property in derived classes.
value An integer constant, variable, EQUATE or expression
assigned to the CanBreak property.
The SetBreakable method is a virtual placeholder method to set the value of
the CanBreak property in derived classes. The CanBreak property
determines whether or not the contol’s text may be written on more than one
line (wrap).

SetBreakable is a VIRTUAL method so that other base class methods can

directly call the SetBreakable virtual method in a derived class. This lets you
easily implement your own custom version of this method.

SeeAlso: [Link]

SetChildDefaults (avirtual to setWebpage control children)

SetChildDefaults, VIRTUAL
The SetChildDefaults method is a virtual placeholder method to set the
children of the Web page control.

For Web page purposes, a parent/child relationship between controls is

defined by the controls’ positional coordinates. A control whose boundaries
fall entirely within the boundaries of another control is the child of the
surrounding control (if there is no other surrounding control). This position
based relationship allows for correct positioning, alignment and processing
of Web page controls.

SetChildDefaults is a VIRTUAL method so that other base class methods can

directly call the SetChildDefaults virtual method in a derived class. This lets
you easily implement your own custom version of this method.

SeeAlso: [Link],
[Link]
CHAPTER 8 WEB CONTROL CLASS 257

SetDescription(a virtual to set AltText)

SetDescription( text ), VIRTUAL

SetDescription A virtual placeholder method to set the value of the

AltText property in derived classes.
text A string constant, variable, EQUATE or expression
assigned to the AltText property.
The SetDescription method is a virtual placeholder method to set the value
of the AltText property in derived classes.

SetDescription is a VIRTUAL method so that other base class methods can

directly call the SetDescription virtual method in a derived class. This lets
you easily implement your own custom version of this method.

SeeAlso: [Link]
258 IBC LIBRARY REFERENCE

SetEventAction(associate browser actionwith control event)

SetEventAction( event, action ), VIRTUAL

SetEventAction Associates a browser action with a particular control

event.
event An integer constant, variable, EQUATE or expression
identifying the Web control event. Most controls only
support EVENT:Accepted, which is triggered when the
end user presses an OK or Submit button, or the RETURN,
ENTER, or TAB key. However, some list based controls also
support scrolling events, selection events, and others.
action An integer constant, variable, EQUATE or expression
identifying the browser action. Valid actions are
Update:OnBrowser (don’t contact the Server ),
Update:Partial (request Java control data only from the
Server), and Update:Full (request the entire page from
the Server).
The SetEventAction method associates a browser action with a particular
Web page control event. That is, the browser action, such as Update:Partial,
is an attribute of a control. When the end user creates an event for the Web
page control by mouse-clicking or pressing the RETURN, ENTER, or TAB key, the
Client browser requests the action associated with the event. The Clarion
Application Broker forwards the request to the Server application which
processes it.

SetEventAction is a VIRTUAL method so that other base class methods can

directly call the SetEventAction virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: EQUATEs for the event parameter are declared in [Link]. Each
event EQUATE is prefixed with EVENT:. Valid events are
EVENT:Accepted
EVENT:Initialize
EVENT:NewSelection
EVENT:AlertKey
EVENT:Locate
EVENT:ScrollTop
EVENT:ScrollBottom
EVENT:PageUp
EVENT:PageDown
EVENT:ScrollUp
EVENT:ScrollDown
EVENT:ScrollDrag
EVENT:Expanding
EVENT:Contracting
EVENT:Expanded
EVENT:Contracted

EQUATEs for the action parameter are declared in [Link] as follows:

CHAPTER 8 WEB CONTROL CLASS 259

Update:OnBrowser EQUATE(0)
Update:Partial EQUATE(1)
Update:Full EQUATE(2)

Example:
[Link] PROCEDURE(SIGNED Feq, *WebWindowBaseClass OwnerWindow)

CODE
[Link](Feq, OwnerWindow)
[Link] &= NEW EventActionQueue
[Link] &= NEW QueueActionQueue
[Link] = TRUE

IF ([Link]{PROP:imm})
[Link](EVENT:ScrollDown, Update:Partial)
[Link](EVENT:ScrollUp, Update:Partial)
[Link](EVENT:ScrollTop, Update:Partial)
[Link](EVENT:ScrollBottom, Update:Partial)
[Link](EVENT:ScrollDrag, Update:Partial)
[Link](EVENT:PageUp, Update:Partial)
[Link](EVENT:PageDown, Update:Partial)
[Link](EVENT:Locate, Update:Partial)
END

[Link](EVENT:NewSelection, Update:Partial)
[Link](EVENT:Initialize, Update:Partial)
[Link](EVENT:AlertKey, Update:Partial)

SeeAlso: ActionOnAccept, GetEventAction

260 IBC LIBRARY REFERENCE

SetParentDefaults (confirmparent)
SetParentDefaults( potential parent, coordinates ), VIRTUAL

SetParentDefaults Confirms this control’s boundaries fall entirely within

the potential parent boundaries.
potential parent The label of a WebControlClass object.
coordinates The label of a structure containing the coordinates of the
potential parent.
The SetParentDefaults method confirms this control’s boundaries fall
entirely within the potential parent boundaries, and if so, sets the ParentFeq
property to reflect the parent/child relationship.

The WebControlClass uses this method to establish the correct relationships

between IMAGE and REGION controls and SHEET and LIST controls in
template generated Browse procedures.

For Web page purposes, a parent/child relationship between controls is

SetParentDefaults is a VIRTUAL method so that other base class methods

can directly call the SetParentDefaults virtual method in a derived class. This
lets you easily implement your own custom version of this method.

Implementation: The coordinates parameter names a GROUP with the same structure as the
Rect GROUP declared in [Link] as follows:
Rect GROUP,TYPE
x SIGNED
y SIGNED
width SIGNED
height SIGNED
END

Example:
[Link] PROCEDURE|
(*WebControlQueue Source, *WebControlClass Other, *Rect ParentPos)

CurIndex SIGNED,AUTO
CODE
LOOP CurIndex = 1 TO RECORDS(Source)
GET(Source, CurIndex)
[Link](Other, ParentPos)
END

SeeAlso: [Link]
CHAPTER 8 WEB CONTROL CLASS 261

SetQueue(a virtual to set theFromQproperty)

SetQueue( source ), VIRTUAL

SetQueue Is a virtual placeholder method to set the value of the

FromQ property in derived classes.
source The label of the data source QUEUE.
The SetQueue method is a virtual placeholder method to set the value of the
FromQ property in derived classes. The FromQ property is a reference to the
data source for the LIST control.

SetQueue is a VIRTUAL method so that other base class methods can

directly call the SetQueue virtual method in a derived class. This lets you
easily implement your own custom version of this method.

SeeAlso: [Link], [Link]

UpdateCopyChoice(saveselecteditemnumber)
UpdateCopyChoice, PROTECTED
The UpdateCopyChoice method saves the number of the Clarion control’s
currently selected item. The WebControlClass uses this information and the
GetChoiceChanged method to minimize the data sent to the Client
browser—no JSL data is generated for unchanged controls.

This method is PROTECTED, therefore, it can only be called by a

WebControlClass method, or a method in a class derived from
WebControlClass.

Example:
[Link] PROCEDURE(*JslManagerClass Target)

CODE
IF ([Link]())
[Link]([Link], CHOICE([Link]))
[Link]
END

SeeAlso: GetChoiceChanged
262 IBC LIBRARY REFERENCE

UpdateCopyUse(savecopy of control contents)

UpdateCopyUse, PROTECTED
The UpdateCopyUse method saves a copy of the Clarion control’s contents.
The WebControlClass uses this information and the GetUseChanged method
to minimize the data sent to the Client browser—no JSL data is generated for
unchanged controls.

This method is PROTECTED, therefore, it can only be called by a

WebControlClass method, or a method in a class derived from
WebControlClass.

Example:
[Link] PROCEDURE(*JslManagerClass Target)

CODE
IF ([Link]())
[Link]([Link], CONTENTS([Link]))
[Link]
END

SeeAlso: GetUseChanged
CHAPTER 9 WEBCONTROLCLASS DERIVED CLASSES 263

WEBCONTROLCLASS DERIVED CLASSES

WebHtmlOptionClass Properties 291

BorderWidth (Web page control border width) .................................................. 291
WebHtmlOptionClass Methods 292
CreateHtml (write HTML for OPTION control) .................................................292
CreateJslData (update Web page control) ............................................................293
GetTableAttributes (return HTML STYLE)........................................................294
Init (initialize WebHtmlOptionClass object) .......................................................295
ResetControl (update server control) ...................................................................296
SetBorderWidth (set Web page control border width).........................................297
WebHtmlPromptClass Methods 298
CreateCellContents (generate HTML prompt) ................................................... 298
GetHasHotkey (control text may contain &) .......................................................299
WebHtmlRadioClass Methods 300
CreateCellContents (generate HTML radio button) ............................................300
GetHasHotkey (control text may contain &) .......................................................301
WebHtmlRegionClass Methods 302
CreateHtmlExtra (write HTML for related control) ............................................302
SetParentDefaults (confirm parent) .....................................................................303
WebHtmlSheetClass Properties 304
BorderWidth (Web page control border width) .................................................. 304
WebHtmlSheetClass Methods 305
CreateHtml (write HTML for SHEETcontrol) ....................................................305
CreateTabControl (write HTML for SHEET TABs) .............................................. 307
GetIsChild (return family identity) ......................................................................308
GetTableAttributes (return HTML STYLE)........................................................309
Init (initialize WebHtmlSheetClass object) .........................................................310
ResetControl (update server control) ...................................................................311
SetBorderWidth (set Web page control border width).........................................312
SetChildDefaults (set nested child controls) ........................................................313
WebHtmlTabClass Properties 314
IsEnabled (control enabled flag) ......................................................................... 314
WebHtmlTabClass Methods 315
CreateHtml (write HTML for control and its attributes) .....................................315
CreateJslData (update Web page control) ............................................................316
CreateParams (write all tab parameters) ............................................................. 317
GetAppletType (return applet type) .................................................................... 318
GetHasHotkey (control text may contain &) .......................................................319
CHAPTER 9 WEBCONTROLCLASS DERIVED CLASSES 265

GetIsChild (return family identity) ......................................................................320

GetPosition (get control coordinates) ................................................................. 321
GetVisible (return control status flag) .................................................................322
ResetControl (update server control) ...................................................................323
SetParentDefaults (confirm parent) .....................................................................324
WebHtmlTextClass Methods 325
CreateCellContents (generate HTML text box).................................................. 325
CreateJslData (update Web page control) ............................................................326
ResetControl (update server control) ...................................................................327
WebButtonClass Methods 328
BeforeResetControl (control preprocessing) .......................................................328
GetHasHotkey (control text may contain &) .......................................................329
GetVisible (return control status flag) .................................................................330
ResetControl (update server control) ...................................................................331
WebHtmlButtonClass Methods 332
CreateCellContents (generate HTML button) .....................................................332
Init (initialize WebButtonClass object)................................................................333
ResetControl (update server control) ...................................................................334
WebJavaButtonClass Properties 335
IsEnabled (control enabled flag) ......................................................................... 335
WebJavaButtonClass Methods 336
CreateHtml (write HTML for control and its attributes) .....................................336
CreateJslData (update Web page control) ............................................................338
CreateParams (write all button parameters).........................................................339
GetAppletType (return applet type) .................................................................... 339
GetCanDisable (return disable-ability flag) .........................................................340
GetFilename (return image filename) ..................................................................341
ResetControl (update server control) ...................................................................342
WebJavaToolButtonClass Methods 343
GetEventAction (return browser action)..............................................................343
WebImageClass 345
WebHtmlImageClass Properties 346
AltText (text to substitute for image) ...................................................................346
WebHtmlImageClass Methods 347
CreateCellContents (generate HTML image control) .........................................347
SetChildDefaults (set image/region relationship) ................................................348
SetDescription (set text to substitute for image) ................................................. 348
266 IBC LIBRARY REFERENCE

WebJavaImageClass Properties 349

Filename (image file filename) ........................................................................... 349
WebJavaImageClass Methods 350
CreateHtml (write HTML for control and its attributes) .....................................350
CreateJslData (update Web page control) ............................................................352
CreateParams (write all image parameters) ........................................................ 353
GetAppletType (return applet type) .................................................................... 354
WebListClass Methods 355
GetBackgroundColor (return background color) .................................................355
WebHtmlListClass Methods 356
CreateCellContents (generate HTML list box) ................................................... 356
CreateJslData (update Web page control) ............................................................357
ResetControl (update server control) ...................................................................358
WebJavaListClass Properties 359
AutoSpotLink (hypertext links) .......................................................................... 359
EventActionQ (browser actions for listbox events) .............................................359
Format (Web list formatting information) ...........................................................360
FromQ (LIST data source) ...................................................................................360
QueueActionQ (Server LIST queue changes) .....................................................361
Started (Java list applet started) .......................................................................... 361
WebJavaListClass Methods 362
CreateHtml (write HTML for LIST control) ...................................................... 362
CreateJslData (update Web page control) ............................................................364
CreateParams (write all list parameters) ............................................................. 365
GetAppletType (return applet type) .................................................................... 366
GetEventAction (return browser action)..............................................................367
Init (initialize the WebJavaListClass object) ...................................................... 368
Kill (shut down the WebJavaListClass object) ....................................................369
ResetControl (update server control) ...................................................................370
ResetFromQueue (record changes to Server LIST queue) ................................. 371
SetAutoSpotLink (set live hypertext links) ..........................................................372
SetDirty (force refresh of Web page list box) ......................................................372
SetEventActin (associate browser action with control event) ............................ 373
SetQueue (set the data source queue) ..................................................................375
UpdateState (force refresh of Web page list box) ............................................... 376
WebStringClass Methods 377
SetBreakable (allow word wrap) .........................................................................377
CHAPTER 9 WEBCONTROLCLASS DERIVED CLASSES 267

WebHtmlStringClass Methods 378

CreateCellContents (generate HTML text string) .............................................. 378
GetCellAttributes (return control attributes)........................................................379
WebJavaStringClass Properties 380
AutoSpotLink (hypertext links) .......................................................................... 380
LastText (last transmitted value) ..........................................................................380
WebJavaStringClass Methods 381
CreateHtml (write HTML for control and its attributes) .....................................381
CreateJslData (update Web page control) ............................................................382
CreateParams (write all string parameters) ......................................................... 383
GetAppletType (return applet type) .................................................................... 384
Init (initialize WebJavaStringClass object)..........................................................385
SetAutoSpotLink (set live hypertext links) ..........................................................386
WebCloseButtonClass Properties 387
Height (button height) ..........................................................................................387
Width (button width) ............................................................................................387
X (button horizontal position)............................................................................. 387
Y (button vertical position) ..................................................................................387
WebCloseButtonClass Methods 388
CreateHtml (write HTML for control and its attributes) .....................................388
CreateJslData (update Web page control) ............................................................390
CreateParams (write all string parameters) ......................................................... 391
GetAppletType (return applet type) .................................................................... 392
GetCloneFeq (return button to mimic) ............................................................... 393
GetPosition (get control coordinates) ................................................................. 394
GetVisible (return control status flag) .................................................................395
Init (initialize WebCloseButtonClass object) ......................................................396
ResetControl (apply Web page button action) .....................................................397
WebHotlinkClass Methods 398
CreateCellContents (generate HTML hypertext link) .........................................398
WebLiteralClass Properties 399
Text (Web page text) ............................................................................................399
WebLiteralClass Methods 400
CreateHtml (write HTML for control)................................................................ 400
GetCellAttributes (return control attributes)........................................................401
268 IBC LIBRARY REFERENCE

WebNullControlClass Methods 402

CreateHtml (write HTML for control)................................................................ 402
CreateJslData (update Web page control) ............................................................402
GetAppletType (return applet type) .................................................................... 403
GetCellAttributes (return control attributes)........................................................404
GetIsChild (return family identity) ......................................................................405
GetVisible (return control status flag) .................................................................406
CHAPTER 9 WEBCONTROLCLASS DERIVED CLASSES 269

WebControlClassConcepts

The WebControlClass analyzes a single Clarion control and generates the

HTML code to duplicate the Clarion control on a Web page. It manages all
the control attributes and behaviors that are common to all the Clarion
controls.

ClassesDerivedfromWebControlClass

Each type of Clarion control has unique HTML code requirements. For
example, the HTML code generated for a CHECK is different than for an
ENTRY. Therefore, each type of Clarion control has a corresponding class
derived from the WebControlClass to implement its type-specific behavior.
For example, the WebHtmlPromptClass represents a PROMPT control, and
the WebHtmlEntryClass represents an ENTRY control, etc. These derived
classes are documented in this chapter.

Relationship toOther Internet Builder Classes

All the classes described in this chapter are derived from the
WebControlClass; therefore, the information and documentation pertaining
to the WebControlClass is directly applicable to these derived classes. Please
see Web Control Class for more information.

Internet ConnectTemplate Implementation

SourceFiles

The source code for the classes in this chapter is installed by default to the
\LIBSRC folder. The class declarations are in the following .INC files and
their respective method definitions are in the corresponding .CLW files.

[Link] WebButtonClass
WebCloseButtonClass
WebHotlinkClass
WebHtmlButtonClass
WebHtmlCheckClass
WebHtmlEntryClass
WebHtmlGroupClass
WebHtmlImageClass
WebHtmlItemClass
WebHtmlListClass
WebHtmlMenuClass
WebHtmlOptionClass
WebHtmlPromptClass
WebHtmlRadioClass
WebHtmlRegionClass
WebHtmlSheetClass
WebHtmlStringClass
WebHtmlTabClass
WebHtmlTextClass
WebImageClass
WebJavaButtonClass
WebJavaImageClass
WebJavaListClass
WebJavaStringClass
WebJavaToolButtonClass
WebListClass
WebLiteralClass
WebNullControlClass
WebStringClass
CHAPTER 9 WEBHTMLCHECKCLASS 271

WebHtmlCheckClass Methods
The WebHtmlCheckClass inherits all the methods of the WebControlClass
from which it is derived.

In addition to (or instead of) the inherited methods, the WebHtmlCheckClass

contains the methods listed below.

BeforeResetControl (control preprocessing)

BeforeResetControl, VIRTUAL
The BeforeResetControl method does any control specific processing prior
to synchronizing the WINDOW control with its corresponding Web page
control.

BeforeResetControl is a VIRTUAL method so that other base class methods

can directly call the BeforeResetControl virtual method in a derived class.
This lets you easily implement your own custom version of this method.

Implementation: The BeforeResetControl method clears the CHECK control. This is needed
because the Client browser never sends information regarding a cleared
check box—no information means the box is not checked—and always sends
information regarding a checked box.

The [Link] method calls BeforeResetControl.

Example:
[Link] PROCEDURE
NextSubmit &SubmitItemClass
Curfeq SIGNED,AUTO
Index SIGNED,AUTO
CODE
IF ([Link]())
LOOP Index = 1 TO RECORDS([Link]) !preprocess all controls
GET([Link], Index)
[Link]() !preprocess a control
END
END
LOOP !synchronize all controls
NextSubmit &= [Link]() !set next submit item
IF (NextSubmit &= NULL) THEN BREAK. !stop when finished
CurFeq = [Link]
IF ([Link](CurFeq)) !set corresponding control
IF ([Link]) !confirm event exists
IF (NOT CurFeq{PROP:disable}) AND (NOT CurFeq{PROP:readonly})
[Link](NextSubmit)!synchronize the control
. . . .

SeeAlso: [Link]
272 C L A R I O N  IBC LIBRARY REFERENCE

CreateCellContents (generate HTMLcheck box)

CreateCellContents( html object ), VIRTUAL

CreateCellContents
Generates HTML code to represent a check box.
html object The label of the HtmlClass object that writes the HTML
code.
The CreateCellContents method generates HTML code to represent a
check box.

CreateCellContents is a VIRTUAL method so that other base class methods

can directly call the CreateCellContents virtual method in a derived class.
This lets you easily implement your own custom version of this method.

Implementation: The [Link] method calls the CreateCellContents

method.

The proper positioning of each Web page control is accomplished by using

HTML TABLEs and CELLs. CreateCellContents writes only the HTML
code representing the control. The HTML code defining the TABLE and the
CELL containing the control is written by other methods including
[Link], [Link], and
[Link].

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE
[Link](Target) !write HTML TABLE CELL header
[Link](Target) !write HTML representing the control
[Link](Target) !write HTML TABLE CELL footer

SeeAlso: [Link], [Link],

[Link], [Link]
CHAPTER 9 WEBHTMLCHECKCLASS 273

CreateJslData (updateWebpage control)

CreateJslData( Jsl manager ), VIRTUAL

CreateJslData Writes Java Support Library (JSL) data to synchronize

the Web page control with its corresponding WINDOW
control.
Jsl manager The label of the JSLManagerClass object that sends data
to Java applets on the Web page.
The CreateJslData method writes Java Support Library (JSL) data to
synchronize the Web page control with its corresponding WINDOW control.

CreateJslData is a VIRTUAL method so that other base class methods can

directly call the CreateJslData virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The [Link] method calls the CreateJslData method.

Example:
[Link] PROCEDURE(*JslManagerClass Target)

Index SIGNED,AUTO
CODE
LOOP Index = 1 TO RECORDS([Link]) !write data for all controls
GET([Link], Index) !get next control
IF ([Link]()) !if control is “visible”
[Link](Target) !write its Jsl data
END
END

SeeAlso: [Link]
274 C L A R I O N  IBC LIBRARY REFERENCE

GetHasHotkey (control textmay contain&)

GetHasHotKey is a VIRTUAL method so that other base class methods can

directly call the GetHasHotKey virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: The [Link] method calls the GetHasHotKey method to

identify controls that may have Clarion hot key delimiters (&).

Return DataType: BYTE

Example:
[Link] FUNCTION

CODE
IF ([Link]()) !check for hot key
RETURN IC:StripHotkey(CLIP([Link]{PROP:ScreenText}))!return text sans delimiter
END
RETURN CLIP([Link]{PROP:ScreenText}) !return text

SeeAlso: [Link]
CHAPTER 9 WEBHTMLCHECKCLASS 275

ResetControl (update server control)

ResetControl( submit item ), VIRTUAL

ResetControl Synchronizes the Server CHECK control with its

corresponding Web page check box.
submit item The label of the SubmitItem object containing the
information submitted by the Client browser for this
control.
The ResetControl method synchronizes the Server CHECK control with its
corresponding Web page check box. The ResetControl method takes Web
page control information submitted by the Client browser, such as control
contents and events, and applies it to the corresponding Server control.

ResetControl is a VIRTUAL method so that other base class methods can

directly call the ResetControl virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The [Link] method calls the ResetControl method.

SeeAlso: [Link]
276 C L A R I O N  IBC LIBRARY REFERENCE

WebHtmlEntryClass Methods
The WebHtmlEntryClass inherits all the methods of the WebControlClass
from which it is derived.

In addition to (or instead of) the inherited methods, the WebHtmlEntryClass

contains the methods listed below.

CreateCellContents (generate HTML entry box)

CreateCellContents( html object ), VIRTUAL

CreateCellContents
Generates HTML code to represent an entry box.
html object The label of the HtmlClass object that writes the HTML
code.
The CreateCellContents method generates HTML code to represent an
entry box.

CreateCellContents is a VIRTUAL method so that other base class methods

can directly call the CreateCellContents virtual method in a derived class.
This lets you easily implement your own custom version of this method.

Implementation: The [Link] method calls the CreateCellContents

method.

The proper positioning of each Web page control is accomplished by using

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE
[Link](Target) !write HTML TABLE CELL header
[Link](Target) !write HTML representing the control
[Link](Target) !write HTML TABLE CELL footer

SeeAlso: [Link], [Link],

[Link], [Link]
CHAPTER 9 WEBHTMLENTRYCLASS 277

CreateJslData (updateWebpage control)

CreateJslData( Jsl manager ), VIRTUAL

CreateJslData Writes Java Support Library (JSL) data to synchronize

CreateJslData is a VIRTUAL method so that other base class methods can

directly call the CreateJslData virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The [Link] method calls the CreateJslData method.

Example:
[Link] PROCEDURE(*JslManagerClass Target)

SeeAlso: [Link]
278 C L A R I O N  IBC LIBRARY REFERENCE

ResetControl (update server control)

ResetControl( submit item ), VIRTUAL

ResetControl Synchronizes the Server ENTRY control with its corre-

sponding Web page entry box.
submit item The label of the SubmitItem object containing the
information submitted by the Client browser for this
control.
The ResetControl method synchronizes the Server ENTRY control with its
corresponding Web page entry box. The ResetControl method takes Web
page control information submitted by the Client browser, such as control
contents and events, and applies it to the corresponding Server control.

ResetControl is a VIRTUAL method so that other base class methods can

directly call the ResetControl virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The [Link] method calls the ResetControl method.

SeeAlso: [Link]
CHAPTER 9 WEBHTMLGROUPCLASS 279

WebHtmlGroupClass Proper ties

The WebHtmlGroupClass inherits all the properties of the WebControlClass
from which it is derived.

In addition to (or instead of) the inherited properties, the

WebHtmlGroupClass contains the properties listed below.

BorderWidth (Webpage control border width)

BorderWidth BYTE
The BorderWidth property contains the control’s border width as it appears
on the Web page. A value of zero (0) indicates no border. Larger numbers
produce wider borders.

The BorderWidth property is only effective for GROUP controls with the
BOXED attribute.

Implementation: The Init method sets the initial value of the BorderWidth property equal to
the [Link] property. The SetBorderWidth
method sets subsequent values of the BorderWidth property.

SeeAlso: Init, SetBorderWidth

280 C L A R I O N  IBC LIBRARY REFERENCE

WebHtmlGroupClass Methods
The WebHtmlGroupClass inherits all the methods of the WebControlClass
from which it is derived.

In addition to (or instead of) the inherited methods, the WebHtmlGroupClass

contains the methods listed below.

CreateHtml (write HTMLfor GROUPcontrol)

CreateHtml( html object ), VIRTUAL

CreateHtml Writes the HTML code representing the GROUP control

and its child controls.
html object The label of the HtmlClass object that writes the HTML
code.
The CreateHtml method writes the HTML code representing the GROUP
control and its child controls.

CreateHtml is a VIRTUAL method so that other base class methods can

directly call the CreateHtml virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The CreateHtml method calls the [Link]

method to generate HTML representing the GROUP’s child controls. This
ensures that the GROUP’s children are correctly positioned on the Web page
and that they inherit properties of the parent GROUP, such as fonts or colors.

SeeAlso: [Link]
CHAPTER 9 WEBHTMLGROUPCLASS 281

GetHasHotkey (control textmay contain&)

GetHasHotKey is a VIRTUAL method so that other base class methods can

directly call the GetHasHotKey virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: The [Link] method calls the GetHasHotKey method to

identify controls that may have Clarion hot key delimiters (&).

Return DataType: BYTE

Example:
[Link] FUNCTION

CODE
IF ([Link]()) !check for hot key
RETURN IC:StripHotkey(CLIP([Link]{PROP:ScreenText}))!return text sans delimiter
END
RETURN CLIP([Link]{PROP:ScreenText}) !return text

SeeAlso: [Link]
282 C L A R I O N  IBC LIBRARY REFERENCE

Init (initializeWebHtmlGroupClassobject)
Init( control number, owner window ), VIRTUAL

Init Initializes the WebHtmlGroupClass object.

Init is a VIRTUAL method so that other base class methods can directly call
the Init virtual method in a derived class. This lets you easily implement your
own custom version of this method.

Implementation: The Init method calls the [Link] method, and sets the initial
value of the BorderWidth property equal to the
[Link] property.

The [Link] method calls the Init method.

Example:
[Link] PROCEDURE(SIGNED Feq, *WebControlClass NewControl)

CODE
ASSERT(~NewControl &= NULL)
[Link](Feq, SELF)
[Link](NewControl)

SeeAlso: BorderWidth, [Link], [Link]

CHAPTER 9 WEBHTMLGROUPCLASS 283

SetBorderWidth (setWebpagecontrol border width)

SetBorderWidth( width ), VIRTUAL

SetBorderWidth Sets the border width of the control.

width An integer constant, variable, EQUATE or expression
assigned to the BorderWidth property.
The SetBorderWidth method sets the border width of the control as it
appears on the Web page. The SetBorderWidth method is only effective for
GROUP controls with the BOXED attribute.

SetBorderWidth is a VIRTUAL method so that other base class methods can

directly call the SetBorderWidth virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: The SetBorderWidth method sets the BorderWidth property.

SeeAlso: BorderWidth
284 C L A R I O N  IBC LIBRARY REFERENCE

WebHtmlItemClass Methods
The WebHtmlItemClass inherits all the methods of the WebControlClass
from which it is derived.

In addition to (or instead of) the inherited methods, the WebHtmlItemClass

contains the methods listed below.

CreateCellContents (generate HTMLmenu item)

CreateCellContents( html object ), VIRTUAL

CreateCellContents
Generates HTML code to represent a menu item.
html object The label of the HtmlClass object that writes the HTML
code.
The CreateCellContents method generates HTML code to represent a menu
item.

CreateCellContents is a VIRTUAL method so that other base class methods

can directly call the CreateCellContents virtual method in a derived class.
This lets you easily implement your own custom version of this method.

Implementation: The [Link] method calls the CreateCellContents

method.

The proper positioning of each Web page control is accomplished by using

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE
[Link](Target) !write HTML TABLE CELL header
[Link](Target) !write HTML representing the control
[Link](Target) !write HTML TABLE CELL footer

SeeAlso: [Link], [Link],

[Link], [Link]
CHAPTER 9 WEBHTMLITEMCLASS 285

GetVisible (return control statusflag)

GetVisible, BYTE, VIRTUAL
The GetVisible method returns a value indicating whether the menu item
should appear on the Web page. A return value of one (1) indicates the item
should appear on the Web page; a return value of zero (0) indicates the item
should not appear.

GetVisible is a VIRTUAL method so that other base class methods can

directly call the GetVisible virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: A menu item may be omitted from the Web page because it is disabled or
hidden, or its parent is disabled or hidden.

Return DataType: BYTE

Example:
[Link] PROCEDURE |
(*WebControlQueue Source, *LayoutHtmlClass Layout)

CurIndex SIGNED,AUTO

CODE
LOOP CurIndex = 1 TO RECORDS(Source)
GET(Source, CurIndex)
IF ([Link]())
[Link]([Link])
END
END
286 C L A R I O N  IBC LIBRARY REFERENCE

ResetControl (update server control)

ResetControl( submit item ), VIRTUAL

ResetControl Synchronizes the Server ITEM control with its corre-

sponding Web page menu item.
submit item The label of the SubmitItem object containing the
information submitted by the Client browser for this
control.
The ResetControl method synchronizes the Server ITEM control with its
corresponding Web page menu item. The ResetControl method takes Web
page control information submitted by the Client browser, such as an
accepted event, and applies it to the corresponding Server control.

ResetControl is a VIRTUAL method so that other base class methods can

directly call the ResetControl virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The [Link] method calls the ResetControl method.

SeeAlso: [Link]
CHAPTER 9 WEBHTMLMENUCLASS 287

WebHtmlMenuClass Methods
The WebHtmlMenuClass inherits all the methods of the WebControlClass
from which it is derived.

In addition to (or instead of) the inherited methods, the WebHtmlMenuClass

contains the methods listed below.

CreateCellContents (generate HTMLmenu)

CreateCellContents( html object ), VIRTUAL

CreateCellContents
Generates HTML code to represent a menu.
html object The label of the HtmlClass object that writes the HTML
code.
The CreateCellContents method generates HTML code to represent a
menu.

CreateCellContents is a VIRTUAL method so that other base class methods

can directly call the CreateCellContents virtual method in a derived class.
This lets you easily implement your own custom version of this method.

Implementation: The [Link] method calls the CreateCellContents

method.

The proper positioning of each Web page control is accomplished by using

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE
[Link](Target) !write HTML TABLE CELL header
[Link](Target) !write HTML representing the control
[Link](Target) !write HTML TABLE CELL footer

SeeAlso: [Link], [Link],

[Link], [Link]
288 C L A R I O N  IBC LIBRARY REFERENCE

CreateHtml (write HTMLfor MENUcontrol)

CreateHtml( html object ), VIRTUAL

CreateHtml Writes the HTML code representing the MENU control

and its child controls.
html object The label of the HtmlClass object that writes the HTML
code.
The CreateHtml method writes the HTML code representing the MENU
control and its child controls.

CreateHtml is a VIRTUAL method so that other base class methods can

directly call the CreateHtml virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The CreateHtml method calls the [Link]

method to generate HTML representing the MENU’s child controls. This
ensures that the MENU’s children are correctly positioned on the Web page
and that they inherit properties of the parent MENU, such as fonts or colors.

The [Link] method calls the CreateHtml method.

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE
[Link](Target)
[Link](Target, [Link])

SeeAlso: [Link]
CHAPTER 9 WEBHTMLMENUCLASS 289

GetCellAttributes(return control attributes)

GetCellAttributes( html object ), STRING, VIRTUAL

GetCellAttributes Returns attributes associated with the Web page menu

control.
html object The label of the HtmlClass object that writes the HTML
code.
The GetCellAttributes method returns attributes associated with the Web
page menu control.

GetCellAttributes is a VIRTUAL method so that other base class methods

can directly call the GetCellAttributes virtual method in a derived class. This
lets you easily implement your own custom version of this method.

Implementation: The GetCellAttributes method returns the font typeface, size, color, and style
of the HTML TABLE CELL containing the control, plus nowrap and
alignment specifications.

The [Link] method calls the GetCellAttributes

method.

Return DataType: STRING

Example:
[Link] PROCEDURE(*HtmlClass Target)

CurCell &LayoutCellClass,AUTO
Index SIGNED,AUTO
NumRows SIGNED,AUTO
Xindex SIGNED,AUTO
Yindex SIGNED,AUTO

SeeAlso: [Link]
290 C L A R I O N  IBC LIBRARY REFERENCE

GetVisible (return control statusflag)

GetVisible, BYTE, VIRTUAL
The GetVisible method returns a value indicating whether the menu should
appear on the Web page. A return value of one (1) indicates the menu should
appear on the Web page; a return value of zero (0) indicates the menu should
not appear.

GetVisible is a VIRTUAL method so that other base class methods can

directly call the GetVisible virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: A menu may be omitted from the Web page because it has no children, or
because it is explicitly omitted from the Web page based on the
[Link] property.

Return DataType: BYTE

Example:
[Link] PROCEDURE |
(*WebControlQueue Source, *LayoutHtmlClass Layout)

CurIndex SIGNED,AUTO

CODE
LOOP CurIndex = 1 TO RECORDS(Source)
GET(Source, CurIndex)
IF ([Link]())
[Link]([Link])
END
END

SeeAlso: [Link]
CHAPTER 9 WEBHTMLOPTIONCLASS 291

WebHtmlOptionClass Proper ties

The WebHtmlOptionClass inherits all the properties of the WebControlClass
from which it is derived.

In addition to (or instead of) the inherited properties, the

WebHtmlOptionClass contains the properties listed below.

BorderWidth (Webpage control border width)

BorderWidth BYTE
The BorderWidth property contains the control’s border width as it appears
on the Web page. A value of zero (0) indicates no border. Larger numbers
produce wider borders.

The BorderWidth property is only effective for OPTION controls with the
BOXED attribute.

Implementation: The Init method sets the initial value of the BorderWidth property equal to
the [Link] property. The SetBorderWidth
method sets subsequent values of the BorderWidth property.

SeeAlso: Init, SetBorderWidth

292 C L A R I O N  IBC LIBRARY REFERENCE

WebHtmlOptionClass Methods
The WebHtmlOptionClass inherits all the methods of the WebControlClass
from which it is derived.

In addition to (or instead of) the inherited methods, the

WebHtmlOptionClass contains the methods listed below.

CreateHtml (write HTMLfor OPTIONcontrol)

CreateHtml( html object ), VIRTUAL

CreateHtml Writes the HTML code representing the OPTION

control and its child controls.
html object The label of the HtmlClass object that writes the HTML
code.
The CreateHtml method writes the HTML code representing the OPTION
control and its child controls.

CreateHtml is a VIRTUAL method so that other base class methods can

directly call the CreateHtml virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The CreateHtml method calls the [Link]

method to generate HTML representing the OPTION’s child controls. This
ensures that the OPTION’s children are correctly positioned on the Web page
and that they inherit properties of the parent OPTION, such as fonts or
colors.

The [Link] method calls the CreateHtml method.

SeeAlso: [Link]
CHAPTER 9 WEBHTMLOPTIONCLASS 293

CreateJslData (updateWebpage control)

CreateJslData( Jsl manager ), VIRTUAL

CreateJslData Writes Java Support Library (JSL) data to synchronize

CreateJslData is a VIRTUAL method so that other base class methods can

directly call the CreateJslData virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The [Link] method calls the CreateJslData method.

Example:
[Link] PROCEDURE(*JslManagerClass Target)

SeeAlso: [Link]
294 C L A R I O N  IBC LIBRARY REFERENCE

GetTableAttributes (return HTML STYLE)

GetTableAttributes, STRING, VIRTUAL
The GetTableAttributes method returns the HTML <STYLE> string for the
HTML <TABLE> representing the OPTION control.

GetTableAttributes is a VIRTUAL method so that other base class methods

can directly call the GetTableAttributes virtual method in a derived class.
This lets you easily implement your own custom version of this method.

Implementation: The <STYLE> returned by GetTableAttributes includes only the <TABLE>

<BORDER>.

Return DataType: STRING

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE
[Link](Target, [Link], [Link]())
[Link]
CHAPTER 9 WEBHTMLOPTIONCLASS 295

Init (initializeWebHtmlOptionClassobject)
Init( control number, owner window ), VIRTUAL

Init Initializes the WebHtmlOptionClass object.

Init is a VIRTUAL method so that other base class methods can directly call
the Init virtual method in a derived class. This lets you easily implement your
own custom version of this method.

Implementation: The Init method calls the [Link] method, and sets the initial
value of the BorderWidth property equal to the
[Link] property.

The [Link] method calls the Init method.

Example:
[Link] PROCEDURE(SIGNED Feq, *WebControlClass NewControl)

CODE
ASSERT(~NewControl &= NULL)
[Link](Feq, SELF)
[Link](NewControl)

SeeAlso: BorderWidth, [Link], [Link]

296 C L A R I O N  IBC LIBRARY REFERENCE

ResetControl (update server control)

ResetControl( submit item ), VIRTUAL

ResetControl Synchronizes the Server OPTION control with the

corresponding Web page option/radio buttons.
submit item The label of the SubmitItem object containing the
information submitted by the Client browser for this
control.
The ResetControl method synchronizes the Server OPTION control with its
corresponding Web page option/radio buttons. The ResetControl method
takes Web page control information submitted by the Client browser, such as
selected item and events, and applies it to the corresponding Server control.

ResetControl is a VIRTUAL method so that other base class methods can

directly call the ResetControl virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The [Link] method calls the ResetControl method.

SeeAlso: [Link]
CHAPTER 9 WEBHTMLOPTIONCLASS 297

SetBorderWidth (setWebpagecontrol border width)

SetBorderWidth( width ), VIRTUAL

SetBorderWidth Sets the border width of the control.

SetBorderWidth is a VIRTUAL method so that other base class methods can

directly call the SetBorderWidth virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: The SetBorderWidth method sets the BorderWidth property.

SeeAlso: BorderWidth
298 C L A R I O N  IBC LIBRARY REFERENCE

WebHtmlPromptClass Methods
The WebHtmlPromptClass inherits all the methods of the WebControlClass
from which it is derived.

In addition to (or instead of) the inherited methods, the

WebHtmlPromptClass contains the methods listed below.

CreateCellContents (generate HTMLprompt)

CreateCellContents( html object ), VIRTUAL

CreateCellContents
Generates HTML code to represent a prompt.
html object The label of the HtmlClass object that writes the HTML
code.
The CreateCellContents method generates HTML code to represent a
prompt.

CreateCellContents is a VIRTUAL method so that other base class methods

can directly call the CreateCellContents virtual method in a derived class.
This lets you easily implement your own custom version of this method.

Implementation: A prompt is simply text on the Web page. The [Link]

method calls the CreateCellContents method.

The proper positioning of each Web page control is accomplished by using

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE
[Link](Target) !write HTML TABLE CELL header
[Link](Target) !write HTML representing the control
[Link](Target) !write HTML TABLE CELL footer

SeeAlso: [Link], [Link],

[Link], [Link]
CHAPTER 9 WEBHTMLPROMPTCLASS 299

GetHasHotkey (control textmay contain&)

GetHasHotKey is a VIRTUAL method so that other base class methods can

directly call the GetHasHotKey virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: The [Link] method calls the GetHasHotKey method to

identify controls that may have Clarion hot key delimiters (&).

Return DataType: BYTE

Example:
[Link] FUNCTION

CODE
IF ([Link]()) !check for hot key
RETURN IC:StripHotkey(CLIP([Link]{PROP:ScreenText}))!return text sans delimiter
END
RETURN CLIP([Link]{PROP:ScreenText}) !return text

SeeAlso: [Link]
300 C L A R I O N  IBC LIBRARY REFERENCE

WebHtmlRadioClass Methods
The WebHtmlRadioClass inherits all the methods of the WebControlClass
from which it is derived.

In addition to (or instead of) the inherited methods, the WebHtmlRadioClass

contains the methods listed below.

CreateCellContents (generate HTMLradio button)

CreateCellContents( html object ), VIRTUAL

CreateCellContents
Generates HTML code to represent a radio button.
html object The label of the HtmlClass object that writes the HTML
code.
The CreateCellContents method generates HTML code to represent a radio
button.

CreateCellContents is a VIRTUAL method so that other base class methods

can directly call the CreateCellContents virtual method in a derived class.
This lets you easily implement your own custom version of this method.

Implementation: The [Link] method calls the CreateCellContents

method.

The proper positioning of each Web page control is accomplished by using

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE
[Link](Target) !write HTML TABLE CELL header
[Link](Target) !write HTML representing the control
[Link](Target) !write HTML TABLE CELL footer

SeeAlso: [Link], [Link],

[Link], [Link]
CHAPTER 9 WEBHTMLRADIOCLASS 301

GetHasHotkey (control textmay contain&)

GetHasHotKey is a VIRTUAL method so that other base class methods can

directly call the GetHasHotKey virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: The [Link] method calls the GetHasHotKey method to

identify controls that may have Clarion hot key delimiters (&).

Return DataType: BYTE

Example:
[Link] FUNCTION

CODE
IF ([Link]()) !check for hot key
RETURN IC:StripHotkey(CLIP([Link]{PROP:ScreenText}))!return text sans delimiter
END
RETURN CLIP([Link]{PROP:ScreenText}) !return text

SeeAlso: [Link]
302 C L A R I O N  IBC LIBRARY REFERENCE

WebHtmlRegionClass Methods
The WebHtmlRegionClass inherits all the methods of the WebControlClass
from which it is derived.

In addition to (or instead of) the inherited methods, the

WebHtmlRegionClass contains the methods listed below.

CreateHtmlExtra (write HTMLfor relatedcontrol)

CreateHtmlExtra( html object ), VIRTUAL

CreateHtmlExtra Writes HTML code for a related control.

html object The label of the HtmlClass object that writes the HTML.
The CreateHtmlExtra method writes HTML code to complete the
representation of a related control. For example, a WebHtmlImageClass
object that is the parent of one or more WebHtmlRegionClass objects may
call the [Link] method to complete the
HTML representation of the IMAGE control.

CreateHtmlExtra is a VIRTUAL method so that other base class methods can

directly call the CreateHtmlExtra virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Example:
[Link] PROCEDURE(*HtmlClass Target)
Children WebControlQueue
Filename CSTRING(FILE:MaxFileName)
Id UNSIGNED,AUTO
ImagePos LIKE(Rect)
CODE
Filename = [Link]([Link]{PROP:tempimage})
Id = IC:Feq2Id([Link])
IF (Filename)
[Link](Children, [Link])
IF RECORDS(Children)
[Link]('<<MAP NAME="MAP' & Id & '">')
[Link](Children, Target)
[Link]('<</MAP>')
END
[Link]('<<IMG SRC="' & Filename & '"')
IF (RECORDS(Children))
[Link](' USEMAP="#MAP' & Id & '"')
END
GetPosition([Link],,,[Link],[Link])
[Link](' WIDTH=' & [Link]([Link]))
[Link](' HEIGHT=' & [Link]([Link]))
[Link]('>')
END

SeeAlso: [Link]
CHAPTER 9 WEBHTMLREGIONCLASS 303

SetParentDefaults (confirmparent)
SetParentDefaults( potential parent, coordinates ), VIRTUAL

SetParentDefaults Confirms this control’s boundaries fall entirely within

the potential parent boundaries.
potential parent The label of a WebControlClass object.
coordinates The label of a structure containing the coordinates of the
potential parent.
The SetParentDefaults method confirms this REGION control’s boundaries
fall entirely within the potential parent boundaries, typically an IMAGE. If
they do, it sets the ParentFeq property to reflect the parent/child relationship.

The WebControlClass uses this method to establish the correct relationships

between IMAGE and REGION controls and SHEET and LIST controls in
template generated Browse procedures.

For Web page purposes, a parent/child relationship between controls is

defined by the controls’ positional coordinates. A control whose boundaries
fall entirely within the boundaries of another control is the child of the
surrounding control (if there is no intervening surrounding control). This
position based relationship allows for correct positioning, alignment and
processing of Web page controls.

SetParentDefaults is a VIRTUAL method so that other base class methods

can directly call the SetParentDefaults virtual method in a derived class. This
lets you easily implement your own custom version of this method.

Implementation: The coordinates parameter names a GROUP with the same structure as the
Rect GROUP declared in [Link] as follows:
Rect GROUP,TYPE
x SIGNED
y SIGNED
width SIGNED
height SIGNED
END

Example:
[Link] PROCEDURE|
(*WebControlQueue Source, *WebControlClass Other, *Rect ParentPos)

CurIndex SIGNED,AUTO

CODE
LOOP CurIndex = 1 TO RECORDS(Source)
GET(Source, CurIndex)
[Link](Other, ParentPos)
END

SeeAlso: [Link]
304 C L A R I O N  IBC LIBRARY REFERENCE

WebHtmlSheetClass Proper ties

The WebHtmlSheetClass inherits all the properties of the WebControlClass
from which it is derived.

In addition to (or instead of) the inherited properties, the

WebHtmlSheetClass contains the properties listed below.

BorderWidth (Webpage control border width)

BorderWidth BYTE
The BorderWidth property contains the control’s border width as it appears
on the Web page. A value of zero (0) indicates no border. Larger numbers
produce wider borders.

Implementation: The Init method sets the initial value of the BorderWidth property equal to
the [Link] property. The SetBorderWidth
method sets subsequent values of the BorderWidth property.

SeeAlso: Init, SetBorderWidth

CHAPTER 9 WEBHTMLSHEETCLASS 305

WebHtmlSheetClass Methods
The WebHtmlSheetClass inherits all the methods of the WebControlClass
from which it is derived.

In addition to (or instead of) the inherited methods, the WebHtmlSheetClass

contains the methods listed below.

CreateHtml (write HTML for SHEETcontrol)

CreateHtml( html object ), VIRTUAL

CreateHtml Writes the HTML code representing the SHEET control

and its child controls.
html object The label of the HtmlClass object that writes the HTML
code.
The CreateHtml method writes the HTML code representing the SHEET
control and its child controls.

CreateHtml is a VIRTUAL method so that other base class methods can

directly call the CreateHtml virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The CreateHtml method calls the CreateTabControl method to generate

HTML representing the SHEET’s child controls. This ensures that the
SHEET’s children are correctly positioned on the Web page and that they
inherit properties of the parent SHEET, such as fonts or colors.

The [Link] method calls the CreateHtml method.

306 C L A R I O N  IBC LIBRARY REFERENCE

SeeAlso: [Link], CreateTabControl

CHAPTER 9 WEBHTMLSHEETCLASS 307

CreateTabControl (write HTMLfor SHEETTABs)

CreateTabControl( tabs, html object, position , selected tab )

CreateTabControl
Writes the HTML for the SHEET control’s TABs.
tabs The label of the structure containing information about
the SHEET control’s TAB controls.
html object The label of the HtmlClass object that writes the HTML
code.
position An integer constant, variable, EQUATE, or expression
indicating the tabs’ position relative to the SHEET
control. Valid positions are above, left, right, and below.
selected tab An integer constant, variable, EQUATE, or expression
containing the control number (field equate) of the
selected tab.
The CreateTabControl method writes the HTML for the SHEET control’s
TAB controls.

Implementation: The CreateTabControl method writes JavaScript to define the SHEET’s

TABs as a group of Java applets within a Java container applet.

The tabs parameter names a QUEUE with the same structure as the
WebControlQueue declared in [Link] as follows:
WebControlQueue QUEUE,TYPE
Feq SIGNED
ThisControl &WebControlClass
END

EQUATEs for the position parameter are declared in [Link]:

PROP:left EQUATE(7C08H) ! 0 = off, else on
PROP:right EQUATE(7C0CH) ! 0 = off, else on
PROP:above EQUATE(7C0AH) ! 0 = off, else on
PROP:below EQUATE(7C06H) ! 0 = off, else on

Example:
[Link] PROCEDURE(*HtmlClass Target)
Alignment SIGNED(PROP:above)
Children WebControlQueue
CurTabFeq SIGNED,AUTO
TabControls WebControlQueue
CODE
[Link](TabControls, [Link], CREATE:Tab)
CurTabFeq = [Link]{PROP:choicefeq}
[Link]('<<TABLE' & [Link]() & '><<TR>')
[Link]('<<TD>')
[Link](TabControls, Target, Alignment, CurTabFeq)
[Link]('<</TD><</TR><<TR>')
!procedure code
308 C L A R I O N  IBC LIBRARY REFERENCE

GetIsChild (return family identity)

GetIsChild( parent control [,control type] ), SIGNED, VIRTUAL

GetIsChild Returns a value indicating whether this WebControlClass

GetIsChild is a VIRTUAL method so that other base class methods can

directly call the GetIsChild virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The [Link] method calls the GetIsChild method to

find first child controls.

EQUATEs for the control type parameter are declared in [Link].

Each control type EQUATE is prefixed with CREATE:.

Return DataType: SIGNED

SeeAlso: Feq, [Link]

CHAPTER 9 WEBHTMLSHEETCLASS 309

GetTableAttributes (return HTML STYLE)

GetTableAttributes, STRING, VIRTUAL
The GetTableAttributes method returns the HTML <STYLE> string for the
HTML <TABLE> representing the SHEET control.

GetTableAttributes is a VIRTUAL method so that other base class methods

can directly call the GetTableAttributes virtual method in a derived class.
This lets you easily implement your own custom version of this method.

Implementation: The <STYLE> returned by GetTableAttributes includes only the <TABLE>

<BORDER>.

Return DataType: STRING

Init (initializeWebHtmlSheetClassobject)
Init( control number, owner window object ), VIRTUAL

Init Initializes the WebHtmlSheetClass object.

control number An integer constant, variable, EQUATE, or expression
containing the control number (field equate).
owner window object
The label of the WebWindowClass object the control
belongs to.
The Init method initializes the WebHtmlSheetClass object.

Init is a VIRTUAL method so that other base class methods can directly call
the Init virtual method in a derived class. This lets you easily implement your
own custom version of this method.

Implementation: The Init method calls the [Link] method, and sets the initial
value of the BorderWidth property equal to the
[Link] property.

The [Link] method calls the Init method.

Example:
[Link] PROCEDURE(SIGNED Feq, *WebControlClass NewControl)

CODE
ASSERT(~NewControl &= NULL)
[Link](Feq, SELF)
[Link](NewControl)

SeeAlso: BorderWidth, [Link], [Link]

CHAPTER 9 WEBHTMLSHEETCLASS 311

ResetControl (update server control)

ResetControl( submit item ), VIRTUAL

ResetControl Synchronizes the Server SHEET control with the

corresponding Web page controls.
submit item The label of the SubmitItem object containing the
information submitted by the Client browser for this
control.
The ResetControl method synchronizes the Server SHEET control with its
corresponding Web page controls. The ResetControl method takes Web page
control information submitted by the Client browser, such as the currently
selected tab, and applies it to the corresponding Server control.

ResetControl is a VIRTUAL method so that other base class methods can

directly call the ResetControl virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The [Link] method calls the ResetControl method.

SeeAlso: [Link]
312 C L A R I O N  IBC LIBRARY REFERENCE

SetBorderWidth (setWebpagecontrol border width)

SetBorderWidth( width ), VIRTUAL

SetBorderWidth Sets the border width of the control.

width An integer constant, variable, EQUATE or expression
assigned to the BorderWidth property.
The SetBorderWidth method sets the border width of the control as it
appears on the Web page.

SetBorderWidth is a VIRTUAL method so that other base class methods can

directly call the SetBorderWidth virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: The SetBorderWidth method sets the BorderWidth property.

SeeAlso: BorderWidth
CHAPTER 9 WEBHTMLSHEETCLASS 313

SetChildDefaults (set nestedchild controls)

SetChildDefaults, VIRTUAL
The SetChildDefaults method sets the children of this control, considering
only controls that have the same parent. This has the effect of properly
relating layered (stacked) controls, nested controls, or both. For example a
REGION control on top of an IMAGE control (layered to generated events
for the IMAGE), or a SHEET control and its TAB controls on top of a LIST
control (layered and nested to give the appearance of a LIST for each TAB),
or a BUTTON control within an OPTION control within a GROUP control
(simple nesting to give proper visual organization of related controls).

SetChildDefaults is a VIRTUAL method so that other base class methods can

directly call the SetChildDefaults virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: SetChildDefaults calls the [Link] method. The

[Link] method calls the SetChildDefaults
method.

Example:
[Link] PROCEDURE

Index SIGNED,AUTO

CODE
LOOP Index = 1 TO RECORDS([Link])
GET([Link], Index)
[Link]
END

SeeAlso: [Link], [Link]

314 C L A R I O N  IBC LIBRARY REFERENCE

WebHtmlTabClass Proper ties

The WebHtmlTabClass inherits all the properties of the WebControlClass
from which it is derived.

In addition to (or instead of) the inherited methods, the WebHtmlTabClass

contains the properties listed below.

IsEnabled(control enabledflag)
IsEnabled BYTE
The IsEnabled property indicates whether the control is enabled or disabled.
A value of one (1) indicates the control is enabled; a zero (0) indicates the
control is disabled. The WebHtmlTabClass uses this property to enable or
disable the Web page control corresponding to the Server TAB control.

Implementation: The CreateHtml method sets the value of the IsEnabled property as needed.

SeeAlso: CreateHtml
CHAPTER 9 WEBHTMLTABCLASS 315

WebHtmlTabClass Methods
The WebHtmlTabClass inherits all the methods of the WebControlClass from
which it is derived.

In addition to (or instead of) the inherited methods, the WebHtmlTabClass

contains the methods listed below.

CreateHtml (write HTMLfor control andits attributes)

CreateHtml( html object ), VIRTUAL

CreateHtml Writes the HTML code representing the TAB control

and its attributes.
html object The label of the HtmlClass object that writes the HTML
code.
The CreateHtml method writes the HTML code representing the TAB
control and its attributes.

CreateHtml is a VIRTUAL method so that other base class methods can

directly call the CreateHtml virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The [Link] method calls the CreateHtml method.

SeeAlso: [Link]
316 C L A R I O N  IBC LIBRARY REFERENCE

CreateJslData (updateWebpagecontrol)
CreateJslData( Jsl manager ), VIRTUAL

CreateJslData Writes Java Support Library (JSL) data to synchronize

CreateJslData is a VIRTUAL method so that other base class methods can

directly call the CreateJslData virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The CreateJslData method enables or disables the Web page control that
corresponds to the TAB control.

The [Link] method calls the CreateJslData method.

Example:
[Link] PROCEDURE(*JslManagerClass Target)

SeeAlso: [Link]
CHAPTER 9 WEBHTMLTABCLASS 317

CreateParams (write all tabparameters)

CreateParams( html object ), VIRTUAL

CreateParams Writes all the applet parameters for the TAB control.
html object The label of the HtmlClass object that writes the HTML
code.
The CreateParams method writes all the applet parameters for the TAB
control.

CreateParams is a VIRTUAL method so that other base class methods can

directly call the CreateParams virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Example:
[Link] PROCEDURE(*HtmlClass Target)
CharToDlgX EQUATE(4)
TabExtraWidth EQUATE(8)
CurText ANY
Filename ANY
Height SIGNED,AUTO
Width SIGNED,AUTO
CODE
IF (NOT [Link]) THEN RETURN.
CurText = [Link]()
Width = LEN(CurText) * CharToDlgX + TabExtraWidth
Height = 14
[Link]([Link],[Link](),Width,Height)
[Link](Target)
[Link]
318 C L A R I O N  IBC LIBRARY REFERENCE

GetAppletType(return applet type)

GetAppletType, STRING, VIRTUAL
The GetAppletType method returns the applet type for the TAB control. The
type corresponds to an applet defined in the Java Support Library. See Jsl
Manager Class for more information on the Java Support Library.

GetAppletType is a VIRTUAL method so that other base class methods can

directly call the GetAppletType virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: The GetAppletType method returns 'ClarionImageButton.'

Return DataType: STRING

GetHasHotkey (control textmay contain&)

GetHasHotKey is a VIRTUAL method so that other base class methods can

directly call the GetHasHotKey virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: The [Link] method calls the GetHasHotKey method to

identify controls that may have Clarion hot key delimiters (&).

Return DataType: BYTE

Example:
[Link] FUNCTION

CODE
IF ([Link]()) !check for hot key
RETURN IC:StripHotkey(CLIP([Link]{PROP:ScreenText}))!return text sans delimiter
END
RETURN CLIP([Link]{PROP:ScreenText}) !return text

SeeAlso: [Link]
320 C L A R I O N  IBC LIBRARY REFERENCE

GetIsChild (return family identity)

GetIsChild( parent control [,control type] ), SIGNED, VIRTUAL

GetIsChild Returns a value indicating whether this WebControlClass

GetIsChild is a VIRTUAL method so that other base class methods can

directly call the GetIsChild virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The [Link] method calls the GetIsChild method to

find first child controls.

EQUATEs for the control type parameter are declared in [Link].

Each control type EQUATE is prefixed with CREATE:.

Return DataType: SIGNED

SeeAlso: Feq, [Link]

CHAPTER 9 WEBHTMLTABCLASS 321

GetPosition(get control coordinates)

GetPosition( x, y, width, height ), VIRTUAL

GetPosition Returns the control coordinates.

x A numeric variable to receive the control’s horizontal
position.
y A numeric variable to receive the control’s vertical
position.
width A numeric variable to receive the control’s width.
height A numeric variable to receive the control’s height.
The GetPosition method returns the control’s SHEET coordinates. The
WebWindowClass and the WebControlClass use this information to help set
appropriate position-based parent/child relationships for the controls. The
LayoutHtmlClass uses this information to help position the control on the
Web page.

GetPosition is a VIRTUAL method so that other base class methods can

directly call the GetPosition virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Example:
[Link] PROCEDURE

Children WebControlQueue
MyRect GROUP(Rect)
END
CODE
[Link](MyRect.x, MyRect.y, [Link], [Link])
[Link](Children, [Link])
[Link](Children, SELF, MyRect)
322 C L A R I O N  IBC LIBRARY REFERENCE

GetVisible (return control statusflag)

GetVisible is a VIRTUAL method so that other base class methods can

directly call the GetVisible virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: A TAB control may be omitted from the Web page because it is disabled or
hidden.

Return DataType: BYTE

Example:
[Link] PROCEDURE |
(*WebControlQueue Source, *LayoutHtmlClass Layout)

CurIndex SIGNED,AUTO

CODE
LOOP CurIndex = 1 TO RECORDS(Source)
GET(Source, CurIndex)
IF ([Link]())
[Link]([Link])
END
END
CHAPTER 9 WEBHTMLTABCLASS 323

ResetControl (update server control)

ResetControl( submit item ), VIRTUAL

ResetControl Synchronizes the Server TAB control with its corre-

sponding Web page control.
submit item The label of the SubmitItem object containing the
information submitted by the Client browser for this
control.
The ResetControl method synchronizes the Server TAB control with its
corresponding Web page control. The ResetControl method takes Web page
control information submitted by the Client browser, such as enabled state or
events, and applies it to the corresponding Server control.

ResetControl is a VIRTUAL method so that other base class methods can

directly call the ResetControl virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The [Link] method calls the ResetControl method.

SeeAlso: [Link]
324 C L A R I O N  IBC LIBRARY REFERENCE

SetParentDefaults (confirmparent)
SetParentDefaults( potential parent, coordinates ), VIRTUAL

SetParentDefaults Confirms this control’s boundaries fall entirely within

The WebControlClass uses this method to establish the correct parent/child

relationships between SHEET controls and TAB controls.

SetParentDefaults is a VIRTUAL method so that other base class methods

can directly call the SetParentDefaults virtual method in a derived class. This
lets you easily implement your own custom version of this method.

Implementation: The [Link] method does nothing, because, for

Web page purposes, the TAB control’s children belong to the SHEET control
that owns the TAB.

The coordinates parameter names a GROUP with the same structure as the
Rect GROUP declared in [Link] as follows:
Rect GROUP,TYPE
x SIGNED
y SIGNED
width SIGNED
height SIGNED
END

Example:
[Link] PROCEDURE|
(*WebControlQueue Source, *WebControlClass Other, *Rect ParentPos)

CurIndex SIGNED,AUTO

CODE
LOOP CurIndex = 1 TO RECORDS(Source)
GET(Source, CurIndex)
[Link](Other, ParentPos)
END

SeeAlso: [Link]
CHAPTER 9 WEBHTMLTEXTCLASS 325

WebHtmlTextClass Methods
The WebHtmlTextClass inherits all the methods of the WebControlClass
from which it is derived.

In addition to (or instead of) the inherited methods, the WebHtmlTextClass

contains the methods listed below.

CreateCellContents (generate HTMLtext box)

CreateCellContents( html object ), VIRTUAL

CreateCellContents
Generates HTML code to represent a text box.
html object The label of the HtmlClass object that writes the HTML
code.
The CreateCellContents method generates HTML code to represent a text
box.

CreateCellContents is a VIRTUAL method so that other base class methods

can directly call the CreateCellContents virtual method in a derived class.
This lets you easily implement your own custom version of this method.

Implementation: The [Link] method calls the CreateCellContents

method.

The proper positioning of each Web page control is accomplished by using

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE
[Link](Target) !write HTML TABLE CELL header
[Link](Target) !write HTML representing the control
[Link](Target) !write HTML TABLE CELL footer

SeeAlso: [Link], [Link],

[Link], [Link]
326 C L A R I O N  IBC LIBRARY REFERENCE

CreateJslData (updateWebpagecontrol)
CreateJslData( Jsl manager ), VIRTUAL

CreateJslData Writes Java Support Library (JSL) data to synchronize

CreateJslData is a VIRTUAL method so that other base class methods can

directly call the CreateJslData virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The [Link] method calls the CreateJslData method.

Example:
[Link] PROCEDURE(*JslManagerClass Target)

SeeAlso: [Link]
CHAPTER 9 WEBHTMLTEXTCLASS 327

ResetControl (update server control)

ResetControl( submit item ), VIRTUAL

ResetControl Synchronizes the Server CHECK control with its

ResetControl is a VIRTUAL method so that other base class methods can

directly call the ResetControl virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The [Link] method calls the ResetControl method.

SeeAlso: [Link]
328 C L A R I O N  IBC LIBRARY REFERENCE

WebButtonClass Methods
The WebHtmlButtonClass inherits all the methods of the WebControlClass
from which it is derived.

In addition to (or instead of) the inherited methods, the WebHtmlButtonClass

contains the methods listed below.

BeforeResetControl (control preprocessing)

BeforeResetControl, VIRTUAL
The BeforeResetControl method does any control specific processing prior
to synchronizing the WINDOW control with its corresponding Web page
control.

BeforeResetControl is a VIRTUAL method so that other base class methods

can directly call the BeforeResetControl virtual method in a derived class.
This lets you easily implement your own custom version of this method.

Implementation: The BeforeResetControl method identifes the default button for the window.

The [Link] method calls BeforeResetControl.

SeeAlso: [Link], [Link]

CHAPTER 9 WEBBUTTONCLASS 329

GetHasHotkey (control textmay contain&)

GetHasHotKey is a VIRTUAL method so that other base class methods can

directly call the GetHasHotKey virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: The [Link] method calls the GetHasHotKey method to

identify controls that may have Clarion hot key delimiters (&).

Return DataType: BYTE

Example:
[Link] FUNCTION

CODE
IF ([Link]()) !check for hot key
RETURN IC:StripHotkey(CLIP([Link]{PROP:ScreenText}))!return text sans delimiter
END
RETURN CLIP([Link]{PROP:ScreenText}) !return text

SeeAlso: [Link]
330 C L A R I O N  IBC LIBRARY REFERENCE

GetVisible (return control statusflag)

GetVisible, BYTE, VIRTUAL
The GetVisible method returns a value indicating whether the button should
appear on the Web page. A return value of one (1) indicates the button should
appear on the Web page; a return value of zero (0) indicates the button
should not appear.

GetVisible is a VIRTUAL method so that other base class methods can

directly call the GetVisible virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The GetVisible method calls the [Link] method for

buttons implementing standard Windows behavior ({PROP:Std}); otherwise
GetVisible returns False.

Return DataType: BYTE

Example:
[Link] PROCEDURE |
(*WebControlQueue Source, *LayoutHtmlClass Layout)

CurIndex SIGNED,AUTO

CODE
LOOP CurIndex = 1 TO RECORDS(Source)
GET(Source, CurIndex)
IF ([Link]())
[Link]([Link])
END
END

SeeAlso: [Link]
CHAPTER 9 WEBBUTTONCLASS 331

ResetControl (update server control)

ResetControl( submit item ), VIRTUAL

ResetControl Synchronizes the Server BUTTON control with its

ResetControl is a VIRTUAL method so that other base class methods can

directly call the ResetControl virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The ResetControl method sets the [Link]

property.

The [Link] method calls the ResetControl method.

SeeAlso: [Link], [Link]

332 C L A R I O N  IBC LIBRARY REFERENCE

WebHtmlButtonClass Methods
The WebHtmlButtonClass inherits all the methods of the WebButtonClass
from which it is derived.

In addition to (or instead of) the inherited methods, the WebHtmlButtonClass

contains the methods listed below.

CreateCellContents (generate HTMLbutton)

CreateCellContents( html object ), VIRTUAL

CreateCellContents
Generates HTML code to represent a button.
html object The label of the HtmlClass object that writes the HTML
code.
The CreateCellContents method generates HTML code to represent a
button.

CreateCellContents is a VIRTUAL method so that other base class methods

can directly call the CreateCellContents virtual method in a derived class.
This lets you easily implement your own custom version of this method.

Implementation: The [Link] method calls the CreateCellContents

method.

The proper positioning of each Web page control is accomplished by using

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE
[Link](Target) !write HTML TABLE CELL header
[Link](Target) !write HTML representing the control
[Link](Target) !write HTML TABLE CELL footer

SeeAlso: [Link], [Link],

[Link], [Link]
CHAPTER 9 WEBHTMLBUTTONCLASS 333

Init (initializeWebButtonClassobject)
Init( control number, owner window ), VIRTUAL

Init Initializes the WebButtonClass object.

Init is a VIRTUAL method so that other base class methods can directly call
the Init virtual method in a derived class. This lets you easily implement your
own custom version of this method.

Implementation: The Init method calls the [Link] method, then sets PROP:Std
to STD:Help for global toolbar help buttons.

The [Link] method calls the Init method.

Example:
[Link] PROCEDURE(SIGNED Feq, *WebControlClass NewControl)

CODE
ASSERT(~NewControl &= NULL)
[Link](Feq, SELF)
[Link](NewControl)

SeeAlso: [Link]
334 C L A R I O N  IBC LIBRARY REFERENCE

ResetControl (update server control)

ResetControl( submit item ), VIRTUAL

ResetControl Synchronizes the Server BUTTON control with its

corresponding Web page button.
submit item The label of the SubmitItem object containing the
information submitted by the Client browser for this
control.
The ResetControl method synchronizes the Server BUTTON control with
its corresponding Web page button. The ResetControl method takes Web
page control information submitted by the Client browser, such as control
events (EVENT:Accepted), and applies it to the corresponding Server
control.

ResetControl is a VIRTUAL method so that other base class methods can

directly call the ResetControl virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The ResetControl method calls the [Link] method

before POSTing appropriate events.

The [Link] method calls the ResetControl method.

SeeAlso: [Link], [Link]

CHAPTER 9 WEBJAVABUTTONCLASS 335

WebJavaButtonClass Proper ties

The WebJavaButtonClass inherits all the properties of the WebButtonClass
from which it is derived.

In addition to (or instead of) the inherited properties, the

WebJavaButtonClass contains the properties listed below.

IsEnabled(control enabledflag)
IsEnabled BYTE
The IsEnabled property indicates whether the control is enabled or disabled.
A value of one (1) indicates the control is enabled; a zero (0) indicates the
control is disabled. The WebJavaButtonClass uses this property to enable or
disable the Web page button corresponding to the Server BUTTON control.

Implementation: The CreateHtml method sets the value of the IsEnabled property as needed.

SeeAlso: CreateHtml
336 C L A R I O N  IBC LIBRARY REFERENCE

WebJavaButtonClass Methods
The WebJavaButtonClass inherits all the methods of the WebButtonClass
from which it is derived.

In addition to (or instead of) the inherited methods, the WebJavaButtonClass

contains the methods listed below.

CreateHtml (write HTMLfor control andits attributes)

CreateHtml( html object [,width, height] ), VIRTUAL

CreateHtml Writes the HTML code representing the control and its
attributes.
html object The label of the HtmlClass object that writes the HTML
code.
width An integer constant, variable, EQUATE, or expression
indicating the width of the button. If omitted, the
WebJavaButtonClass object uses the Clarion AT attribute
width.
height An integer constant, variable, EQUATE, or expression
indicating the height of the [Link] omitted, the
WebJavaButtonClass object uses the Clarion AT attribute
height.
The CreateHtml method writes the HTML code representing the control
and its attributes, including any image associated with the button.

CreateHtml is a VIRTUAL method so that other base class methods can

directly call the CreateHtml virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The CreateHtml method sets the button’s width, height, text, image, tooltip,
alignment, enabled/disabled state, and the browser action to take when the
end user presses the button.

The [Link] method calls the CreateHtml method.

CHAPTER 9 WEBJAVABUTTONCLASS 337

SeeAlso: [Link]
338 C L A R I O N  IBC LIBRARY REFERENCE

CreateJslData (updateWebpagecontrol)
CreateJslData( Jsl manager ), VIRTUAL

CreateJslData Writes Java Support Library (JSL) data to synchronize

CreateJslData is a VIRTUAL method so that other base class methods can

directly call the CreateJslData virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The CreateJslData method enables or disables the Web page button that
corresponds to the BUTTON control.

The [Link] method calls the CreateJslData method.

Example:
[Link] PROCEDURE(*JslManagerClass Target)

SeeAlso: [Link]
CHAPTER 9 WEBJAVABUTTONCLASS 339

CreateParams (write all buttonparameters)

CreateParams( html object ), VIRTUAL

CreateParams Writes all the applet parameters for the BUTTON

control.
html object The label of the HtmlClass object that writes the HTML
code.
The CreateParams method writes all the applet parameters for the
BUTTON control.

CreateParams is a VIRTUAL method so that other base class methods can

directly call the CreateParams virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Example:
[Link] PROCEDURE(*HtmlClass Target,SIGNED Width,SIGNED Height)

CODE
IF (NOT [Link]) THEN RETURN.
[Link]([Link],[Link](),Width,Height)
[Link](Target)
[Link]

GetAppletType(return applet type)

GetAppletType, STRING, VIRTUAL
The GetAppletType method returns the applet type for the BUTTON
control. The type corresponds to an applet defined in the Java Support
Library. See Jsl Manager Class for more information on the Java Support
Library.

GetAppletType is a VIRTUAL method so that other base class methods can

directly call the GetAppletType virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: The GetAppletType method returns 'ClarionImageButton.'

Return DataType: STRING

Example:
[Link] PROCEDURE(*HtmlClass Target,SIGNED Width,SIGNED Height)

CODE
IF (NOT [Link]) THEN RETURN.
[Link]([Link],[Link](),Width,Height)
[Link](Target)
[Link]
340 C L A R I O N  IBC LIBRARY REFERENCE

GetCanDisable (return disable-ability flag)

GetCanDisable is a VIRTUAL method so that other base class methods can

directly call the GetCanDisable virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: The [Link] method calls the GetCanDisable method.

The [Link] method returns True, because Java
buttons can be disabled.

Return DataType: BYTE

Example:
[Link] FUNCTION

CODE
IF ([Link] = DISABLE:Hide) OR |
(([Link] = DISABLE:OptHide) AND NOT [Link]())
IF NOT [Link]{PROP:enabled}
RETURN FALSE
END
END
RETURN [Link]{PROP:visible}

SeeAlso: [Link], [Link]

CHAPTER 9 WEBJAVABUTTONCLASS 341

GetFilename (return imagefilename)

GetFilename, STRING, VIRTUAL
The GetFilename method returns the filename of the file containing the
image to display on the button face.

GetFilename is a VIRTUAL method so that other base class methods can

directly call the GetFilename virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The [Link] method calls the GetFilename method.

Return DataType: STRING

Example:
[Link] PROCEDURE(*HtmlClass Target)

Filename CSTRING(FILE:MaxFileName)

CODE
Filename = [Link]()
[Link]([Link], 'ClarionImageButton', Width, Height)
[Link]('Picture', Filename)
[Link]('Label', [Link]())
[Link]('Hint', [Link]{PROP:tooltip})
[Link]('Align', [Link]())
IF ([Link](EVENT:Accepted) = Update:Full)
[Link]('Submit', 1)
END
[Link]

SeeAlso: CreateHtml
342 C L A R I O N  IBC LIBRARY REFERENCE

ResetControl (update server control)

ResetControl( submit item ), VIRTUAL

ResetControl Synchronizes the Server BUTTON control with its

ResetControl is a VIRTUAL method so that other base class methods can

directly call the ResetControl virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The ResetControl method calls the [Link] method

before POSTing appropriate events.

The [Link] method calls the ResetControl method.

SeeAlso: [Link], [Link]

CHAPTER 9 WEBJAVATOOLBUTTONCLASS 343

WebJavaToolButtonClass Methods
The WebJavaToolButtonClass inherits all the methods of the
WebJavaButtonClass from which it is derived.

In addition to (or instead of) the inherited methods, the

WebJavaToolButtonClass contains the methods listed below.

GetEventAction(return browser action)

GetEventAction( event ), SIGNED, VIRTUAL

GetEventAction Returns the browser action for the specified event.

The SetEventAction associates browser actions with events.

GetEventAction is a VIRTUAL method so that other base class methods can

directly call the GetEventAction virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: The [Link] method calls the GetEventAction

method.

EQUATEs for the return values are declared in [Link] as follows:

Update:OnBrowser EQUATE(0)
Update:Partial EQUATE(1)
Update:Full EQUATE(2)

Return DataType: SIGNED

344 C L A R I O N  IBC LIBRARY REFERENCE

Example:
[Link] PROCEDURE(*HtmlClass Target)

Filename CSTRING(FILE:MaxFileName)

SeeAlso: [Link]
CHAPTER 9 WEBHTMLIMAGECLASS 345

WebImageClass
The WebImageClass inherits all the properties and methods of the
WebControlClass from which it is derived. It has no additional methods or
properties, but serves as a foundation to its derived classes:
WebHtmlImageClass and WebJavaImageClass.
346 C L A R I O N  IBC LIBRARY REFERENCE

WebHtmlImageClass Proper ties

The WebHtmlImageClass inherits all the properties of the WebImageClass
from which it is derived.

In addition to (or instead of) the inherited properties, the

WebHtmlImageClass contains the properties listed below.

AltText (text to substitute for image)

AltText CSTRING(255)
The AltText property contains the text to substitute for the Web page image
while the image is downloading, or if the end user has elected not to
download images.

Implementation: The SetDescription method sets the value of the AltText property.

SeeAlso: SetDescription
CHAPTER 9 WEBHTMLIMAGECLASS 347

WebHtmlImageClass Methods
The WebHtmlImageClass inherits all the methods of the WebImageClass
from which it is derived.

In addition to (or instead of) the inherited methods, the WebHtmlCheckClass

contains the methods listed below.

CreateCellContents (generate HTML imagecontrol)

CreateCellContents( html object ), VIRTUAL

CreateCellContents
Generates HTML code to display an image.
html object The label of the HtmlClass object that writes the HTML
code.
The CreateCellContents method generates HTML to display an image.

CreateCellContents is a VIRTUAL method so that other base class methods

can directly call the CreateCellContents virtual method in a derived class.
This lets you easily implement your own custom version of this method.

Implementation: The CreateCellContents method writes HTML to represent the IMAGE as

well as any REGIONs associated with the IMAGE. In Clarion, REGION
controls are often used to generate events for IMAGE controls, which do not
generate events. The WebWindowClass deduces the association between the
IMAGEs and REGIONs based on their (overlapping) coordinates.

[Link] calls the CreateCellContents method.

The proper positioning of each Web page control is accomplished by using

Example:
[Link] PROCEDURE(*HtmlClass Target)
CODE
[Link](Target) !write HTML TABLE CELL header
[Link](Target) !write HTML representing the control
[Link](Target) !write HTML TABLE CELL footer

SeeAlso: [Link], [Link],

[Link], [Link]
348 C L A R I O N  IBC LIBRARY REFERENCE

SetChildDefaults (set image/regionrelationship)

SetChildDefaults, VIRTUAL
The SetChildDefaults method sets the children of the Web page image
control.

For HTML generation purposes, REGION controls used to generate events

for an IMAGE control, become the children of the image control.

SetChildDefaults is a VIRTUAL method so that other base class methods can

directly call the SetChildDefaults virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: The SetChildDefaults method calls the [Link]

method to identify candidate REGION controls. Then it calls the
[Link] method to check the candidates’
coordinates and confirm the actual children.

SeeAlso: [Link], [Link]

SetDescription(set text to substitute for image)

SetDescription( text ), VIRTUAL

SetDescription Sets the text to substitute for the image.

text A string constant, variable, EQUATE or expression
containing the text to substitute for the image.
The SetDescription method sets the text to substitute for the Web page
image while the image is downloading, or if the end user has elected not to
download images.

SetDescription is a VIRTUAL method so that other base class methods can

directly call the SetDescription virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: The SetDescription method sets the value of the Description property.

SeeAlso: Description
CHAPTER 9 WEBJAVAIMAGECLASS 349

WebJavaImageClass Proper ties

The WebJavaImageClass inherits all the properties of the WebImageClass
from which it is derived.

In addition to (or instead of) the inherited properties, the

WebJavaImageClass contains the properties listed below.

Filename (imagefile filename)

Filename CSTRING(FILE:MaxFileName)
The Filename property contains the filename of the file containing the image
to display.

Implementation: The CreateHtml method and the CreateJslData method each set the value of
the Filename property as needed.

SeeAlso: CreateHtml, CreateJslData

350 C L A R I O N  IBC LIBRARY REFERENCE

WebJavaImageClass Methods
The WebJavaImageClass inherits all the methods of the WebImageClass
from which it is derived.

In addition to (or instead of) the inherited methods, the WebJavaImageClass

contains the methods listed below.

CreateHtml (write HTMLfor control andits attributes)

CreateHtml( html object ), VIRTUAL

CreateHtml Writes the HTML code representing the image control

and its attributes.
html object The label of the HtmlClass object that writes the HTML
code.
The CreateHtml method writes the HTML code representing the image
control and its attributes.

CreateHtml is a VIRTUAL method so that other base class methods can

directly call the CreateHtml virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The CreateHtml method implements the image’s width, height, and filename.

The [Link] method calls the

[Link] method.
CHAPTER 9 WEBJAVAIMAGECLASS 351

SeeAlso: [Link]
352 C L A R I O N  IBC LIBRARY REFERENCE

CreateJslData (updateWebpagecontrol)
CreateJslData( Jsl manager ), VIRTUAL

CreateJslData Writes Java Support Library (JSL) data to synchronize

CreateJslData is a VIRTUAL method so that other base class methods can

directly call the CreateJslData virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The [Link] method calls the CreateJslData method.

Example:
[Link] PROCEDURE(*JslManagerClass Target)

SeeAlso: [Link]
CHAPTER 9 WEBJAVAIMAGECLASS 353

CreateParams (write all imageparameters)

CreateParams( html object ), VIRTUAL

CreateParams Writes all the applet parameters for the IMAGE control.
html object The label of the HtmlClass object that writes the HTML
code.
The CreateParams method writes all the applet parameters for the IMAGE
control.

CreateParams is a VIRTUAL method so that other base class methods can

directly call the CreateParams virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Example:
[Link] PROCEDURE(*HtmlClass Target)
X SIGNED,AUTO
Y SIGNED,AUTO
Width SIGNED,AUTO
Height SIGNED,AUTO
CODE
IF (NOT [Link]) THEN RETURN.
[Link] = [Link]([Link]{PROP:tempimage})
IC:GetPositionPixels([Link], X,Y,Width,Height)
[Link]([Link], [Link](), Width, Height)
[Link](Target)
[Link]
354 C L A R I O N  IBC LIBRARY REFERENCE

GetAppletType(return applet type)

GetAppletType is a VIRTUAL method so that other base class methods can

directly call the GetAppletType virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: The GetAppletType method returns 'ClarionImageControl.'

Return DataType: STRING

WebListClass Methods
The WebListClass inherits all the properties and methods of the
WebControlClass from which it is derived.

In addition to (or instead of) the inherited methods, the WebListClass

contains the methods listed below.
GetBackgroundColor (return backgroundcolor)
GetBackgroundColor( [default color] ), LONG, VIRTUAL

GetBackgroundColor
Returns the background color of the Web page list.
default color An integer variable, constant, EQUATE, or expression
containing the color to return if there is no background
color. If omitted, default color defaults to Color:None.
The GetBackgroundColor method returns the background color of the Web
page list.

GetBackgroundColor is a VIRTUAL method so that other base class

methods can directly call the GetBackgroundColor virtual method in a
derived class. This lets you easily implement your own custom version of
this method.

Implementation: The GetBackgroundColor method returns the COLOR attribute of the

WINDOW control, if there is one. Otherwise, it returns the background color
inherited from the Web page. EQUATEs for the default color parameter are
declared in \LIBSRC\[Link].

The CreateColorParameters method calls GetBackgroundColor.

Return DataType: LONG

SeeAlso: CreateColorParameters
356 C L A R I O N  IBC LIBRARY REFERENCE

WebHtmlListClass Methods
The WebHtmlListClass inherits all the methods of the WebListClass from
which it is derived.

In addition to (or instead of) the inherited methods, the WebHtmlListClass

contains the methods listed below.

CreateCellContents (generate HTML list box)

CreateCellContents( html object ), VIRTUAL

CreateCellContents
Generates HTML code to represent a list box.
html object The label of the HtmlClass object that writes the HTML
code.
The CreateCellContents method generates HTML code to represent a list
box.

CreateCellContents is a VIRTUAL method so that other base class methods

can directly call the CreateCellContents virtual method in a derived class.
This lets you easily implement your own custom version of this method.

Implementation: The [Link] method calls the CreateCellContents

method.

The proper positioning of each Web page control is accomplished by using

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE
[Link](Target) !write HTML TABLE CELL header
[Link](Target) !write HTML representing the control
[Link](Target) !write HTML TABLE CELL footer

SeeAlso: [Link], [Link],

[Link], [Link]
CHAPTER 9 WEBHTMLLISTCLASS 357

CreateJslData (updateWebpage control)

CreateJslData( Jsl manager ), VIRTUAL

CreateJslData Writes Java Support Library (JSL) data to synchronize

CreateJslData is a VIRTUAL method so that other base class methods can

directly call the CreateJslData virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The CreateJslData method applies a new selection in the list box.

The [Link] method calls the CreateJslData method.

Example:
[Link] PROCEDURE(*JslManagerClass Target)

SeeAlso: [Link]
358 C L A R I O N  IBC LIBRARY REFERENCE

ResetControl (update server control)

ResetControl( submit item ), VIRTUAL

ResetControl Synchronizes the Server LIST control with its corre-

sponding Web page list box.
submit item The label of the SubmitItem object containing the
information submitted by the Client browser for this
control.
The ResetControl method synchronizes the Server LIST control with its
corresponding Web page list box. The ResetControl method takes Web page
control information submitted by the Client browser, such as a new item
selection, and applies it to the corresponding Server control.

ResetControl is a VIRTUAL method so that other base class methods can

directly call the ResetControl virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The CreateJslData method applies a new selection in the list box.

The [Link] method calls the ResetControl method.

SeeAlso: [Link]
CHAPTER 9 WEBJAVALISTCLASS 359

WebJavaListClass Proper ties

The WebJavaListClass inherits all the properties of the WebListClass from
which it is derived.

In addition to (or instead of) the inherited properties, the WebJavaListClass

contains the properties listed below.

AutoSpotLink(hypertext links)
AutoSpotLink BYTE, PROTECTED
The AutoSpotLink property indicates whether list text that appears to be a
URL, email address, FTP site, etc., are implemented on the Web page as
“live” hypertext links or plain text. A value of one (1) generates live links; a
value of zero (0) generates plain text.

This property is PROTECTED, therefore, it can only be referenced by a

WebJavaListClass method, or a method in a class derived from
WebJavaListClass.

Implementation: The SetAutoSpotLink method sets the value of the AutoSpotLink property.

SeeAlso: SetAutoSpotLink

EventActionQ (browser actionsfor listbox events)

EventActionQ &EventActionQueue
The EventActionQ property is a reference to a structure containing standard
Clarion event numbers (such as EVENT:ScrollUp) and their corresponding
browser actions (such as Update:Partial). The WebJavaListClass object uses
this property to generate appropriate JavaScript for the list box.

Implementation: The Init method creates (allocates memory for) the EventActionQ. The
SetEventAction method sets the values of the EventActionQ property. The
GetEventAction method returns the action for a specified event. The Kill
method disposes of (frees memory for) the EventActionQ.

The EventActionQ property is a reference to a QUEUE with the same

structure as EventActionQueue declared in [Link] as follows:
EventActionQueue QUEUE,TYPE
EventNo SIGNED
Action BYTE
END

SeeAlso: Init, GetEventAction, Kill, SetEventAction

360 C L A R I O N  IBC LIBRARY REFERENCE

Format (Weblist formattinginformation)

Format ULONG
The Format property contains the Web version of the LIST FORMAT
attribute. The WebJavaListClass object passes this formatting information to
the Java Support Library.

Implementation: The Init method sets the initial value of the Format property.

SeeAlso: Init

FromQ(LISTdata source)
FromQ &QUEUE
The FromQ property is a reference to the LIST’s FROM attribute. The
WebJavaListClass object uses this property to refer to the LIST’s data source
QUEUE.

Implementation: The SetQueue method sets the value of the FromQ property. The
WebJavaListClass object uses the FromQ property to detect any changes to
the source QUEUE, and to avoid generating new JSL data when there are no
changes.

SeeAlso: SetQueue
CHAPTER 9 WEBJAVALISTCLASS 361

QueueActionQ (Server LISTqueuechanges)

QueueActionQ &QueueActionQueue, PROTECTED
The QueueActionQ property is a reference to a structure indicating exactly
how the data source QUEUE has changed since the Client browser was last
updated. The WebJavaListClass object uses this property to generate
minimum JSL data for the list box.

This property is PROTECTED, therefore, it can only be referenced by a

WebJavaListClass method, or a method in a class derived from
WebJavaListClass.

Implementation: The Init method creates (allocates memory for) the QueueActionQ. The
ResetFromQueue method sets the values of the QueueActionQ property. The
Kill method disposes of (frees memory for) the QueueActionQ.

The QueueActionQ property is a reference to a QUEUE with the same

structure as QueueActionQueue declared in [Link] as follows:
QueueActionQueue QUEUE,TYPE
Action BYTE
NumItems LONG
Offset LONG
END

SeeAlso: Init, Kill, ResetFromQueue

Started(Java list applet started)

Started BYTE(False), PROTECTED
The Started property indicates whether the Java applet representing the
LIST has started. A value of one (1) indicates the applet has started; a value
of zero (0) indicates the applet has not started. The WebJavaListClass object
uses this property to avoid sending JSL data until the applet is ready to
receive it.

This property is PROTECTED, therefore, it can only be referenced by a

WebJavaListClass method, or a method in a class derived from
WebJavaListClass.

Implementation: The CreateHtml method sets the Started property to False when it generates
code to instantiate the applet; the ResetControl method sets the Started
property to True when the applet first requests data.

SeeAlso: CreateHtml, ResetControl

362 C L A R I O N  IBC LIBRARY REFERENCE

WebJavaListClass Methods
The WebJavaListClass inherits all the methods of the WebListClass from
which it is derived.

In addition to (or instead of) the inherited methods, the WebJavaListClass

contains the methods listed below.

CreateHtml (write HTMLfor LISTcontrol)

CreateHtml( html object ), VIRTUAL

CreateHtml Writes the HTML code representing the LIST control

and its attributes.
html object The label of the HtmlClass object that writes the HTML
code.
The CreateHtml method writes the HTML code representing the LIST
control and its attributes.

CreateHtml is a VIRTUAL method so that other base class methods can

directly call the CreateHtml virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The CreateHtml method writes list attributes including format string, fonts,
colors, text justification, grid lines, scrollbars and more.

The [Link] method calls the CreateHtml method.

CHAPTER 9 WEBJAVALISTCLASS 363

SeeAlso: [Link]
364 C L A R I O N  IBC LIBRARY REFERENCE

CreateJslData (updateWebpagecontrol)
CreateJslData( Jsl manager ), VIRTUAL

CreateJslData Writes Java Support Library (JSL) data to synchronize

CreateJslData is a VIRTUAL method so that other base class methods can

directly call the CreateJslData virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The [Link] method calls the CreateJslData method.

The CreateJslData method writes the minimum amount of data required to
refresh the browser list box.

Example:
[Link] PROCEDURE(*JslManagerClass Target)

SeeAlso: [Link]
CHAPTER 9 WEBJAVALISTCLASS 365

CreateParams (write all list parameters)

CreateParams( html object ), VIRTUAL

CreateParams Writes all the applet parameters for the LIST control.
html object The label of the HtmlClass object that writes the HTML
code.
The CreateParams method writes all the applet parameters for the LIST
control.

CreateParams is a VIRTUAL method so that other base class methods can

directly call the CreateParams virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Example:
[Link] PROCEDURE(*HtmlClass Target)
CODE
IF (NOT [Link]) THEN RETURN.
IF ([Link] = 0)
GETPOSITION([Link],,,[Link],[Link])
END
[Link]([Link],[Link](),[Link],[Link])
[Link](Target)
[Link]
[Link] = FALSE
[Link]
366 C L A R I O N  IBC LIBRARY REFERENCE

GetAppletType(return applet type)

GetAppletType, STRING, VIRTUAL
The GetAppletType method returns the applet type for the LIST control.
The type corresponds to an applet defined in the Java Support Library. See
Jsl Manager Class for more information on the Java Support Library.

GetAppletType is a VIRTUAL method so that other base class methods can

directly call the GetAppletType virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: The GetAppletType method returns 'ClarionListBox.'

Return DataType: STRING

GetEventAction(return browser action)

GetEventAction( event ), SIGNED, VIRTUAL

GetEventAction Returns the browser action for the specified event.

The SetEventAction associates browser actions with events.

GetEventAction is a VIRTUAL method so that other base class methods can

directly call the GetEventAction virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: The [Link] method calls the GetEventAction

method.

EQUATEs for the return values are declared in [Link] as follows:

Update:OnBrowser EQUATE(0)
Update:Partial EQUATE(1)
Update:Full EQUATE(2)

Return DataType: SIGNED

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE
[Link]('<<SELECT' & [Link](Target) & ' SIZE=' & Depth)
IF ([Link])
[Link]([Link](EVENT:Accepted), HTML:SelectChanged,
HTML:SelectValue)
END
[Link]('>')
[Link](IC:GetListboxHtml([Link]))
[Link]('<</SELECT>')
[Link]

SeeAlso: [Link]
368 C L A R I O N  IBC LIBRARY REFERENCE

Init (initialize theWebJavaListClassobject)

Init( control number, owner window ), VIRTUAL

Init Initializes the WebJavaListClass object.

control number An integer constant, variable, EQUATE, or expression
containing the control number (field equate).
owner window The label of the WebWindowClass object that instanti-
ated this WebJavaListClass object.
The Init method initializes the WebJavaListClass object.

Init is a VIRTUAL method so that other base class methods can directly call
the Init virtual method in a derived class. This lets you easily implement your
own custom version of this method.

Implementation: The [Link] method calls the Init method. The Init
method primes the EventActionQ property with appropriate Clarion events
and their corresponding browser actions.

Example:
[Link] PROCEDURE(SIGNED Feq, *WebControlClass NewControl)

CODE
ASSERT(~NewControl &= NULL)
[Link](Feq, SELF)
[Link](NewControl)

SeeAlso: EventActionQ
CHAPTER 9 WEBJAVALISTCLASS 369

Kill (shut down theWebJavaListClassobject)

Kill, VIRTUAL
The Kill method frees any memory allocated during the life of the object and
performs any other required termination code.

Kill is a VIRTUAL method so that other base class methods can directly call
the Kill virtual method in a derived class. This lets you easily implement
your own custom version of this method.

ResetControl (update server control)

ResetControl( submit item ), VIRTUAL

ResetControl Synchronizes the Server LIST control with its corre-

sponding Web page list box.
submit item The label of the SubmitItem object containing the
information submitted by the Client browser for this
control.
The ResetControl method synchronizes the Server LIST control with its
corresponding Web page list box. The ResetControl method takes Web page
control information submitted by the Client browser, such as control contents
and events, and applies it to the corresponding Server control.

ResetControl is a VIRTUAL method so that other base class methods can

directly call the ResetControl virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The [Link] method calls the ResetControl method.

SeeAlso: [Link]
CHAPTER 9 WEBJAVALISTCLASS 371

ResetFromQueue(record changesto Server LISTqueue)

ResetFromQueue( change [,offset] [,number] ), VIRTUAL

ResetFromQueue Records changes to the Server LIST control.

change An integer constant, variable, EQUATE or expression
that indicates the type of change made to the LIST’s
queue. Valid actions include insert, delete, delete all,
replace, scroll, scroll down, and scroll up.
offset An integer constant, variable, EQUATE or expression
that indicates the direction of a scroll action, or the
relative position of an insert, delete, or replace action. If
omitted, offset defaults to zero (0).
number An integer constant, variable, EQUATE or expression
that indicates the number of list items to scroll for a
scroll action; otherwise the number of list items affected
for an insert, delete, or replace action. If omitted,
number defaults to one (1).
The ResetFromQueue method records changes to the Server LIST control’s
data source queue so the same changes can be efficiently applied to the
corresponding Web page control.

ResetFromQueue is a VIRTUAL method so that other base class methods

can directly call the ResetFromQueue virtual method in a derived class. This
lets you easily implement your own custom version of this method.

Implementation: Typically, this method is called during the scroll handling for the LIST. For
example, from the BRWX::ScrollOne ROUTINE for a template generated
BrowseBox.

SetAutoSpotLink(set livehypertext links)

SetAutoSpotLink( value ), VIRTUAL

SetAutoSpotLink Sets the automatic generation of live hypertext links.

value A Boolean constant, variable, EQUATE or expression
assigned to the AutoSpotLink property.
The SetAutoSpotLink method enables or disables the automatic generation
of live hypertext links for list text that appears to be a URL, email address,
FTP site, etc. A value of one (1) enables live links; a value of zero (0)
disables live links (generates plain text).

SetAutoSpotLink is a VIRTUAL method so that other base class methods

can directly call the SetAutoSpotLink virtual method in a derived class. This
lets you easily implement your own custom version of this method.

Implementation: The SetAutoSpotLink method sets the AutoSpotLink property.

Example:
IC:CurControl &= [Link](?Browse:1)
IC:[Link](TRUE)

SeeAlso: AutoSpotLink

SetDirty (forcerefreshofWebpage list box)

SetDirty
The SetDirty method forces a single unconditional generation of new Web
page list box data. Once the data is generated, the WebJavaListClass object
reverts to conditional generation of data only as needed.

Implementation: The SetDirty method is available for your use. The IBC Library does not call
it. The CreateJslData method generates JSL data to refresh the Web page list
box if SetDirty was called.

Example:
IC:CurControl &= [Link](?Browse:1)
IC:[Link]

SeeAlso: CreateJslData
CHAPTER 9 WEBJAVALISTCLASS 373

SetEventAction(associate browser actionwith control event)

SetEventAction( event, action ), VIRTUAL

SetEventAction Associates a browser action with a particular control

event.
event An integer constant, variable, EQUATE or expression
identifying the Web control event. Most controls only
support EVENT:Accepted, which is triggered when the
end user presses an OK or Submit button, or the RETURN,
ENTER, or TAB key. However, list based controls also
support scrolling events, selection events, and others.
action An integer constant, variable, EQUATE or expression
identifying the browser action. Valid actions are
Update:OnBrowser (don’t contact the Server ),
Update:Partial (request Java control data only from the
Server), and Update:Full (request the entire page from
the Server).
The SetEventAction method associates a browser action with a particular
Web page control event. That is, the browser action, such as Update:Partial,
is an attribute of the control. When the end user creates an event for the Web
page control by mouse-clicking or pressing the RETURN, ENTER, or TAB key, the
Client browser requests the action associated with the event. The Clarion
Application Broker forwards the request to the Server which processes it.

The GetEventAction method returns the action for a specified event.

SetEventAction is a VIRTUAL method so that other base class methods can

directly call the SetEventAction virtual method in a derived class. This lets
you easily implement your own custom version of this method.
374 C L A R I O N  IBC LIBRARY REFERENCE

EQUATEs for the action parameter are declared in [Link] as follows:

Update:OnBrowser EQUATE(0)
Update:Partial EQUATE(1)
Update:Full EQUATE(2)

Example:
[Link] PROCEDURE(SIGNED Feq, *WebWindowBaseClass OwnerWindow)

CODE
[Link](Feq, OwnerWindow)
[Link] &= NEW EventActionQueue
[Link] &= NEW QueueActionQueue
[Link] = TRUE

[Link](EVENT:NewSelection, Update:Partial)
[Link](EVENT:Initialize, Update:Partial)
[Link](EVENT:AlertKey, Update:Partial)

SeeAlso: GetEventAction
CHAPTER 9 WEBJAVALISTCLASS 375

SetQueue(set thedata sourcequeue)

SetQueue( source ), VIRTUAL

SetQueue Sets the WebJavaListClass object’s data source queue.

source The label of the data source QUEUE (the LIST’s FROM
attribute).
The SetQueue method sets the WebJavaListClass object’s data source queue,
so the object can detect changes to the source, and generate the minimum
JSL data needed to reflect those changes.

SetQueue is a VIRTUAL method so that other base class methods can

directly call the SetQueue virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The SetQueue method sets the value of the FromQ property. The FromQ
property is a reference to the data source for the LIST control.

SeeAlso: FromQ
376 C L A R I O N  IBC LIBRARY REFERENCE

UpdateState (forcerefreshofWebpagelist box)

UpdateState
The UpdateState method saves the current state of various LIST attributes,
so the WebJavaListClass object can detect changes to the LIST and generate
the minimum JSL data needed to reflect those changes.

Implementation: The UpdateState method stores the HSCROLL, VSCROLL, and FORMAT
attributes of the LIST.

Example:
[Link] PROCEDURE(*HtmlClass Target)

CurFont HtmlFontClass
Feq SIGNED,AUTO
Properties ANY
CODE
IF (Feq{PROP:hscroll})
IF (Feq{PROP:vscroll})
Properties = Properties & ',HVSCROLL'
ELSE
Properties = Properties & ',HSCROLL'
END
ELSE
IF (Feq{PROP:vscroll})
Properties = Properties & ',VSCROLL'
END
END
[Link]([Link], 'ClarionListBox', [Link], [Link])
[Link](Target, [Link])
[Link]('formatString', [Link]{PROP:format})
[Link]('Events', [Link]([Link],
Update:OnBrowser))
[Link]('Properties', SUB(Properties, 2, -1))
IF ([Link](CurFont))
[Link](CurFont)
END
IF ([Link])
[Link]('AutoSpotLink', [Link])
END
[Link]
[Link] = FALSE
[Link]
CHAPTER 9 WEBHTMLSTRINGCLASS 377

WebStringClass Methods
The WebStringClass inherits all the methods of the WebControlClass from
which it is derived.

In addition to (or instead of) the inherited methods, the WebStringClass

contains the methods listed below.

SetBreakable (allowwordwrap)
SetBreakable( value ), VIRTUAL

SetBreakable Allows long strings to wrap onto additional lines.

value A Boolean constant, variable, EQUATE or expression
that indicates whether the string can wrap.
The SetBreakable method enables or disables the word wrap for the string.
A value of one (1) enables word wrap; a value of zero (0) disables word
wrap.

SetBreakable is a VIRTUAL method so that other base class methods can

directly call the SetBreakable virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Example:
IC:CurControl &= [Link](?MyString)
IC:[Link](TRUE)
378 C L A R I O N  IBC LIBRARY REFERENCE

WebHtmlStringClass Methods
The WebHtmlStringClass inherits all the methods of the WebStringClass
from which it is derived.

In addition to (or instead of) the inherited methods, the WebHtmlStringClass

contains the methods listed below.

CreateCellContents (generate HTMLtextstring)

CreateCellContents( html object ), VIRTUAL

CreateCellContents
Generates HTML code to represent a text string.
html object The label of the HtmlClass object that writes the HTML
code.
The CreateCellContents method generates HTML code to represent a text
string.

CreateCellContents is a VIRTUAL method so that other base class methods

can directly call the CreateCellContents virtual method in a derived class.
This lets you easily implement your own custom version of this method.

Implementation: The [Link] method calls the CreateCellContents

method.

The proper positioning of each Web page control is accomplished by using

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE
[Link](Target) !write HTML TABLE CELL header
[Link](Target) !write HTML representing the control
[Link](Target) !write HTML TABLE CELL footer

SeeAlso: [Link], [Link],

[Link], [Link]
CHAPTER 9 WEBJAVASTRINGCLASS 379

GetCellAttributes(return control attributes)

GetCellAttributes( html object ), STRING, VIRTUAL

GetCellAttributes Returns HTML to set attributes associated with the Web

GetCellAttributes is a VIRTUAL method so that other base class methods

can directly call the GetCellAttributes virtual method in a derived class. This
lets you easily implement your own custom version of this method.

Implementation: The GetCellAttributes method identifies the “centered” attribute if present,

then calls the [Link] method to return any other
attributes.

The [Link] method calls the GetCellAttributes

method.

Return DataType: STRING

Example:
[Link] PROCEDURE(*HtmlClass Target)

CurCell &LayoutCellClass,AUTO
Index SIGNED,AUTO
NumRows SIGNED,AUTO
Xindex SIGNED,AUTO
Yindex SIGNED,AUTO

SeeAlso: [Link]
380 C L A R I O N  IBC LIBRARY REFERENCE

WebJavaStringClass Proper ties

The WebJavaStringClass inherits all the properties of the WebStringClass
from which it is derived.

In addition to (or instead of) the inherited properties, the WebJavaStringClass

contains the properties listed below.

AutoSpotLink(hypertext links)
AutoSpotLink BYTE, PROTECTED
The AutoSpotLink property indicates whether string text that appears to be
a URL, email address, FTP site, etc., is implemented on the Web page as a
“live” hypertext links or plain text. A value of one (1) generates a live link; a
value of zero (0) generates plain text.

This property is PROTECTED, therefore, it can only be referenced by a

WebJavaStringClass method, or a method in a class derived from
WebJavaStringClass.

Implementation: The SetAutoSpotLink method sets the value of the AutoSpotLink property.

SeeAlso: SetAutoSpotLink

LastText (last transmittedvalue)

LastText ANY, PROTECTED
The LastText property contains the last value sent to the Client browser for
this control. The WebJavaStringClass object uses this property to minimize
network traffic.

This property is PROTECTED, therefore, it can only be referenced by a

WebJavaStringClass method, or a method in a class derived from
WebJavaStringClass.
CHAPTER 9 WEBJAVASTRINGCLASS 381

WebJavaStringClass Methods
The WebJavaStringClass inherits all the methods of the WebStringClass from
which it is derived.

In addition to (or instead of) the inherited methods, the WebJavaStringClass

contains the methods listed below.

CreateHtml (write HTMLfor control andits attributes)

CreateHtml( html object ), VIRTUAL

CreateHtml Writes the HTML code representing the STRING

control and its attributes.
html object The label of the HtmlClass object that writes the HTML
code.
The CreateHtml method writes the HTML code representing the STRING
control and its attributes.

CreateHtml is a VIRTUAL method so that other base class methods can

directly call the CreateHtml virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The [Link] method calls the CreateHtml method.

Example:

SeeAlso: [Link]
382 C L A R I O N  IBC LIBRARY REFERENCE

CreateJslData (updateWebpagecontrol)
CreateJslData( Jsl manager ), VIRTUAL

CreateJslData Writes Java Support Library (JSL) data to synchronize

CreateJslData is a VIRTUAL method so that other base class methods can

directly call the CreateJslData virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The [Link] method calls the CreateJslData method.

Example:
[Link] PROCEDURE(*JslManagerClass Target)

SeeAlso: [Link]
CHAPTER 9 WEBJAVASTRINGCLASS 383

CreateParams (write all stringparameters)

CreateParams( html object ), VIRTUAL

CreateParams Writes all the applet parameters for the STRING control.
html object The label of the HtmlClass object that writes the HTML
code.
The CreateParams method writes all the applet parameters for the STRING
control.

CreateParams is a VIRTUAL method so that other base class methods can

directly call the CreateParams virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Example:
[Link] PROCEDURE(*HtmlClass Target)
Height SIGNED,AUTO
Width SIGNED,AUTO
CODE
IF (NOT [Link]) THEN RETURN.
GetPosition([Link],,,Width,Height)
[Link]([Link],[Link](),Width,Height)
[Link](Target)
[Link]
384 C L A R I O N  IBC LIBRARY REFERENCE

GetAppletType(return applet type)

GetAppletType, STRING, VIRTUAL
The GetAppletType method returns the applet type for the STRING control.
The type corresponds to an applet defined in the Java Support Library. See
Jsl Manager Class for more information on the Java Support Library.

GetAppletType is a VIRTUAL method so that other base class methods can

directly call the GetAppletType virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: The GetAppletType method returns 'ClarionStringControl.'

Return DataType: STRING

Init (initializeWebJavaStringClassobject)
Init( control number, owner window ), VIRTUAL

Init Initializes the WebJavaStringClass object.

Init is a VIRTUAL method so that other base class methods can directly call
the Init virtual method in a derived class. This lets you easily implement your
own custom version of this method.

Implementation: The Init method calls the [Link] method, and sets the initial
value of the LastText property equal to ‘MagicValue<12>’ so LastText
doesn’t coincidentally match previously blank text.

The [Link] method calls the Init method.

Example:
[Link] PROCEDURE(SIGNED Feq, *WebControlClass NewControl)

CODE
ASSERT(~NewControl &= NULL)
[Link](Feq, SELF)
[Link](NewControl)

SeeAlso: LastText, [Link], [Link]

386 C L A R I O N  IBC LIBRARY REFERENCE

SetAutoSpotLink(set livehypertext links)

SetAutoSpotLink( value ), VIRTUAL

SetAutoSpotLink Sets the automatic generation of live hypertext links.

value A Boolean constant, variable, EQUATE or expression
assigned to the AutoSpotLink property.
The SetAutoSpotLink method enables or disables the automatic generation
of live hypertext links for string text that appears to be a URL, email address,
FTP site, etc. A value of one (1) enables live links; a value of zero (0)
disables live links (generates plain text).

SetAutoSpotLink is a VIRTUAL method so that other base class methods

can directly call the SetAutoSpotLink virtual method in a derived class. This
lets you easily implement your own custom version of this method.

Implementation: The SetAutoSpotLink method sets the AutoSpotLink property.

Example:
IC:CurControl &= [Link](?MyString)
IC:[Link](TRUE)

SeeAlso: AutoSpotLink
CHAPTER 9 WEBCLOSEBUTTONCLASS 387

WebCloseButtonClass Proper ties

The WebCloseButtonClass inherits all the properties of the WebControlClass
from which it is derived.

In addition to (or instead of) the inherited properties, the

WebCloseButtonClass contains the properties listed below.

Height (buttonheight)
Height SIGNED
The Height property indicates height of the WINDOW control.

Implementation: The Init method sets the value of the dy property.

SeeAlso: Init

Width(buttonwidth)
Width SIGNED
The Width property indicates width of the WINDOW control.

Implementation: The Init method sets the value of the dx property.

SeeAlso: Init

X (buttonhorizontal position)
X SIGNED
The X property indicates horizontal position of the WINDOW control.

Implementation: The Init method sets the value of the x property.

SeeAlso: Init

Y (buttonvertical position)
Y SIGNED
The Y property indicates vertical position of the WINDOW control.

Implementation: The Init method sets the value of the y property.

SeeAlso: Init
388 C L A R I O N  IBC LIBRARY REFERENCE

WebCloseButtonClass Methods
The WebCloseButtonClass inherits all the methods of the WebControlClass
from which it is derived.

In addition to (or instead of) the inherited methods, the

WebCloseButtonClass contains the methods listed below.

CreateHtml (write HTMLfor control andits attributes)

CreateHtml( html object ), VIRTUAL

CreateHtml is a VIRTUAL method so that other base class methods can

directly call the CreateHtml virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The CreateHtml method sets the button’s width, height, text, image, tooltip,
and the browser action to take (close) when the end user presses the button.

The [Link] method calls the CreateHtml method.

CHAPTER 9 WEBCLOSEBUTTONCLASS 389

SeeAlso: [Link]
390 C L A R I O N  IBC LIBRARY REFERENCE

CreateJslData (updateWebpagecontrol)
CreateJslData( Jsl manager ), VIRTUAL

CreateJslData Writes Java Support Library (JSL) data to synchronize

CreateJslData is a VIRTUAL method so that other base class methods can

directly call the CreateJslData virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The CreateJslData method does nothing, because there is no corresponding

WINDOW control for this Web page only control.

The [Link] method calls the CreateJslData method.

Example:
[Link] PROCEDURE(*JslManagerClass Target)

SeeAlso: [Link]
CHAPTER 9 WEBCLOSEBUTTONCLASS 391

CreateParams (write all stringparameters)

CreateParams( html object ), VIRTUAL

CreateParams Writes all the applet parameters for the BUTTON

control.
html object The label of the HtmlClass object that writes the HTML
code.
The CreateParams method writes all the applet parameters for the
BUTTON control.

CreateParams is a VIRTUAL method so that other base class methods can

directly call the CreateParams virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE

IF [Link]
[Link]([Link], [Link](), [Link], [Link])
[Link](Target)
[Link]
ELSE
[Link]('<<INPUT TYPE=SUBMIT VALUE="Close"')
[Link]([Link](Target))
[Link]('>')
END
392 C L A R I O N  IBC LIBRARY REFERENCE

GetAppletType(return applet type)

GetAppletType is a VIRTUAL method so that other base class methods can

directly call the GetAppletType virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: The GetAppletType method returns 'ClarionImageButton.'

Return DataType: STRING

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE

IF [Link]
[Link]([Link], [Link](), [Link], [Link])
[Link](Target)
[Link]
ELSE
[Link]('<<INPUT TYPE=SUBMIT VALUE="Close"')
[Link]([Link](Target))
[Link]('>')
END
CHAPTER 9 WEBCLOSEBUTTONCLASS 393

GetCloneFeq(return buttontomimic)
GetCloneFeq, SIGNED, VIRTUAL
The GetCloneFeq method returns the control number of a similar control so
the WebCloseButtonClass object can mimic its size.

GetCloneFeq is a VIRTUAL method so that other base class methods can

directly call the GetCloneFeq virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The GetCloneFeq method returns the TBarBrwChange (toolbar change

button) control number.

The Init method calls the GetCloneFeq method.

Example:
[Link] PROCEDURE(SIGNED Feq, *WebWindowBaseClass OwnerWindow)

CloneFeq SIGNED

CODE

[Link] = Feq
[Link] = FEQ:Toolbar
SELF.x = 9999
SELF.y = 2
[Link] = 16
[Link] = 14
[Link] &= OwnerWindow

! Resize the close button to match the control returned from this function
CloneFeq = [Link]()
IF (CloneFeq{PROP:type} <> 0)
GetPosition(CloneFeq,,SELF.y,[Link],[Link])
END

SeeAlso: Init
394 C L A R I O N  IBC LIBRARY REFERENCE

GetPosition(get control coordinates)

GetPosition( x, y, width, height ), VIRTUAL

GetPosition Returns the control coordinates.

x A numeric variable to receive the control’s horizontal
position.
y A numeric variable to receive the control’s vertical
position.
width A numeric variable to receive the control’s width.
height A numeric variable to receive the control’s height.
The GetPosition method returns the control’s WINDOW coordinates. The
WebWindowClass and the WebControlClass use this method to help set
appropriate position-based parent/child relationships for the control. The
LayoutHtmlClass uses this information to help position the control on the
Web page.

GetPosition is a VIRTUAL method so that other base class methods can

directly call the GetPosition virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The GetPosition method returns the values of the Height, Width, X, and Y,
properties.

SeeAlso: Height, Width, X, Y

CHAPTER 9 WEBCLOSEBUTTONCLASS 395

GetVisible (return control statusflag)

GetVisible, BYTE, VIRTUAL
The GetVisible method returns a value indicating whether the close button
should appear on the Web page. A return value of one (1) indicates the close
button should appear on the Web page; a return value of zero (0) indicates
the close button should not appear.

GetVisible is a VIRTUAL method so that other base class methods can

directly call the GetVisible virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The close button always appears on the Web page because it has been
explicitly requested.

Return DataType: BYTE

Example:
[Link] PROCEDURE |
(*WebControlQueue Source, *LayoutHtmlClass Layout)

CurIndex SIGNED,AUTO

CODE
LOOP CurIndex = 1 TO RECORDS(Source)
GET(Source, CurIndex)
IF ([Link]())
[Link]([Link])
END
END

SeeAlso: [Link], [Link]

396 C L A R I O N  IBC LIBRARY REFERENCE

Init (initializeWebCloseButtonClassobject)
Init( control number, owner window ), VIRTUAL

Init Initializes the WebCloseButtonClass object.

Init is a VIRTUAL method so that other base class methods can directly call
the Init virtual method in a derived class. This lets you easily implement your
own custom version of this method.

Implementation: The Init method sets the initial value of the Height, Width, X, and Y,
properties. It attempts to provide an intelligent default size and position for
the button.

The [Link] method calls the Init method.

Example:
[Link] PROCEDURE(SIGNED Feq, *WebControlClass NewControl)

CODE
ASSERT(~NewControl &= NULL)
[Link](Feq, SELF)
[Link](NewControl)

SeeAlso: Height, Width, X, Y

CHAPTER 9 WEBLITERALCLASS 397

ResetControl (applyWebpage buttonaction)

ResetControl( submit item ), VIRTUAL

ResetControl Applies the Web page button action to the Server.

submit item The label of the SubmitItem object containing the
information submitted by the Client browser for this
control.
The ResetControl method applies the Web page button action to the Server.
The ResetControl method takes Web page control information submitted by
the Client browser, such as an event (EVENT:CloseWindow), and applies it
to the Server.

ResetControl is a VIRTUAL method so that other base class methods can

directly call the ResetControl virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The ResetControl method POSTs and EVENT:CloseWindow. There is no

corresponding WINDOW control on the Server.

The [Link] method calls the ResetControl method.

SeeAlso: [Link]
398 C L A R I O N  IBC LIBRARY REFERENCE

WebHotlinkClass Methods
The WebHotlinkClass inherits all the methods of the WebControlClass from
which it is derived.

In addition to (or instead of) the inherited methods, the WebHotlinkClass

contains the methods listed below.

CreateCellContents (generate HTMLhypertext link)

CreateCellContents( html object ), VIRTUAL

CreateCellContents
Generates HTML code to represent a hypertext link.
html object The label of the HtmlClass object that writes the HTML
code.
The CreateCellContents method generates HTML code to represent a
hypertext link.

CreateCellContents is a VIRTUAL method so that other base class methods

can directly call the CreateCellContents virtual method in a derived class.
This lets you easily implement your own custom version of this method.

Implementation: The [Link] method calls the CreateCellContents

method. The CreateCellContents method writes the appropriate <<A
HREF...<</A> construction.

The proper positioning of each Web page control is accomplished by using

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE
[Link](Target) !write HTML TABLE CELL header
[Link](Target) !write HTML representing the control
[Link](Target) !write HTML TABLE CELL footer

SeeAlso: [Link], [Link],

[Link], [Link]
CHAPTER 9 WEBLITERALCLASS 399

WebLiteralClass Proper ties

The WebLiteralClass inherits all the properties of the WebControlClass from
which it is derived.

In addition to (or instead of) the inherited properties, the WebLiteralClass

contains the properties listed below.

Text (Webpagetext)
Text CSTRING(1000)
The Text property contains the text to display on the Web page.

Implementation: The Init method sets the value of the x property.

SeeAlso: Init
400 IBC LIBRARY REFERENCE

WebLiteralClass Methods
The WebLiteralClass inherits all the methods of the WebControlClass from
which it is derived.

In addition to (or instead of) the inherited methods, the WebLiteralClass

contains the methods listed below.

CreateHtml (write HTMLfor control)

CreateHtml( html object ), VIRTUAL

CreateHtml Writes the HTML code representing the text.

html object The label of the HtmlClass object that writes the HTML
code.
The CreateHtml method writes the HTML code representing the text.

CreateHtml is a VIRTUAL method so that other base class methods can

directly call the CreateHtml virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The [Link] method calls the CreateHtml method.

SeeAlso: [Link]
CHAPTER 9 WEBNULLCONTROLCLASS 401

GetCellAttributes(return control attributes)

GetCellAttributes( html object ), STRING, VIRTUAL

GetCellAttributes Returns attributes associated with the text.

html object The label of the HtmlClass object that writes the HTML
code.
The GetCellAttributes method returns attributes associated with the text. If
there are no associated attributes, GetCellAttributes returns a null string.

GetCellAttributes is a VIRTUAL method so that other base class methods

can directly call the GetCellAttributes virtual method in a derived class. This
lets you easily implement your own custom version of this method.

Implementation: The GetCellAttributes method always returns a null string because there are
no attributes associated with a WebLiteralClass object.

The [Link] method calls the GetCellAttributes

method.

Return DataType: STRING

Example:
[Link] PROCEDURE(*HtmlClass Target)

CurCell &LayoutCellClass,AUTO
Index SIGNED,AUTO
NumRows SIGNED,AUTO
Xindex SIGNED,AUTO
Yindex SIGNED,AUTO

SeeAlso: [Link]
402 IBC LIBRARY REFERENCE

WebNullControlClass Methods
The WebNullControlClass inherits all the methods of the WebControlClass
from which it is derived.

In addition to (or instead of) the inherited methods, the

WebNullControlClass contains the methods listed below.

CreateHtml (write HTMLfor control)

CreateHtml( html object ), VIRTUAL

CreateHtml Writes no HTML code.

html object The label of the HtmlClass object that writes the HTML
code.
The CreateHtml method writes no HTML code so that the WINDOW
control does not appear on the Web page.

CreateHtml is a VIRTUAL method so that other base class methods can

directly call the CreateHtml virtual method in a derived class. This lets you
easily implement your own custom version of this method.

SeeAlso: [Link]

CreateJslData (updateWebpagecontrol)
CreateJslData( Jsl manager ), VIRTUAL

CreateJslData Writes no Java Support Library (JSL) data.

Jsl manager The label of the JSLManagerClass object that sends data
to Java applets on the Web page.
The CreateJslData method writes no Java Support Library (JSL) data
because the control does not appear on the Web page.

CreateJslData is a VIRTUAL method so that other base class methods can

directly call the CreateJslData virtual method in a derived class. This lets you
easily implement your own custom version of this method.

SeeAlso: [Link]
CHAPTER 9 WEBNULLCONTROLCLASS 403

GetAppletType(return applet type)

GetAppletType, STRING, VIRTUAL
The GetAppletType method returns the applet type for the control. The type
corresponds to an applet defined in the Java Support Library. See Jsl
Manager Class for more information on the Java Support Library.

GetAppletType is a VIRTUAL method so that other base class methods can

directly call the GetAppletType virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: The GetAppletType method returns 'NullApplet.'

Return DataType: STRING

404 IBC LIBRARY REFERENCE

GetCellAttributes(return control attributes)

GetCellAttributes( html object ), STRING, VIRTUAL

GetCellAttributes Returns a null string.

html object The label of the HtmlClass object that writes the HTML
code.
The GetCellAttributes method returns a null string because the control does
not appear on the Web page..

GetCellAttributes is a VIRTUAL method so that other base class methods

can directly call the GetCellAttributes virtual method in a derived class. This
lets you easily implement your own custom version of this method.

Return DataType: STRING

Example:
[Link] PROCEDURE(*HtmlClass Target)

CurCell &LayoutCellClass,AUTO
Index SIGNED,AUTO
NumRows SIGNED,AUTO
Xindex SIGNED,AUTO
Yindex SIGNED,AUTO

SeeAlso: [Link]
CHAPTER 9 WEBNULLCONTROLCLASS 405

GetIsChild (return family identity)

GetIsChild( parent control [,control type] ), SIGNED, VIRTUAL

GetIsChild Returns a value indicating whether this WebControlClass

GetIsChild is a VIRTUAL method so that other base class methods can

directly call the GetIsChild virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The GetIsChild method returns zero (0) because a WebNullControlClass

object has no parent.

EQUATEs for the control type parameter are declared in [Link].

Each control type EQUATE is prefixed with CREATE:.

Return DataType: SIGNED

SeeAlso: [Link]
406 IBC LIBRARY REFERENCE

GetVisible (return control statusflag)

GetVisible, BYTE, VIRTUAL
The GetVisible method returns a value indicating the control should not
appear on the Web page because the WebNullControlClass object’s purpose
is to suppress the control from the Web page.

GetVisible is a VIRTUAL method so that other base class methods can

directly call the GetVisible virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Return DataType: BYTE

SeeAlso: [Link]
CHAPTER 10 WEB AREA CLASSES 407

WEB AREA CLASSES

Overview 409
WebAreaClass Concepts ..................................................................................... 409
Relationship to Other Internet Builder Classes ................................................... 409
Internet Connect Template Implementation .........................................................410
Source Files..........................................................................................................410
WebAreaClass Properties 411
Background (area background color) ..................................................................411
BackImage (area wallpaper) ................................................................................411
LocalFont (area font information) ...................................................................... 411
WebAreaClass Methods 412
GetBackgroundColor (return background color) .................................................412
GetCellAttributes (return area attributes) ............................................................413
GetFont (add font information)........................................................................... 414
GetVisible (return control status flag) .................................................................415
Init (initialize the WebAreaClass object) ............................................................ 416
Kill (shut down the WebAreaClass object)........................................................ 417
PushFont (implement area font) ..........................................................................418
SetBackground (set Web page area background) ................................................419
SetFont .................................................................................................................420
SetParentDefaults (confirm parent) .....................................................................421
WebCaptionClass Properties 422
Alignment (text justification)...............................................................................422
WebCaptionClass Methods 423
CreateHtml (write HTML for caption and its attributes) .....................................423
GetCellAttributes (return caption attributes) .......................................................424
GetPosition (get control coordinates) ................................................................. 425
GetText (return caption text) ................................................................................426
GetVisible (return control status flag) .................................................................427
Init (initialize the WebCaptionClass object) ....................................................... 428
WebMenubarClass Methods 429
CreateHtml (write HTML for menubar and its children) ....................................429
GetPosition (get control coordinates) ................................................................. 430
GetVisible (return control status flag) .................................................................431
Init (initialize the WebMenubarClass object) ......................................................432
408 IBC LIBRARY REFERENCE

WebToolbarClass Methods 433

WebAreaClassConcepts

The WebAreaClass is the foundation for several derived classes

(WebCaptionClass, WebMenubarClass, WebToolbarClass, and
WebClientAreaClass). The derived class objects implement areas or sections
of a Web page that correspond to specific areas of a Clarion WINDOW or
APPLICATION.

Some of the WebAreaClass objects directly correspond to WINDOW

controls; for example, the WebToolbarClass represents a TOOLBAR and the
WebMenubarClass represents a MENUBAR. However, the other
WebAreaClass objects represent pseudo-controls. These are discrete portions
of the WINDOW, such as the titlebar and the client area, that are not separate
Clarion controls, but are more easily handled as separate controls within the
Web page context.

Relationship toOther Internet Builder Classes

WebControlClass

The WebAreaClass is derived from the WebControlClass. Therefore, its

derived class objects are WebControlClass objects—plus a little more. Their
purpose is to generate HTML/JavaScript to implement Web page
components that look and act like their corresponding Windows window
components.

Derived Classes

WebCaptionClass, WebMenubarClass, WebToolbarClass, and

WebClientAreaClass are derived from WebAreaClass.
410 IBC LIBRARY REFERENCE

Internet ConnectTemplate Implementation

The WebWindowClass creates and manages instances of the classes derived

from the WebAreaClass as needed to generate HTML for each area of the
WINDOW. Therefore, the template generated code does not directly
reference WebAreaClass objects, or its derived class objects.

SourceFiles

The WebAreaClass source code is installed by default to the \LIBSRC folder.

The WebAreaClass declarations are in the following .INC files. The
corresponding method definitions are in the corresponding .CLW file.

[Link] WebAreaClass
WebCaptionClass
WebMenubarClass
WebToolbarClass
WebClientAreaClass
CHAPTER 10 WEBAREACLASS 411

WebAreaClass Proper ties

The WebAreaClass inherits all the properties of the WebControlClass from
which it is derived.

In addition to (or instead of) the inherited properties, the WebAreaClass

contains the properties listed below.

Background(areabackgroundcolor)
Background LONG(COLOR:None)
The Background property indicates the background color of the Web page
area.

Implementation: The SetBackground method sets the value of the Background property.

SeeAlso: SetBackground

BackImage(areawallpaper)
BackImage ANY
The BackImage property indicates the background image (wallpaper) to
apply to the Web page area.

Implementation: The SetBackground method sets the value of the BackImage property.

SeeAlso: SetBackground

LocalFont (areafont information)

LocalFont &HtmlFontClass
The LocalFont property contains the area’s font information for use by
methods such as PushFont, PopFont, and SetFont. The font information
includes the typeface, size, color, and style.

Controls within the area inherit the area’s font information, unless
specifically overridden by the control.

SeeAlso: GetFont, PushFont, SetFont, [Link]

412 IBC LIBRARY REFERENCE

WebAreaClass Methods
The WebAreaClass inherits all the methods of the WebControlClass from
which it is derived.

In addition to (or instead of) the inherited methods, the WebAreaClass

contains the methods listed below.
GetBackgroundColor (return backgroundcolor)
GetBackgroundColor( [default color] ), LONG, VIRTUAL

GetBackgroundColor
Returns the background color of the Web page area.
default color An integer variable, constant, EQUATE, or expression
containing the color to return if there is no background
color. If omitted, default color defaults to Color:None.
The GetBackgroundColor method returns the background color of the Web
page area.

GetBackgroundColor is a VIRTUAL method so that other base class

methods can directly call the GetBackgroundColor virtual method in a
derived class. This lets you easily implement your own custom version of
this method.

Implementation: The GetBackgroundColor method returns the COLOR attribute of the

WINDOW control, if there is one. Otherwise, it returns the background color
inherited from the Web page. EQUATEs for the default color parameter are
declared in \LIBSRC\[Link].

The CreateColorParameters method calls GetBackgroundColor.

Return DataType: LONG

SeeAlso: CreateColorParameters
CHAPTER 10 WEBAREACLASS 413

GetCellAttributes(return areaattributes)
GetCellAttributes( html object ), STRING, VIRTUAL

GetCellAttributes Returns attributes associated with the Web page area.

html object The label of the HtmlClass object that writes the HTML
code.
The GetCellAttributes method returns attributes associated with the Web
page area or control. If there are no associated attributes, GetCellAttributes
returns a null string.

GetCellAttributes is a VIRTUAL method so that other base class methods

can directly call the GetCellAttributes virtual method in a derived class. This
lets you easily implement your own custom version of this method.

Implementation: The GetCellAttributes method returns a text string containing the HTML
definition of the area’s background color, background image (wallpaper) and
font information.

The [Link] method calls the GetCellAttributes

method.

Return DataType: STRING

Example:
[Link] PROCEDURE(*HtmlClass Target)

CurCell &LayoutCellClass,AUTO
Index SIGNED,AUTO
NumRows SIGNED,AUTO
Xindex SIGNED,AUTO
Yindex SIGNED,AUTO

SeeAlso: [Link]
414 IBC LIBRARY REFERENCE

GetFont (add font information)

GetFont( font object )

GetFont Adds the control’s font information to the font object.

font object The label of the HtmlFontClass object that manages font
information.
The GetFont method adds the control’s font information to the font object
for subsequent use by other methods such as
[Link]. The font information includes the
typeface, size, color, and style.

Implementation: The GetFont method returns the values in the LocalFont property.

Example:
[Link] PROCEDURE(*HtmlClass Target)
CurFont HtmlFontClass
!procedure data
CODE
[Link](Target)
[Link]([Link],[Link](),Width,Height)
[Link](CurFont)
[Link](CurFont)
[Link]
[Link](Target)

SeeAlso: LocalFont
CHAPTER 10 WEBAREACLASS 415

GetVisible (return control statusflag)

GetVisible, BYTE, VIRTUAL
The GetVisible method returns a value indicating whether the area should
appear on the Web page. A return value of one (1) indicates the area should
appear on the Web page; a return value of zero (0) indicates the area should
not appear.

GetVisible is a VIRTUAL method so that other base class methods can

directly call the GetVisible virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: An area may be omitted from the Web page for several reasons: it may be
disabled or hidden, or it may be explicitly omitted. For example, a caption or
toolbar may be explicitly excluded from the Web page. See
[Link] and [Link].

Return DataType: BYTE

Example:
[Link] PROCEDURE(*JslManagerClass Target)

Index SIGNED,AUTO

CODE
LOOP Index = 1 TO RECORDS([Link])
GET([Link], Index)
IF ([Link]())
[Link](Target)
END
END
416 IBC LIBRARY REFERENCE

Init (initialize theWebAreaClassobject)

Init( control number, owner window object ), VIRTUAL

Init Initializes the WebAreaClass object.

control number An integer constant, variable, EQUATE, or expression
containing the control number (field equate). For areas
that have no corresponding control, use any number that
is not already in use.
owner window object
The label of the WebWindowClass object the control
belongs to.
The Init method initializes the WebAreaClass object.

Init is a VIRTUAL method so that other base class methods can directly call
the Init virtual method in a derived class. This lets you easily implement your
own custom version of this method.

Implementation: The Init method sets the initial value of the Background, BackImage, Feq,
OwnerWindow, and ParentFeq properties.

The [Link] method calls the Init method.

Example:
[Link] PROCEDURE(SIGNED Feq, *WebControlClass NewControl)

CODE
ASSERT(~NewControl &= NULL)
[Link](Feq, SELF)
[Link](NewControl)

SeeAlso: Background, BackImage, Feq, OwnerWindow, ParentFeq,

[Link]
CHAPTER 10 WEBAREACLASS 417

Kill (shut down theWebAreaClassobject)

Kill, VIRTUAL
The Kill method frees any memory allocated during the life of the object and
performs any other required termination code.

Kill is a VIRTUAL method so that other base class methods can directly call
the Kill virtual method in a derived class. This lets you easily implement
your own custom version of this method.

SeeAlso: [Link]
418 IBC LIBRARY REFERENCE

PushFont (implement areafont)

PushFont( html object ), VIRTUAL

PushFont Implements the area’s font in the HTML generated for

the area.
html object The label of the HtmlClass object that writes the HTML
code.
The PushFont method implements the area’s font in the HTML generated
for the area. Appropriate use of PushFont and PopFont allow child controls
to correctly inherit or override parent font information. Appropriate use
simply means pairing a call to PushFont with a subsequent call to PopFont.

PushFont is a VIRTUAL method so that other base class methods can

directly call the PopFont virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: If the area has no font information, PushFont implements the WINDOW’s
font information. The PushFont method calls the [Link]
method.

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE
[Link](Target)
[Link](Target, FEQ:Menubar)
[Link](Target)

SeeAlso: [Link]
CHAPTER 10 WEBAREACLASS 419

SetBackground(setWebpageareabackground)
SetBackground( [color] [,image] )

SetBackground Sets the Web page area background color and image.
color An integer constant, variable, EQUATE, or expression
indicating the area color. The area’s child controls inherit
this color unless a specific background color is set for
the control.
image A string constant, variable, EQUATE, or expression
containing a filename. The WebAreaClass object dis-
plays (tiles) the image in the specified file as the back-
ground to the Web page area.
The SetBackground method sets the Web page area background color and
image. Area child controls inherit the background color unless overriden.
Area child controls do not inherit the image.

Implementation: The SetBackground method sets the Background property and the
BackImage property. The GetBackgroundColor method returns the value of
the Background property.

Example:
PrepareProcedure ROUTINE
FilesOpened = True
OPEN(AppFrame)
WindowOpened=True
[Link](WebServer, HtmlManager, AppFrame{PROP:text} & ' (Main)')
[Link] = PROP:above
[Link] = 1
[Link](FEQ:Caption, WebCaption)
[Link](-1, '')
[Link]('', 0, -1)

SeeAlso: Background, BackImage, [Link]

420 IBC LIBRARY REFERENCE

SetFont
SetFont( [typeface] [,size] [,color] [,style] )

SetFont Sets the Web page area font information.

typeface A string constant, variable, EQUATE, or expression
indicating the typeface for text in the Web page area.
The area’s child controls inherit this typeface unless
overridden. If omitted, the browser’s default typeface is
used.
size An integer constant, variable, EQUATE, or expression
indicating the text point size. The area’s child controls
inherit this size unless overridden. If omitted, size
defaults to zero (0).
color An integer constant, variable, EQUATE, or expression
indicating the text color. The area’s child controls inherit
this color unless overridden. If omitted, color defaults to
COLOR:None.
style An integer constant, variable, EQUATE, or expression
indicating the text style, such as bold or italic. The area’s
child controls inherit this style unless overridden. If
omitted, style defaults to zero (0).
The SetFont method sets the Web page area font information, including
typeface, size, color, and style. Area child controls inherit the font
information unless overridden.

When setting font information you should consider whether the typeface you
specify is likely to reside on the Client machine. The Client browser cannot
display a typeface it doesn’t have, but will usually substitute another
typeface.

Implementation: The SetFont method sets the LocalFont property. The PushFont method
implements the font information on the Web page area. The PopFont method
restores pre-PushFont font information.

Example:
[Link] PROCEDURE(SIGNED Feq, *WebWindowBaseClass OwnerWindow)

CODE
[Link](Feq, OwnerWindow)
[Link] = COLOR:Navy
[Link](,,COLOR:White)

SeeAlso: LocalFont, PushFont, [Link]

CHAPTER 10 WEBAREACLASS 421

SetParentDefaults (confirmparent)
SetParentDefaults( potential parent, coordinates ), VIRTUAL

SetParentDefaults Confirms this control’s boundaries fall entirely within

SetParentDefaults is a VIRTUAL method so that other base class methods

can directly call the SetParentDefaults virtual method in a derived class. This
lets you easily implement your own custom version of this method.

Implementation: The SetParentDefaults method does nothing because a Web page area is
never the child of another control. It is always the child of the window.

The coordinates parameter names a GROUP with the same structure as the
Rect GROUP declared in [Link] as follows:
Rect GROUP,TYPE
x SIGNED
y SIGNED
width SIGNED
height SIGNED
END

Example:
[Link] PROCEDURE|
(*WebControlQueue Source, *WebControlClass Other, *Rect ParentPos)

CurIndex SIGNED,AUTO

CODE
LOOP CurIndex = 1 TO RECORDS(Source)
GET(Source, CurIndex)
[Link](Other, ParentPos)
END

SeeAlso: [Link]
422 IBC LIBRARY REFERENCE

WebCaptionClass Proper ties

The WebCaptionClass inherits all the properties of the WebAreaClass from
which it is derived.

In addition to (or instead of) the inherited properties, the WebCaptionClass

contains the properties listed below.

Alignment (text justification)

Alignment SIGNED
The Alignment property indicates how to horizontally align or justify the
caption area text. The WebCaptionClass object uses this property to generate
HTML to properly position the caption text.

The Alignment property defaults to zero(0) which results in centered text.

Implementation: EQUATEs for the Alignment property are declared in [Link] as

follows.
PROP:center EQUATE(7C06H)
PROP:left EQUATE(7C08H)
PROP:right EQUATE(7C0CH)
CHAPTER 10 WEBCAPTIONCLASS 423

WebCaptionClass Methods
The WebCaptionClass inherits all the methods of the WebAreaClass from
which it is derived.

In addition to (or instead of) the inherited methods, the WebCaptionClass

contains the methods listed below.

CreateHtml (write HTMLfor captionandits attributes)

CreateHtml( html object ), VIRTUAL

CreateHtml Writes the HTML code representing the titlebar and its
attributes.
html object The label of the HtmlClass object that writes the HTML
code.
The CreateHtml method writes the HTML code representing the titlebar
and its attributes.

CreateHtml is a VIRTUAL method so that other base class methods can

directly call the CreateHtml virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: Attributes include text, font information, and text alignment.

The [Link] method calls the

[Link] method.

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE
[Link](Target)
[Link]
[Link]([Link]())
[Link]
[Link](Target)

SeeAlso: [Link]
424 IBC LIBRARY REFERENCE

GetCellAttributes(return captionattributes)
GetCellAttributes( html object ), STRING, VIRTUAL

GetCellAttributes Returns HTML to set any attributes associated with the

Web page caption.
html object The label of the HtmlClass object that writes the HTML
code.
The GetCellAttributes method returns HTML to set any attributes
associated with the Web page caption.

GetCellAttributes is a VIRTUAL method so that other base class methods

can directly call the GetCellAttributes virtual method in a derived class. This
lets you easily implement your own custom version of this method.

Implementation: The GetCellAttributes method returns the HTML specifying text alignment,
plus any attributes inherited from the WINDOW.

The [Link] method calls the GetCellAttributes

method.

Return DataType: STRING

Example:
[Link] PROCEDURE(*HtmlClass Target)

CurCell &LayoutCellClass,AUTO
Index SIGNED,AUTO
NumRows SIGNED,AUTO
Xindex SIGNED,AUTO
Yindex SIGNED,AUTO

SeeAlso: [Link]
CHAPTER 10 WEBCAPTIONCLASS 425

GetPosition(get control coordinates)

GetPosition( x, y, width, height ), VIRTUAL

GetPosition Returns the caption’s Web page coordinates.

x A numeric variable to receive the control’s horizontal
position.
y A numeric variable to receive the control’s vertical
position.
width A numeric variable to receive the control’s width.
height A numeric variable to receive the control’s height.
The GetPosition method returns the caption’s Web page coordinates. The
LayoutHtmlClass uses this information to position the caption on the Web
page.

GetPosition is a VIRTUAL method so that other base class methods can

directly call the GetPosition virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Example:
[Link] PROCEDURE(*HtmlItemClass NewItem)

CurCell &LayoutCellClass,AUTO
dx SIGNED,AUTO
dy SIGNED,AUTO
x SIGNED,AUTO
y SIGNED,AUTO
Xpos SIGNED,AUTO
Ypos SIGNED,AUTO
IsNew BYTE,AUTO
CODE
[Link](x, y, dx, dy)
Ypos = [Link](y, dy, IsNew, [Link])
IF (IsNew) THEN [Link](Ypos).
Xpos = [Link](x, dx, IsNew, [Link])
IF (IsNew) THEN [Link](Xpos).
CurCell &= [Link](Xpos, Ypos)
[Link] &= NewItem
ADD([Link])
IF (dx > [Link])
[Link] = dx;
END
IF (dy > [Link])
[Link] = dy;
END
426 IBC LIBRARY REFERENCE

GetText (return captiontext)

GetText, STRING, VIRTUAL
The GetText method returns the caption text.

GetText is a VIRTUAL method so that other base class methods can directly
call the GetText virtual method in a derived class. This lets you easily
implement your own custom version of this method.

Implementation: The GetQuotedText method calls the GetText method to retrieve the text.
GetText returns PROP:Text for the WINDOW.

Return DataType: STRING

Example:
[Link] FUNCTION
CODE
RETURN IC:QuoteText([Link](), IC:RESET:Text)

SeeAlso: GetHasHotKey, GetQuotedText

CHAPTER 10 WEBCAPTIONCLASS 427

GetVisible (return control statusflag)

GetVisible, BYTE, VIRTUAL
The GetVisible method returns a value indicating whether the caption should
appear on the Web page. A return value of one (1) indicates the caption
should appear on the Web page; a return value of zero (0) indicates the
caption should not appear.

GetVisible is a VIRTUAL method so that other base class methods can

directly call the GetVisible virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: GetVisible returns one (1) if the WINDOW has titlebar text; zero (0) if it has
no titlebar text.

Return DataType: BYTE

Example:
[Link] PROCEDURE(*JslManagerClass Target)

Index SIGNED,AUTO

CODE
LOOP Index = 1 TO RECORDS([Link])
GET([Link], Index)
IF ([Link]())
[Link](Target)
END
END
428 IBC LIBRARY REFERENCE

Init (initialize theWebCaptionClassobject)

Init( control number, owner window object ), VIRTUAL

Init Initializes the WebCaptionClass object.

control number An integer constant, variable, EQUATE, or expression
containing the control number (field equate). Since the
caption has no control number, you can use any number
that is not already in use.
owner window object
The label of the WebWindowClass object the caption
belongs to.
The Init method initializes the WebCaptionClass object.

Init is a VIRTUAL method so that other base class methods can directly call
the Init virtual method in a derived class. This lets you easily implement your
own custom version of this method.

Implementation: The Init method calls the [Link] method, then sets the initial
value of the Background property.

The [Link] method calls the Init method.

Example:
[Link] PROCEDURE(SIGNED Feq, *WebControlClass NewControl)

CODE
ASSERT(~NewControl &= NULL)
[Link](Feq, SELF)
[Link](NewControl)

SeeAlso: Background, [Link], [Link]

CHAPTER 10 WEBMENUBARCLASS 429

WebMenubarClass Methods
The WebMenubarClass inherits all the methods of the WebAreaClass from
which it is derived.

In addition to (or instead of) the inherited methods, the WebMenubarClass

contains the methods listed below.

CreateHtml (write HTMLformenubar andits children)

CreateHtml( html object ), VIRTUAL

CreateHtml Writes the HTML code representing the MENUBAR

and its children.
html object The label of the HtmlClass object that writes the HTML
code.
The CreateHtml method writes the HTML code representing the
MENUBAR and its children.

CreateHtml is a VIRTUAL method so that other base class methods can

directly call the CreateHtml virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The [Link] method calls the

[Link] method.

The CreateHtml method calls the [Link]

method to write HTML for its children (MENU and ITEM controls).

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE
[Link](Target)
[Link](Target, FEQ:Menubar)
[Link](Target)

SeeAlso: [Link], [Link]

430 IBC LIBRARY REFERENCE

GetPosition(get control coordinates)

GetPosition( x, y, width, height ), VIRTUAL

GetPosition Returns the menubar’s Web page coordinates.

x A numeric variable to receive the control’s horizontal
position.
y A numeric variable to receive the control’s vertical
position.
width A numeric variable to receive the control’s width.
height A numeric variable to receive the control’s height.
The GetPosition method returns the menubar’s Web page coordinates. The
LayoutHtmlClass uses this information to position the menubar on the Web
page.

GetPosition is a VIRTUAL method so that other base class methods can

directly call the GetPosition virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Example:
[Link] PROCEDURE(*HtmlItemClass NewItem)

GetVisible (return control statusflag)

GetVisible, BYTE, VIRTUAL
The GetVisible method returns a value indicating whether the menubar
should appear on the Web page. A return value of one (1) indicates the
menubar should appear on the Web page; a return value of zero (0) indicates
the menubar should not appear.

GetVisible is a VIRTUAL method so that other base class methods can

directly call the GetVisible virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: GetVisible calls the [Link] method.

Return DataType: BYTE

Example:
[Link] PROCEDURE(*JslManagerClass Target)

Index SIGNED,AUTO

CODE
LOOP Index = 1 TO RECORDS([Link])
GET([Link], Index)
IF ([Link]())
[Link](Target)
END
END

SeeAlso: [Link]
432 IBC LIBRARY REFERENCE

Init (initialize theWebMenubarClassobject)

Init( control number, owner window object ), VIRTUAL

Init Initializes the WebMenubarClass object.

control number An integer constant, variable, EQUATE, or expression
containing the control number (field equate). Since the
caption has no control number, you can use any number
that is not already in use.
owner window object
The label of the WebWindowClass object the menubar
belongs to.
The Init method initializes the WebMenubarClass object.

Init is a VIRTUAL method so that other base class methods can directly call
the Init virtual method in a derived class. This lets you easily implement your
own custom version of this method.

Implementation: The Init method calls the [Link] method, then sets the initial
value of the Background property.

The [Link] method calls the Init method.

Example:
[Link] PROCEDURE(SIGNED Feq, *WebControlClass NewControl)

CODE
ASSERT(~NewControl &= NULL)
[Link](Feq, SELF)
[Link](NewControl)

SeeAlso: Background, [Link], [Link]

CHAPTER 10 WEBTOOLBARCLASS 433

WebToolbarClass Methods
The WebToolbarClass inherits all the methods of the WebAreaClass from
which it is derived.

In addition to (or instead of) the inherited methods, the WebToolbarClass

contains the methods listed below.

CreateHtml (write HTMLfor toolbar andits children)

CreateHtml( html object ), VIRTUAL

CreateHtml Writes the HTML code representing the TOOLBAR and

its children.
html object The label of the HtmlClass object that writes the HTML
code.
The CreateHtml method writes the HTML code representing the
TOOLBAR and its children.

CreateHtml is a VIRTUAL method so that other base class methods can

directly call the CreateHtml virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The [Link] method calls the

[Link] method.

The CreateHtml method calls the [Link]

method to write HTML for its child controls.

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE
[Link](Target)
[Link](Target, FEQ:Toolbar)
[Link](Target)

SeeAlso: [Link], [Link]

434 IBC LIBRARY REFERENCE

GetAppletType(return applet type)

GetAppletType, STRING, VIRTUAL
The GetAppletType method returns the applet type for the TOOLBAR
control. The type corresponds to an applet defined in the Java Support
Library. See Jsl Manager Class for more information on the Java Support
Library.

GetAppletType is a VIRTUAL method so that other base class methods can

directly call the GetAppletType virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: The GetAppletType method returns 'ClarionContainer.'

Return DataType: STRING

Example:
[Link] PROCEDURE(*HtmlClass Target)
CurFont HtmlFontClass
!procedure data
CODE
[Link](Target)
[Link]([Link],[Link](),Width,Height)
[Link](CurFont)
[Link](CurFont)
[Link]
[Link](Target)
CHAPTER 10 WEBTOOLBARCLASS 435

GetPosition(get control coordinates)

GetPosition( x, y, width, height ), VIRTUAL

GetPosition Returns the toolbar’s Web page coordinates.

x A numeric variable to receive the control’s horizontal
position.
y A numeric variable to receive the control’s vertical
position.
width A numeric variable to receive the control’s width.
height A numeric variable to receive the control’s height.
The GetPosition method returns the toolbar’s Web page coordinates. The
LayoutHtmlClass uses this information to position the toolbar on the Web
page.

GetPosition is a VIRTUAL method so that other base class methods can

directly call the GetPosition virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Example:
[Link] PROCEDURE(*HtmlItemClass NewItem)

GetVisible (return control statusflag)

GetVisible, BYTE, VIRTUAL
The GetVisible method returns a value indicating whether the toolbar should
appear on the Web page. A return value of one (1) indicates the toolbar
should appear on the Web page; a return value of zero (0) indicates the
toolbar should not appear.

GetVisible is a VIRTUAL method so that other base class methods can

directly call the GetVisible virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: GetVisible calls the [Link] method.

Return DataType: BYTE

Example:
[Link] PROCEDURE(*JslManagerClass Target)

Index SIGNED,AUTO

CODE
LOOP Index = 1 TO RECORDS([Link])
GET([Link], Index)
IF ([Link]())
[Link](Target)
END
END

SeeAlso: [Link]
CHAPTER 10 WEBCLIENTAREACLASS 437

WebClientAreaClass Methods
The WebClientAreaClass inherits all the methods of the WebAreaClass from
which it is derived.

In addition to (or instead of) the inherited methods, the WebClientAreaClass

contains the methods listed below.

CreateHtml (write HTMLforclient areaandits children)

CreateHtml( html object ), VIRTUAL

CreateHtml Writes the HTML code representing the client area and
its children.
html object The label of the HtmlClass object that writes the HTML
code.
The CreateHtml method writes the HTML code representing the client area
and its children.

CreateHtml is a VIRTUAL method so that other base class methods can

directly call the CreateHtml virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The [Link] method calls the

[Link] method.

The CreateHtml method calls the [Link]

method to write HTML for its child controls.

The CreateHtml method creates a special “continue” control for splash

screens. See [Link].

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE
[Link](Target)
[Link](Target, FEQ:Toolbar)
[Link](Target)

SeeAlso: [Link], [Link]

438 IBC LIBRARY REFERENCE

GetBackgroundColor (return backgroundcolor)

GetBackgroundColor( [default color] ), LONG, VIRTUAL

GetBackgroundColor
Returns the background color of the Web page client
area.
default color An integer variable, constant, EQUATE, or expression
containing the color to return if there is no background
color. If omitted, default color defaults to Color:None.
The GetBackgroundColor method returns the background color of the Web
page client area.

GetBackgroundColor is a VIRTUAL method so that other base class

methods can directly call the GetBackgroundColor virtual method in a
derived class. This lets you easily implement your own custom version of
this method.

Implementation: The GetBackgroundColor method returns the COLOR attribute of the

WINDOW control, if there is one. Otherwise, it returns the background color
inherited from the Web page. EQUATEs for the default color parameter are
declared in \LIBSRC\[Link].

The CreateColorParameters method calls GetBackgroundColor.

Return DataType: LONG

SeeAlso: CreateColorParameters
CHAPTER 10 WEBCLIENTAREACLASS 439

GetPosition(get control coordinates)

GetPosition( x, y, width, height ), VIRTUAL

GetPosition Returns the client area’s Web page coordinates.

x A numeric variable to receive the control’s horizontal
position.
y A numeric variable to receive the control’s vertical
position.
width A numeric variable to receive the control’s width.
height A numeric variable to receive the control’s height.
The GetPosition method returns the client area’s Web page coordinates. The
LayoutHtmlClass uses this information to position the client area on the Web
page.

GetPosition is a VIRTUAL method so that other base class methods can

directly call the GetPosition virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Example:
[Link] PROCEDURE(*HtmlItemClass NewItem)

WEB REPORT CLASS

WebReportClassConcepts

The WebReportClass object declares a simple report preview WINDOW. The

window is designed to display the Windows metafiles generated by the
Clarion PREVIEW statement (see the Language Reference for more
information).

The WebReportClass uses the other IBC Library objects to “translate” this
window, including the report preview images, to HTML, and to send the
generated HTML to the Client browser for viewing.

Relationship toOther Internet Builder Classes

The WebReportClass uses the WebServerClass, the WebWindowClass, the

WebControlClass, and the HtmlClass. Therefore, if your program uses the
WebReportClass, it also needs these other classes. However, the
WebReportClass object instantiates most of these other objects as needed
when you include the WebReportClass header file ([Link]) in your
program.

The WebReportClass does not instantiate its own WebServerClass or

HtmlClass objects.

Internet ConnectTemplate Implementation

The Internet Connect Templates generate standard report preview code (the
ReportPreview PROCEDURE) into the appna_SF.CLW file. All Clarion
template generated reports use this ReportPreview procedure to preview
reports.

The ReportPreview procedure instantiates a WebReportClass object called

HtmlPreview. If the Server application was launched by the Application
Broker, then the ReportPreview procedure initializes, runs, and shuts down
the HtmlPreview object instead of running the Windows report preview code.

The HtmlPreview object uses the global template incarnations of the

WebServerClass (WebServer) and the HtmlClass (HtmlManager).
444 IBC LIBRARY REFERENCE

SourceFiles

The WebReportClass source code is installed by default to the \LIBSRC

folder. The source files and their components are as follows:

[Link] WebReportClass class declarations

[Link] WebReportClass method definitions

[Link] WebReportClass translation strings

CHAPTER 11 WEB REPORT CLASS 445

WebRepor tClass Proper ties

The WebReportClass contains the properties listed below.

Html (HtmlClassobject)
Html &HtmlClass
The Html property is a reference to the HtmlClass object that generates the
HTML code that represents the report. The WebReportClass uses this
property to generate HTML code.

Implementation: The Init method sets the value of the Html property—typically to reference a
global instance of the HtmlClass.

SeeAlso: Init

Q (report imagefilesto preview)

Q &QUEUE, PROTECTED
The Q property is a reference to a structure containing information about the
report image files to preview. The WebReportClass uses this property to
reference the files.

This property is PROTECTED, therefore, it can only be referenced by a

WebReportClass method, or a method in a class derived from
WebReportClass.

Implementation: The Init method sets the value of the Q property.

The Q property is a reference to a QUEUE containing the pathnames, less

the .wmf file extension, of the Windows metafiles to preview. The metafiles
are typically generated by the PREVIEW statement (see the Language
Reference for more information), one for each report page.

SeeAlso: Init
446 IBC LIBRARY REFERENCE

NumPages (report page count)

NumPages SIGNED, PROTECTED
The NumPages property contains the number of report pages (the number of
metafiles) to review. The WebReporClass object uses this property to show
the end user how many report pages are available, and to control page
scrolling.

This property is PROTECTED, therefore, it can only be referenced by a

WebReportClass method, or a method in a class derived from
WebReportClass.

Implementation: The SetNumPages method sets the value of the NumPages property.

SeeAlso: NumPages

Server (WebServerClassobject)
Server &WebServerClass
The Server property is a reference to the WebServerClass object that
represents the Server application for the WebReportClass object. The
WebReportClass relies on this property to supply information about the
Client browser, to supply appropriate pathnames, to handle events
originating from the Client browser, and to interact with the BrokerClass
object as needed.

Implementation: The Init method sets the value of the Server property—typically to reference
a global instance of the WebServerClass.

SeeAlso: Init
CHAPTER 11 WEB REPORT CLASS 447

WebRepor tClass Methods

The WebReportClass contains the methods listed below.

Init (initialize theWebReportClassobject)

Init( server, html, previewQ )

Init Initializes the WebReportClass object.

server The label of the WebServerClass object that represents
the Sever (your Web-enabled application).
html The label of the HtmlClass object that writes the HTML
code representing the report pages.
previewQ The label of a QUEUE or a field in a QUEUE that
contains the names of the Windows metafiles for which
to generate Web pages.
The Init method initializes the WebReportClass object.

Implementation: The Init method sets the initial values of the WebReportClass properties.

SeeAlso: Html, Q, Server

Kill (shut down theWebReportClassobject)

Kill, VIRTUAL
The Kill method is only a virtual placeholder method to free any memory
allocated during the life of the object and perform any other required
termination code.

Preview(sendreport pagesto client browser)

Preview, VIRTUAL
The Preview method generates and transmits the HTML representing the
report page requested by the Client browser.

Preview is a VIRTUAL method so that other base class methods can directly
call the Preview virtual method in a derived class. This lets you easily
implement your own custom version of this method.

Implementation: The Preview class uses the Internet Connect window handling technology to
display the report to the end user as a series of print preview windows within
the Client browser.

The Preview method declares a basic report preview WINDOW, then uses
the WebWindowClass to manage an iterative report preview session with the
Client browser. That is, the Preview method sends HTML representing the
initial print preview window, containing the first report page, to the Client
browser. Then it accepts and processes any browser requests for additional
report pages, by refreshing the print preview window and sending HTML to
represent the refreshed window to the Client browser.

With the Preview method, the end user can only manipulate and print the
report as a series of individual pages.

SetNumPages(set maximum report pagecount)

SetNumPages( [number] ), VIRTUAL

SetNumPages Sets the maximum previewable page count.

number The maximum number of pages to preview. If omitted,
number defaults to zero (0).
The SetNumPages method sets the maximum previewable page count.

SetNumPages is a VIRTUAL method so that other base class methods can

directly call the SetNumPages virtual method in a derived class. This lets you
easily implement your own custom version of this method.
CHAPTER 12 JSL MANAGER CLASS 449

JSL MANAGER CLASS

Overview 451
JSLManagerClass Concepts ............................................................................... 451
Relationship to Other Internet Builder Classes ................................................... 452
Internet Connect Template Implementation .........................................................452
Source Files..........................................................................................................452
JSLManagerClass Properties 453
Client (WebClientManagerClass object) ............................................................ 453
Files (WebFilesClass object) .............................................................................. 453
Security (secure or public communication) .........................................................454
Target (TextOutputClass object) ......................................................................... 454
JSLManagerClass Methods 455
Functional Organization—Expected Use ............................................................455
AddQueueEntry (add a Java list row) ..................................................................456
BeginUpdate (write JSL data delimiters).............................................................457
CloseChannel (close output channel and notify Client) ..................................... 458
Init (initialize the JSLManagerClass object) ...................................................... 459
Kill (shut down the JSLManagerClass object) ....................................................459
OpenChannel (open channel for JSL data) ......................................................... 460
RemoveAllQueueEntries (delete all Java list rows).............................................462
RemoveQueueEntries (delete Java list rows).......................................................463
ScrollQueueDown (scroll Java list down)............................................................464
ScrollQueueUp (scroll Java list up) .................................................................... 465
SelectControl (set Java control to update) ...........................................................466
SetAttribute (set Java control attribute—string) ..................................................467
SetAttributeFilename (set Java control attribute—pathname) ............................ 468
SetAttributeLong (set Java control attribute—number).......................................469
SetChecked (set Java check box status) .............................................................. 470
SetIconAttribute (display icon in Java list) ..........................................................471
SetListChoice (highlight HTML list row) .......................................................... 472
SetQueueEntry (replace a Java list row) .................................................................473
SetValue (set Java control contents) .....................................................................474
450 IBC LIBRARY REFERENCE
CHAPTER 12 JSL MANAGER CLASS 451

JSLManagerClassConcepts

Java Support Library (JSL)

SoftVelocity provides the Java Support Library as part of the Internet

Connect product. This library of Java objects resides on the Client computer.
These Java objects must reside on the Client computer because the HTML
code generated by your Web-enabled application relies on them. All Clarion
Web-enabled applications share this single library.

The Java Support Library is very small and is automatically downloaded to

the client computer as needed. The Client’s browser and its caching options
determine how the library is downloaded.

Some browsers download the entire library the first time the Client runs a
Clarion Web-enabled application. Other browsers download individual
library components as they are needed while running the Web-enabled
application. In either case, the browsers generally cache the library (store it
locally), and do not download it again unless the library is updated.

Many browsers let the end user set caching options which may affect Java
Support Library downloads. For example, some browsers support a no
caching option (not recommended), and many browsers also let you specify
how often to check for newer versions of cached items—from never, to once-
per-session, to every access.

Efficient Partial Page Updates

The JSLManagerClass generates protocol and data for the Java Support
Library objects on the Client computer. The JSLManagerClass provides
methods that dynamically update some of the contents of an HTML page
without refreshing the entire page in the browser. In other words, it does very
efficient partial page updates over the internet. The JSLManagerClass
accomplishes partial page updates by sending data (JSL data) only to the
Java applets executing on the Client. The generated HTML page references
the Java applets so they can refresh the browser’s display without redrawing
the entire page.
452 IBC LIBRARY REFERENCE

Relationship toOther Internet Builder Classes

The WebClientManagerClass creates and manages a single

JSLManagerClass object. The WebControlClass then uses the
JSLManagerClass to do the partial updates.

Internet ConnectTemplate Implementation

The WebClientManagerClass creates and manages a single

JSLManagerClass object. Therefore the template generated code does not
directly reference the JSLManagerClass object.

SourceFiles

The JSLManagerClass source code is installed by default to the \LIBSRC

folder. The specific class declarations reside in the following files and their
method definitions reside in the corresponding .CLW files.

[Link] JSLManagerClass
CHAPTER 12 JSL MANAGER CLASS 453

JSLManagerClass Proper ties

The JSLManagerClass contains the properties listed below.

Client (WebClientManagerClassobject)
Client &WebClientManagerInterface, PROTECTED
The Client property is a reference to the WebClientManagerClass object that
represents the Client computer. The JSLManagerClass uses the Client
property to notify the WebClientManagerClass object when JSL data is ready
for transmittal to the Client computer.

This property is PROTECTED, therefore, it can only be referenced by a

JSLManagerClass method, or a method in a class derived from
JSLManagerClass.

Implementation: The Init method sets the value of the Client property.

SeeAlso: Init

Files(WebFilesClassobject)
Files &WebFilesClass, PROTECTED
The Files property is a reference to the WebFilesClass object that manages
directories, pathnames, temporary files, aliases, etcl for the
JSLManagerClass object. The JSLManagerClass uses the Files property to
provide appropriate pathnames for its files.

This property is PROTECTED, therefore, it can only be referenced by a

JSLManagerClass method, or a method in a class derived from
JSLManagerClass.

Implementation: The OpenChannel method sets the value of the Files property.

SeeAlso: OpenChannel
454 IBC LIBRARY REFERENCE

Security (secure or public communication)

Security SIGNED
The Security property contains a value indicating whether JSL data output
by the JSLManagerClass are transmitted on a public channel or a secure
channel.

There are significant performance penalties associated with secure

communications. Therefore, we recommend using secure communications
only when circumstances demand it.

Implementation: The OpenChannel method sets the value of the Security property. EQUATE
values for the Security property are declared in [Link] as follows:
ITEMIZE,PRE(Secure)
Default EQUATE
None EQUATE
Full EQUATE
Last EQUATE(Secure:Full)
END

SeeAlso: OpenChannel

Target (TextOutputClassobject)
Target &TextOutputClass, PROTECTED
The Target property is a reference to the TextOutputClass object that the
JSLManagerClass uses to write the JSL data used to update the Java
controls/applets. See Text Output Class for more information.

This property is PROTECTED, therefore, it can only be referenced by a

JSLManagerClass method, or a method in a class derived from
JSLManagerClass.

Implementation: The Init method instantiates a NEW TextOuputClass object for the Target
property.

SeeAlso: Init
CHAPTER 12 JSL MANAGER CLASS 455

JSLManagerClass Methods
The JSLManagerClass contains the methods listed below.

Functional Organization—ExpectedUse

As an aid to understanding the JSLManagerClass, it is useful to organize the

various JSLManagerClass methods into two categories according to their
expected use—the primary interface and the virtual methods. This
organization reflects what we believe is typical use of these methods.

Primary Interface Methods

The primary interface methods, which you are likely to call fairly routinely
from your program, can be further divided into three categories:

Housekeeping (one-time) Use:

Init initialize the JSLManagerClass object
OpenChannel open an output channel
CloseChannel finish data output and notify Client
Kill shut down the JSLManagerClass object

Mainstream Use:

Occasional Use:
BeginUpdate write JSL data delimiters
AddQueueEntry add a Java list row
RemoveAllQueueEntries delete all Java list rows
RemoveQueueEntries delete Java list rows
ScrollQueueDown scroll Java list down
ScrollQueueUp scroll Java list up
SelectControl set Java control to update
SetAttribute set Java control attribute—string
SetAttributeLong set Java control attribute—number
SetAttributeFilename set Java control attribute—pathname
SetChecked set Java check box status
SetIconAttribute display icon in Java list
SetListChoice highlight Java list row
SetQueueEntry replace a Java list row
SetValue set Java control contents

Virtual Methods

The JSLManagerClass has no virtual methods.

456 IBC LIBRARY REFERENCE

AddQueueEntry (add a Java list row)

AddQueueEntry( control, position [,format] )

AddQueueEntry Adds a row to a Java list.

control An integer constant, variable, EQUATE, or expression
containing the control number of the Clarion control that
is the data source for the Java list. This is the Clarion
field equate number.
position An integer constant, variable, EQUATE, or expression
containing the row number from the control to add.
format An integer constant, variable, EQUATE, or expression
containing ... If omitted, format defaults to zero (0).
The AddQueueEntry method adds a new row to the Java list.

The control parameter identifies the Clarion control that is the data source
for the new Java list row. The position parameter identifies the specific row
to add to the Java list.

The SelectControl method sets the target Java list to update.

Example:
[Link] PROCEDURE(*JslManagerClass Target)
!procedure data
CODE
!procedure code
NumActions = RECORDS([Link])
LOOP CurAction = 1 TO NumActions
GET([Link], CurAction)
NumActionItems = [Link]
CASE ([Link])
OF ACTION:Insert
LOOP CurRecord = 1 TO NumActionItems
[Link](CurFeq,[Link]+(CurRecord-1),[Link])
END
OF ACTION:Replace
LOOP CurRecord = 1 TO NumActionItems
[Link](CurFeq,[Link]+(CurRecord-1),[Link])
END
OF ACTION:Delete
[Link]([Link], NumActionItems)
OF ACTION:DeleteAll
[Link]
END
END
!procedure code

SeeAlso: SelectControl
CHAPTER 12 JSL MANAGER CLASS 457

BeginUpdate (write JSLdata delimiters)

BeginUpdate( applet )

BeginUpdate Writes JSL data delimiters to indicate a new control is

being addressed.
applet An integer constant, variable, EQUATE, or expression
containing the control/applet number to update as set by
the SelectControl method; it is not the Clarion field
equate number.
The BeginUpdate method writes appropriate Java Support Library protocol
delimiters to identify which applet is being addressed in the generated JSL
data. The BeginUpdate method determines whether the generated data
applies to a new control/applet, and writes any necessary delimiters to “end”
one control and “begin” another.

Example:
[Link] PROCEDURE(BYTE Which)

CODE
[Link]([Link])
[Link](CHR(Which))

SeeAlso: SelectControl
458 IBC LIBRARY REFERENCE

CloseChannel (closeoutput channel andnotify Client)

CloseChannel
The CloseChannel method writes end-of-control and end-of-code
delimiters, then closes the output channel. Finally, the CloseChannel method
notifies the Client (property) that the JSL data is complete and ready for
further processing.

Implementation: When the CloseChannel method notifies the WebClientManagerClass object

that the JSL data is complete, the WebClientManagerClass object then
notifies the BrokerClass object. The BrokerClass object supplies an
appropriate Http header for the JSL data, then notifies the Application Broker
that the JSL data is ready for transmittal to the Client computer.

The [Link] method opens and closes the channel

as needed to generate JSL data for its window.

Example:
[Link] PROCEDURE
Client &WebClientManagerClass
CODE
Client &= [Link]
[Link]([Link]())
IF ([Link]() OR NOT [Link])
!generate whole HTML page
ELSE
[Link]([Link](),[Link])
[Link]([Link])
[Link]
END
[Link]()

SeeAlso: Client, [Link]

CHAPTER 12 JSL MANAGER CLASS 459

Init (initialize theJSLManagerClassobject)

Init( client )

Init Initializes the JSLManagerClass object.

client The label of the WebClientManagerClass object that has
requested data.
The Init method initializes the JSLManagerClass object.

Implementation: The Init method sets the Client property to reference the client and
instantiates a NEW TextOutputClass object for the Target property.

Example:
[Link] PROCEDURE |
(*WebDataSinkClass Broker,*BrowserManagerClass Browser)
CODE
[Link] &= NEW JslManagerClass
[Link](SELF)
[Link] &= Broker
[Link] &= Browser

SeeAlso: Client, Target

Kill (shut down theJSLManagerClassobject)

Kill
The Kill method frees any memory allocated during the life of the object and
does any other required termination code.

Implementation: The Kill method DISPOSEs the Target property’s TextOutputClass object .

Example:
[Link] PROCEDURE
CODE
IF (NOT [Link] &= NULL)
[Link]
DISPOSE([Link])
END
460 IBC LIBRARY REFERENCE

OpenChannel (openchannel for JSLdata)

OpenChannel( security, files object )

OpenChannel Opens a channel to write data for the Java Support

Library.
security An integer constant, variable, EQUATE, or expression
indicating whether to use a secure channel or a public
channel.
files object The label of the WebFilesClass object that manages
directories, pathnames, etc. for this JSLManagerClass
object.
The OpenChannel method opens a channel to write data for the Java
Support Library (JSL data). The JSL data allows very efficient partial page
updates to Server generated Web pages. The JSL data is applied by the Java
Support Library on the Client computer.

There are significant performance penalties associated with secure

communications. Therefore, we recommend using secure channels only
when circumstances demand them.

Implementation: The OpenChannel method sets the value of the Files property based on the
value of the files object parameter. Other JSLManagerClass methods use the
Files property to provide appropriate pathnames whereever they are needed.

The OpenChannel method sets the value of the Security property based on
the value of the security parameter. EQUATEs for the security parameter are
declared in [Link] as follows:
ITEMIZE,PRE(Secure)
Default EQUATE
None EQUATE
Full EQUATE
Last EQUATE(Secure:Full)
END

The [Link] method opens and closes a “channel”

as needed to generate JSL data for its window.
CHAPTER 12 JSL MANAGER CLASS 461

Example:

[Link] PROCEDURE
Client &WebClientManagerClass
CODE
Client &= [Link]
[Link]([Link]())
IF ([Link]() OR NOT [Link])
!generate whole HTML page
ELSE
[Link]([Link](),[Link])
[Link]([Link])
[Link]
END
[Link]()

SeeAlso: Security, Files, [Link]

462 IBC LIBRARY REFERENCE

RemoveAllQueueEntries(delete all Java list rows)

RemoveAllQueueEntries
The RemoveAllQueueEntries method deletes all the rows from the Java list
control set by the SelectControl method.

SeeAlso: SelectControl
CHAPTER 12 JSL MANAGER CLASS 463

RemoveQueueEntries(delete Java list rows)

RemoveQueueEntries( position, number )

RemoveQueueEntries
Deletes number rows starting from row position from a
Java list control.
position An integer constant, variable, EQUATE, or expression
containing the number of the first row to delete.
number An integer constant, variable, EQUATE, or expression
containing the number of rows to delete.
The RemoveQueueEntries method deletes number rows starting from row
position in the Java list control set by the SelectControl method.

SeeAlso: SelectControl
464 IBC LIBRARY REFERENCE

ScrollQueueDown (scroll Java list down)

ScrollQueueDown( control, number [,format] )

ScrollQueueDown Scrolls a Java list downward number rows.

control An integer constant, variable, EQUATE, or expression
containing the control number of the Clarion control that
is the data source for the Java list. This is the Clarion
field equate number.
number An integer constant, variable, EQUATE, or expression
containing the number of rows to scroll from the current
position.
format An integer constant, variable, EQUATE, or expression
containing ... If omitted, format defaults to zero (0).
The ScrollQueueDown method scrolls a Java list downward number rows.
The control parameter identifies the Clarion control that is the data source
for the Java list.

The SelectControl method sets the list to scroll.

Example:
[Link] PROCEDURE(*JslManagerClass Target)
!procedure data
CODE
!procedure code
NumActions = RECORDS([Link])
LOOP CurAction = 1 TO NumActions
GET([Link], CurAction)
NumActionItems = [Link]
CASE ([Link])
OF ACTION:ScrollUp
LOOP CurRecord = 1 TO NumActionItems
[Link](CurFeq,NumRecords-NumActionItems+CurRecord,[Link])
END
OF ACTION:ScrollDown
LOOP CurRecord = 1 TO NumActionItems
[Link](CurFeq,NumActionItems-(CurRecord-1),[Link])
END
!other actions
END
END
!procedure code

SeeAlso: SelectControl
CHAPTER 12 JSL MANAGER CLASS 465

ScrollQueueUp (scroll Java list up)

ScrollQueueUp( control, number [,format] )

ScrollQueueUp Scrolls a Java list upward number rows.

control An integer constant, variable, EQUATE, or expression
containing the control number of the Clarion control that
is the data source for the Java list. This is the Clarion
field equate number.
number An integer constant, variable, EQUATE, or expression
containing the number of rows to scroll from the current
position.
format An integer constant, variable, EQUATE, or expression
containing ... If omitted, format defaults to zero (0).
The ScrollQueueUp method scrolls a Java list upward number rows. The
control parameter identifies the Clarion control that is the data source for the
Java list.

The SelectControl method sets the list to scroll.

Example:
[Link] PROCEDURE(*JslManagerClass Target)
!procedure data
CODE
!procedure code
NumActions = RECORDS([Link])
LOOP CurAction = 1 TO NumActions
GET([Link], CurAction)
NumActionItems = [Link]
CASE ([Link])
OF ACTION:ScrollUp
LOOP CurRecord = 1 TO NumActionItems
[Link](CurFeq,NumRecords-NumActionItems+CurRecord,[Link])
END
OF ACTION:ScrollDown
LOOP CurRecord = 1 TO NumActionItems
[Link](CurFeq,NumActionItems-(CurRecord-1),[Link])
END
!other actions
END
END
!procedure code

SeeAlso: SelectControl
466 IBC LIBRARY REFERENCE

SelectControl (set Java control to update)

SelectControl( control )

SelectControl Sets the current Java control/applet for other

JSLManagerClass methods.
control An integer constant, variable, EQUATE, or expression
containing the control number of the corresponding
Clarion control. This is the Clarion field equate number.
The SelectControl method sets the current Java control/applet for other
JSLManagerClass methods. Other JSLManagerClass methods generate
protocol and data to update the specified control’s attributes, contents, etc.

Example:
[Link] PROCEDURE(*JslManagerClass Target)
Filename CSTRING(FILE:MaxFileName),AUTO
CODE
Filename = [Link]{PROP:tempimage}
[Link]([Link])
IF ([Link] <> Filename)
[Link](JSL:Picture, Filename)
[Link] = Filename
END
CHAPTER 12 JSL MANAGER CLASS 467

SetAttribute (set Java control attribute—string)

SetAttribute( attribute [, value] )

SetAttribute Sets a Java control attribute.

attribute An integer constant, variable, EQUATE, or expression
indicating which attribute to set.
value A string constant, variable, EQUATE, or expression
containing the value of the attribute. If omitted, the
attribute is Boolean and is toggled from its current
setting to its opposite setting.
The SetAttribute method sets a Java control’s attribute. The SelectControl
method determines the control whose attribute is set.

Implementation: EQUATEs for the attribute parameter are declared in [Link] as follows:
ITEMIZE,PRE(JSL)
ListRecords EQUATE(VAL('R')) !use SetAttributeLong
ListFields EQUATE(VAL('F')) !use SetAttributeLong
ListSelection EQUATE(VAL('S')) !use SetAttributeLong
ListThumb EQUATE(VAL('M')) !use SetAttributeLong
ListHScroll EQUATE(VAL('H')) !use SetAttribute
ListVScroll EQUATE(VAL('V')) !use SetAttribute
ListFormat EQUATE(VAL('A')) !use SetAttribute
ListIcon EQUATE(VAL('I')) !use SetIconAttribute
Picture EQUATE(VAL('P')) !use SetAttributeFilename
Disable EQUATE(VAL('D')) !use SetAttribute
Enable EQUATE(VAL('E')) !use SetAttribute
StringText EQUATE(VAL('T')) !use SetAttribute
END

Example:
[Link] PROCEDURE(*JslManagerClass Target)
CurText ANY
CODE
CurText = [Link]()
IF (CurText <> [Link])
[Link]([Link])
[Link](Jsl:StringText, CurText)
[Link] = CurText
END

SeeAlso: SelectControl
468 IBC LIBRARY REFERENCE

SetAttributeFilename (set Java control attribute—pathname)

SetAttributeFilename( attribute, filename )

SetAttributeFilename
Sets a Java control attribute to contain a pathname.
attribute An integer constant, variable, EQUATE, or expression
indicating which attribute to set.
filename A string constant, variable, EQUATE, or expression
containing only the filename, with no path prepended.
The SetAttributeFilename method sets a Java control’s attribute to contain
a pathname. The pathname consists of the path concatenated to the filename.
The Files property supplies the appropriate path value.

The SelectControl method sets the control whose attribute is set.

SeeAlso: Files, SelectControl

CHAPTER 12 JSL MANAGER CLASS 469

SetAttributeLong(set Java control attribute—number)

SetAttribute( attribute, value )

SetAttribute Sets a Java control attribute.

attribute An integer constant, variable, EQUATE, or expression
indicating which attribute to set.
value An integer constant, variable, EQUATE, or expression
containing the value of the attribute.
The SetAttribute method sets a Java control’s attribute. The SelectControl
method determines the control whose attribute is set.

Example:
[Link] PROCEDURE(*JslManagerClass Target)
!procedure data
CODE
!procedure code
IF (CurFeq{PROP:imm})
[Link](JSL:ListThumb, CurFeq{PROP:vscrollpos})
END
IF ([Link] <> CurFeq{PROP:hscroll})
[Link](JSL:ListHScroll, CurFeq{PROP:hscroll})
END
IF ([Link] <> CurFeq{PROP:vscroll})
[Link](JSL:ListVScroll, CurFeq{PROP:hscroll})
END
!procedure code

SeeAlso: SelectControl
470 IBC LIBRARY REFERENCE

SetChecked(set Java check box status)

SetChecked( control, status )

SetChecked Sets the status of a Java check box.

control An integer constant, variable, EQUATE, or expression
containing the control number of the Clarion control that
corresponds to the Java check box. This is the Clarion
field equate number.
status An integer constant, variable, EQUATE, or expression
indicating whether the box is checked. A value of one
(1) indicates the box is checked; a value of zero (0)
indicates the box is not checked.
The SetChecked method sets the the status of a Java check box. The control
parameter determines which Java check box is set. The status parameter
determines whether or not the box is checked.

Example:
[Link] PROCEDURE(*JslManagerClass Target)

CODE
IF ([Link]())
[Link]([Link], [Link]{PROP:checked})
[Link]
END
CHAPTER 12 JSL MANAGER CLASS 471

SetIconAttribute (display iconin Java list)

SetIconAttribute( row, filename )

SetIconAttribute Sets a Java list icon attribute to contain a pathname.

row An integer constant, variable, EQUATE, or expression
indicating which row displays the specified icon. This is
the Clarion row number.
filename A string constant, variable, EQUATE, or expression
containing the icon filename, with no path prepended.
The SetIconAttribute method sets a Java list’s icon attribute to contain a
pathname. The pathname consists of the path concatenated to the filename.
The Files property supplies the appropriate path value.

The SelectControl method sets the list whose icon attribute is set.

Example:
[Link] PROCEDURE(*JslManagerClass Target)
!procedure data
CODE
!procedure code
IF ([Link])
CurIndex = 0
Skipped = 0
LOOP WHILE (Skipped < 2)
NextIconName = [Link](CurFeq{PROP:iconlist, CurIndex})
IF (NextIconName)
[Link](CurIndex, NextIconName)
Skipped = 0
ELSE
Skipped += 1
END
CurIndex += 1
END
[Link] = FALSE
END

SeeAlso: Files, SelectControl

472 IBC LIBRARY REFERENCE

SetListChoice(highlight HTML list row)

SetListChoice( control, row )

SetListChoice Set an HTML list’s selected attribute.

control An integer constant, variable, EQUATE, or expression
containing the control number of the Clarion control that
is the data source for the Java list. This is the Clarion
field equate number.
row An integer constant, variable, EQUATE, or expression
indicating which row is selected or highlighted. This is
the Clarion row number.
The SetListChoice method sets an HTML list’s selected attribute. The
control paramter determines which list control is updated. The row parameter
determines which row is selected or highlighted.

Example:
[Link] PROCEDURE(*JslManagerClass Target)

CODE
IF ([Link]())
[Link]([Link], CHOICE([Link]))
[Link]
END
CHAPTER 12 JSL MANAGER CLASS 473

SetQueueEntry (replacea Java list row)

SetQueueEntry( control, row [, format] )

SetQueueEntry Replace a Java list row.

control An integer constant, variable, EQUATE, or expression
containing the control number of the Clarion control that
is the data source for the Java list. This is the Clarion
field equate number.
row An integer constant, variable, EQUATE, or expression
indicating the row to replace. This is the Clarion row
number.
format An integer constant, variable, EQUATE, or expression
containing ... If omitted, format defaults to zero (0).
The SetQueueEntry method replaces a row in a Java list. The control
parameter determines which list control is updated. The row parameter
determines which row is replaced.

Example:

SetValue(set Java control contents)

SetValue( control, value )

SetValue Sets a Java control’s contents.

control An integer constant, variable, EQUATE, or expression
containing the control number of the Clarion control that
corresponds to the Java control. This is the Clarion field
equate number.
value A constant, variable, EQUATE, or expression containing
the value to assign to the Java control.
The SetValue method sets a Java control’s contents.

Example:
[Link] PROCEDURE(*JslManagerClass Target)

CODE
IF ([Link]())
[Link]([Link], CONTENTS([Link]))
[Link]
END
CHAPTER 13 JSL EVENTS CLASS 475

JSL EVENTS CLASS

Overview
If you have not already done so, please take a moment to read Internet
Connect Terms and Concepts. This short topic contains information and
terms that are prerequiste to the following material.

JslEventsClassConcepts

The JslEventsClass manages the mapping between Clarion events and Java
Support Library events (JSL events). See JSL Manager Class for more
information on the Java Support Library. This event mapping is primarily
used when handling LISTs. That is, since HTML has no equivalent to a
Clarion LIST and its associated events, Internet Connect relies on a Java list
applet to represent lists and their associated events on a Web page. The
JslEventsClass supports the following standard Clarion events:
EVENT:Accepted

EVENT:Initialize
EVENT:NewSelection
EVENT:AlertKey
EVENT:Locate

EVENT:ScrollTop
EVENT:ScrollBottom
EVENT:PageUp
EVENT:PageDown
EVENT:ScrollUp
EVENT:ScrollDown
EVENT:ScrollDrag

EVENT:Expanding
EVENT:Contracting
EVENT:Expanded
EVENT:Contracted

Typically, your Web-enabled application instantiates a single global

JSLEventsClass object.

Java Support Library

SoftVelocity provides the Java Support Library as part of the Internet

Connect product. This library of Java objects must reside on the client
computer because the HTML code your Web-enabled application generates
relies on these objects. The Java Support Library is very small and is
automatically downloaded to the client computer as needed by the Clarion
Application Broker. (see JSL Manager Class for more information).
478 IBC LIBRARY REFERENCE

Relationship toOther Internet Builder Classes

The SubmitItem class uses the JSLEventsClass to convert Java Support

Library events to standard Clarion event EQUATEs. The WebJavaListClass
uses the JSLEventsClass to set the available events for the Java list applets
that represent Clarion LISTs within the HTML code generated by your Web-
enabled application.

Internet ConnectTemplate Implementation

The Internet Connect Templates generate code to instantiate a single global

JSLEventsClass object for your application program. The JSLEventsClass
object is called JavaEvents. The template code only references the
JavaEvents object to declare it, initialize it, and shut it down. Other IBC
Library objects reference the JavaEvents object as an EXTERNAL.

SourceFiles

The JSLEventsClass source code is installed by default to the \LIBSRC

folder. The specific class declarations reside in the following files and their
method definitions reside in the corresponding .CLW files.

[Link] JSLEventsClass
CHAPTER 13 JSL EVENTS CLASS 479

JslEventsClass Proper ties

The JslEventsClass contains only one property.

EventQ (equivalent ClarionandJSLevents)

EventQ &EventInfoQueue
The EventQ property is a reference to a structure containing a list of Clarion
event EQUATE numbers and their corresponding Java Support Library event
codes. For example, a Clarion EVENT:PageDown maps to JSL event ‘B’,
and a Clarion EVENT:Accepted maps to JSL event ‘X’.

Implementation: The Init method loads the EventQ property by making several calls to the
AddEvent method.

The EventQ property is a reference to QUEUE declared in [Link]

as follows:
EventInfoQueue QUEUE,TYPE
EventNo SIGNED
Letter STRING(1)
END

SeeAlso: AddEvent, Init

480 IBC LIBRARY REFERENCE

JSLEventsClass Methods
The JSLEventsClass contains the methods listed below.

Functional Organization—ExpectedUse

As an aid to understanding the JSLEventsClass, it is useful to organize its

methods into two categories according to their expected use—the primary
interface and the virtual methods. This organization reflects what we believe
is typical use of these methods.

Primary Interface Methods

The primary interface methods, which you are likely to call fairly routinely
from your program, can be further divided into three categories:

Housekeeping (one-time) Use:

Init initialize the JSLEventsClass object
Kill shut down JSLEventsClass object

Mainstream Use:

Occasional Use:
AddEvent add an Clarion/JSL events pair
GetEventNumber returnClarion event number
GetEventString return Clarion-event/Web-action pairs

Virtual Methods

The JSLEventsClass has no virtual methods.

CHAPTER 13 JSL EVENTS CLASS 481

AddEvent (add a Clarion/JSLevent pair)

AddEvent( Clarion event, JSL event )

AddEvent Adds a Clarion/JSL event pair to the EventQ property.

Clarion event An integer constant, variable, EQUATE, or expression
containing the Clarion event number that is equivalent to
the JSL event.
JSL event A string constant, variable, EQUATE, or expression
containing the JSL event value that is equivalent to the
Clarion event.
The AddEvent method adds a Clarion event number and its corresponding
JSL event code to the EventQ property.

Implementation: The AddEvent method adds items to the EventQ property. It sorts the EventQ
by JSL events.

Example:
[Link] PROCEDURE

CODE
[Link] &= NEW EventInfoQueue
[Link](EVENT:ScrollBottom, 'B')
[Link](EVENT:PageDown, 'C')
[Link](EVENT:ScrollDown, 'D')
[Link](EVENT:Expanding, 'E')
[Link](EVENT:Initialize, 'I')
[Link](EVENT:AlertKey, 'K')
[Link](EVENT:Locate, 'L')
[Link](EVENT:Contracting, 'O')
[Link](EVENT:ScrollDrag, 'M')
[Link](EVENT:NewSelection, 'N')
[Link](EVENT:PageUp, 'R')
[Link](EVENT:ScrollTop, 'T')
[Link](EVENT:ScrollUp, 'U')
[Link](EVENT:Accepted, 'X')
[Link](EVENT:Expanded, 'Y')
[Link](EVENT:Contracted, 'Z')

SeeAlso: EventQ
482 IBC LIBRARY REFERENCE

Init (initialize theJSLEventsClassobject)

Init
The Init method initializes the JSLEventsClass object.

Implementation: The Init method allocates a new EventQ property and loads it with the
default event pairs with multiple calls to the AddEvent method.

Example:
Broker BrokerClass
HtmlManager HtmlClass
JavaEvents JslEventsClass !declare JavaEvents object
WebServer WebServerClass
WebFilesManager WebFilesClass

ICServerWin WINDOW,AT(-100,-100,0,0)
END
CODE
SetWebActiveFrame
[Link](1, '')
[Link] !initialize JavaEvents object
[Link]('TREE', WebFilesManager)
[Link](WebFilesManager)
[Link](Broker, '', 600, '', WebFilesManager)
IF ([Link]())
OPEN(ICServerWin)
ACCEPT
IF (EVENT() = EVENT:OpenWindow)
[Link]
WebMain
BREAK
END
END
END
[Link]
[Link]
[Link]()
[Link] !shut down JavaEvents object
[Link]

SeeAlso: AddEvent, EventQ

CHAPTER 13 JSL EVENTS CLASS 483

Kill (shut down JSLEventsClassobject)

Kill
The Kill method frees any memory allocated during the life of the object and
does any other required termination code.

Implementation: The Init method fress the EventQ property.

Example:

Broker BrokerClass
HtmlManager HtmlClass
JavaEvents JslEventsClass !declare JavaEvents object
WebServer WebServerClass
WebFilesManager WebFilesClass

GetEventNumber (returnClarionevent number)

GetEventNumber( JSL events ), SIGNED

GetEventNumber Returns the Clarion event number corresponding to the

specified JSL event.
JSL event A string constant, variable, EQUATE, or expression
containing a JSL event code.
The GetEventNumber method returns the Clarion event number
corresponding to the specified JSL event. The SubmitItem class uses
GetEventNumber to convert JSL event codes to their equivalent Clarion
event numbers.

Implementation: If there is no corresponding event in the EventQ property, GetEventNumber

returns EVENT:Accepted.

Return DataType: SIGNED

Example:
[Link] PROCEDURE(Arguments)
!procedure data
EventNo SIGNED
CODE
!procedure code to set EventPos and EndPos
EventNo = EVENT:Accepted
IF (EventPos < EndPos)
EventNo = [Link](Arguments[EventPos])
END

[Link] = EventNo
ControlId = SUB(Arguments, StartPos, EventPos-StartPos)
[Link] = Arguments[(1):(AssignPos-1)]
[Link] = SUB(Arguments, EventPos+1, AssignPos - (EventPos+1))
[Link] = SUB(Arguments, AssignPos+1, EndPos - (AssignPos+1))
!procedure code

SeeAlso: EventQ, [Link]

CHAPTER 13 JSL EVENTS CLASS 485

GetEventString(return event/actionpairs)
GetEventString( event action queue, default action ), STRING

GetEventString Returns vertical bar (|) delimited event/action pairs.

event action queue The label of a structure that associates Clarion event
numbers with appropriate Web page actions for a
specific control. Typically, this is the
[Link] property.
default action An integer constant, variable, EQUATE, or expression
containing the default action.
The GetEventString method returns a vertical bar (|) delimited event/action
pair for each event in the EventQ property. Typically, the event action queue
contains the developer specified Web page actions for a single list control
(see [Link]).

Implementation: The WebJavaListClass uses the return string as the Events parameter to the
Java list applet when it generates HTML to represent a Clarion LIST.

The return string is of the form ‘E9|E9’ where E is a JSL event code from the
EventQ property and 9 is the corresponding action code. Standard Web page
actions and their codes are represented by EQUATEs declared in
[Link] as follows:
Update:OnBrowser EQUATE(0)
Update:Partial EQUATE(1)
Update:Full EQUATE(2)
Update:Refresh EQUATE(3)

If a JSL event has no corresponding action in the event action queue, then the
JSL event is paired with the default action, typically Update:OnBrowser.

The event action queue parameter must be a QUEUE of the type declared in
[Link] as follows:
EventActionQueue QUEUE,TYPE
EventNo SIGNED
Action BYTE
END

Return DataType: STRING

486 IBC LIBRARY REFERENCE

Example:
[Link] PROCEDURE(*HtmlClass Target)
Properties ANY
CurFont HtmlFontClass
Feq SIGNED,AUTO

CODE
Feq = [Link]
IF (Feq{PROP:column}<>0) THEN Properties = Properties & ',COLUMN'.
IF (Feq{PROP:imm}) THEN Properties = Properties & ',IMM'.
IF (Feq{PROP:vcr}) THEN Properties = Properties & ',VCR'.
[Link](CurFont)

[Link](Target, [Link])
[Link]('formatString', [Link]{PROP:format})
[Link]('Events', |
[Link]([Link], Update:OnBrowser))
[Link]('Properties', SUB(Properties, 2, -1))
IF (([Link] &= NULL) OR ([Link](CurFont)))
[Link](CurFont)
END

SeeAlso: [Link]
CHAPTER 14 WEB FILES CLASS 487

WEB FILES CLASS

WebFilesClassConcepts

Typically your Web-enabled application instantiates a single WebFilesClass

object to manage all the filenames, pathnames, directories, aliases, etc.
referenced during a session.

There are many different types of files that may be referenced during a
session, and the location (pathname) of the files depends on a number of
factors, including the file type/content (.CAB, .ZIP, .CLASS, .HTM, .JSL,
.ICO, .GIF, .JPG, and other image files, etc.), the Appliction Broker type
(.EXE or .DLL), the secure/public status of the transmission, and any aliases
set by the web-server software (such as Microsoft’s Internet Information
Server). See Application Design Considerations—Directory Structures in the
Internet Connect User’s Guide for more information.

The WebFilesClass object manages all the pathname information for the
temporary and permanent files, directories, and aliases, including switching
between public and secure channels as requested by the WebWindowClass.

Relationship toOther Internet Builder Classes

The BrokerClass, WebServerClass, HtmlClass, JslManagerClass, and

HttpClass all rely on the WebFilesClass to supply the correct pathnames for
various files referenced during the session.

The WebFilesClass does not rely on any other classes.

Internet ConnectTemplate Implementation

The Internet Connect Templates generate code to instantiate a single global

WebFilesClass object per application. The WebFilesClass object is called
WebFilesManager and is referenced by many of the other IBC Libary
objects.
490 IBC LIBRARY REFERENCE

SourceFiles

The WebFilesClass source code is installed by default to the \LIBSRC folder.

The specific class declarations reside in the following files and their method
definitions reside in the corresponding .CLW files.

[Link] WebFilesClass
CHAPTER 14 WEB FILES CLASS 491

WebFilesClass Methods
The WebFilesClass contains the methods listed below.

Functional Organization—ExpectedUse

As an aid to understanding the WebFilesClass, it is useful to organize its

various methods into two categories according to their expected use—the
primary interface and the virtual methods. This organization reflects what we
believe is typical use of these methods.

Primary Interface Methods

The other IBC Libarary objects (WebBrokerClass, WebServerClass,

HtmlClass, and JslManagerClass) call the primary interface methods fairly
routinely. These primary interface methods can be further divided into three
categories:

Housekeeping (one-time) Use:

Init initialize WebFilesClass object
Kill shut down WebFilesClass object

Mainstream Use:
GetAlias return HTML alias for file

Occasional Use:
GetDirectory return temporary folder name
GetPublicDirectory return temporary folder name
GetFilename return temporary file pathname
GetProgramRef return HTML program reference
GetRelativeFilename return filename for Broker
GetTempFilename return filename for Server
LoadImage return linked image filename
SelectTarget set public or secure channel
RemoveAll remove temporary files and folders
GetSeparateSecure return web server security support

Virtual Methods

The WebFilesClass contains no virtual methods.

492 IBC LIBRARY REFERENCE

GetAlias(returnHTML aliasfor file)

GetAlias( filename ), STRING

GetAlias Returns the HTML alias for the specified filename.

filename A string constant, variable, EQUATE, or expression
containing the (Windows) filename for which to return
the HTML alias. This may be a full pathname or a
filename with no path. If the path is omitted, GetAlias
searches for the file in the directories available to the
Server.
The GetAlias method returns the HTML alias for the specified filename. The
HTML alias is the name by which the Client browser refers to the file.
Various IBC methods call GetAlias to provide the correct filename when
generating HTML to send to the Client browser.

The filename may be a full pathname or a filename with no path. If the path
is omitted, GetAlias searches for the filename in the directories available to
the Server.

GetAlias is required because the Server is running locally and refers to files
by their Windows pathnames (e.g., c:\cwicserv\sv\[Link]), while the
Client is running remotely and must refer to the same files by their alias
names (e.g., sv/[Link]). Typically, aliases are established and
maintained by the internet server software such as Microsoft Personal Web
Server or Internet Information Server.

Return DataType: STRING

Example:
[Link] PROCEDURE(STRING param, STRING Filename)
AliasName CSTRING(FILE:MaxFilename)
CODE
IF (Filename)
AliasName = [Link](Filename)
[Link]('<<param name=' & param & ' value="' & |
IC:QuoteText(AliasName,IC:RESET:Value) & '">')
END
CHAPTER 14 WEB FILES CLASS 493

GetDirectory (return temporary folder name)

GetDirectory( [security] ), STRING

GetDirectory Returns a directory name for temporary files.

security An integer constant, variable, EQUATE, or expression
indicating whether a public or a secure channel is
required. If omitted, security defaults to the current
security status, either Secure:None or Secure:Full.
The GetDirectory method returns a directory name with the specified
security, (public or secure). Various IBC Library objects use the returned
directory to hold temporary files used during this session.

The RemoveAll method deletes the temporary directory and its files.

Implementation: EQUATEs for the security parameter are declared in [Link] as

follows:
ITEMIZE,PRE(Secure)
Default EQUATE
None EQUATE
Full EQUATE
Last EQUATE(Secure:Full)
END

Return DataType: STRING

Example:
[Link] PROCEDURE
CurIndex SIGNED,AUTO
CODE
IF ([Link])
RemoveDirectory([Link](Secure:None))
IF ([Link]())
RemoveDirectory([Link](Secure:Full))
END
END

SeeAlso: RemoveAll
494 IBC LIBRARY REFERENCE

GetFilename (return temporary file pathname)

GetFilename( content [,security] ), STRING

GetFilename Returns a temporary file pathname.

content An integer constant, variable, EQUATE, or expression
indicating the file’s contents. The filename and extension
depends on the content.
security An integer constant, variable, EQUATE, or expression
indicating whether a public or a secure channel is
required. If omitted, security defaults to the current
security status, either Secure:None or Secure:Full.
The GetFilename method returns a temporary file pathname of the specified
security (public or secure), for use during this session. Various IBC Library
objects use this method to reference temporary files used during this session.

The content parameter determines the filename and extension. The security
parameter determines the file’s path.

Implementation: The GetFilename method calls the GetDirectory method to get the path.

EQUATEs for the content parameter are declared in [Link] as

follows:
ITEMIZE(1),PRE(Content)
Html EQUATE
Jsl EQUATE
Unauthorized EQUATE
Last EQUATE(Content:Unauthorized)
END

EQUATEs for the security parameter are delcared in [Link]:

ITEMIZE,PRE(Secure)
Default EQUATE
None EQUATE
Full EQUATE
Last EQUATE(Secure:Full)
END

Return DataType: STRING

Example:
[Link] PROCEDURE
CODE
IF ([Link])
RemoveDirectory([Link](Dir:Public))
IF ([Link]())
RemoveDirectory([Link](Dir:Secure))
. .

SeeAlso: GetDirectory
CHAPTER 14 WEB FILES CLASS 495

GetProgramRef (return HTMLprogram reference)

GetProgramRef( [security] ), STRING

GetProgramRef Returns the HTML reference to the Server program.

security An integer constant, variable, EQUATE, or expression
indicating whether a public or a secure channel is
required. If omitted, security defaults to the current
security status, either Secure:None or Secure:Full.
The GetProgramRef method returns the HTML reference to the Server
program. Various IBC objects use this method to generate HTML so the
Client browser can send requests back to the Server.

Implementation: EQUATEs for the security parameter are declared in [Link]:

ITEMIZE,PRE(Secure)
Default EQUATE
None EQUATE
Full EQUATE
Last EQUATE(Secure:Full)
END

Return DataType: STRING

Example:
[Link] PROCEDURE(*HtmlClass Target)
CurFont HtmlFontClass
CODE
[Link](Target)
[Link](Target, FEQ:ClientArea)
[Link](Target)
IF ([Link])
[Link]('<<CENTER>')
[Link]('<<A HREF="' & [Link]() &|
'">' & SplashContinueText & '<</A>')
[Link]('<</CENTER>')
POST(EVENT:CloseWindow)
END
496 IBC LIBRARY REFERENCE

GetPublicDirectory (return public folder name)

GetPublicDirectory( [security] ), STRING

GetPublicDirectory
Returns the public directory set by the Init method.
security An integer constant, variable, EQUATE, or expression
indicating whether a public or a secure channel is
required. If omitted, security defaults to the current
security status, either Secure:None or Secure:Full.
The GetPublicDirectory method returns the public directory set by the Init
method. If no public directory is specified by Init, the GetPublicDirectory
method returns the public directory created by the Application Broker install
program. See Application Design Considerations—Directory Structures in
the Internet Connect User’s Guide for more information.

Implementation: EQUATEs for the security parameter are declared in [Link] as

follows:
ITEMIZE,PRE(Secure)
Default EQUATE
None EQUATE
Full EQUATE
Last EQUATE(Secure:Full)
END

The Application Broker install program creates a subdirectory below the

broker directory for delivering files to the Client. By default this directory is
named \public; however, you may name this directory whatever you choose.
This directory is used to deliver files (such as the Java Support Library,
graphics or other HTML files) by the Application Broker.

Return DataType: STRING

CHAPTER 14 WEB FILES CLASS 497

Example:
[Link] PROCEDURE
Client &WebClientManagerClass
Filename CSTRING(FILE:MaxFilePath),AUTO
CODE
Client &= [Link]
[Link]([Link]())
IF ([Link]() OR NOT [Link])
Filename = [Link](Content:Html)
IF ([Link]())
[Link]
[Link]([Link], Filename)
ELSE
Filename = [Link]() & '[Link]'
[Link]([Link], Filename)
END
[Link](Filename, [Link](), FALSE)
ELSE
[Link]([Link](), [Link])
[Link]([Link])
[Link]
END
[Link]()
END

SeeAlso: Init
498 IBC LIBRARY REFERENCE

GetRelativeFilename (return filename for Broker)

GetRelativeFilename( filename ), STRING

GetRelativeFilename
Returns the filename by which the Application Broker
knows the specified filename.
filename A string constant, variable, EQUATE, or expression
containing the (Windows) filename for which to return
the alternative filename. This may be a full pathname or
a filename with no path. If the path is omitted,
GetRelativeFilename searches for the file in the directo-
ries available to the Server.
The GetRelativeFilename method returns the filename by which the
Application Broker references the specified filename. The Broker is unaware
of its parent directories, so those components of the filename are removed.
The BrokerClass calls GetRelativeFilename to provide the correct filename
when communicating with the Application Broker.

The filename may be a full pathname or a filename with no path. If the path
is omitted, GetRelativeFilename searches for the filename in the directories
available to the Server.

GetRelativeFilename is required because the Server refers to files by their

Windows pathnames (e.g., c:\cwicserv\sv\[Link]), while the Broker is
unaware of its parent directories and must refer to the same files by their
relative names (e.g., sv/[Link]).

Return DataType: STRING

Example:
[Link] PROCEDURE(STRING Filename, SIGNED Security, BYTE dontmove)
Command CSTRING(FILE:MaxFilePath)
IsAbsolute BYTE
Flags SIGNED(0)
CODE
Command = [Link](Filename)
IsAbsolute = IC:IsAbsoluteURL(Command)
IF NOT (IsAbsolute OR DontMove)
Command = IC:TranslateFilename(Command)
END
IF IsAbsolute
Flags += RPC:AbsRedirect
ELSIF (dontmove)
Flags += RPC:NoMove
END
IF (Security = Secure:Full)
Flags += RPC:Secure
END
IC:SendPage(Command, Flags)
CHAPTER 14 WEB FILES CLASS 499

GetSeparateSecure (returnwebserver security support)

GetSeparateSecure( filename ), STRING
The GetSeparateSecure method returns a value indicating whether the
internet server software (such as Microsoft Personal Web Server or Internet
Information Server) supports separate secure directories for secure channel
transmissions. A return value of one (1) indicates separate secure channel
directories; a value of zero (0) indicates a shared directory.

Return DataType: BYTE

Example:
[Link] PROCEDURE
CurIndex SIGNED,AUTO
CODE
IF ([Link])
RemoveDirectory([Link](Secure:None))
IF ([Link]())
RemoveDirectory([Link](Secure:Full))
END
END
500 IBC LIBRARY REFERENCE

GetTempFilename (return filename for Server)

GetTempFilename( filename ), STRING

GetTempFilename Returns a temporary filename for use by the Server.

filename A string constant, variable, EQUATE, or expression
containing the (Windows) filename for which to return
the alternative filename. This may be a full pathname or
a filename with no path. If the path is omitted,
GetTempFilename searches for the file in the directories
available to the Server.
The GetTempFilename method returns a temporary filename for use by the
Server during the current session.

The filename may be a full pathname or a filename with no path. If the path
is omitted, GetTempFilename searches for the filename in the directories
available to the Server.

Return DataType: STRING

Example:
[Link] PROCEDURE |
(*HttpPageBaseClass HttpPage, SIGNED Status, <STRING Filename>)
CODE

[Link]()
[Link] &= HttpPage
[Link](SELF, status, Filename, [Link](Filename))
[Link]()
CHAPTER 14 WEB FILES CLASS 501

Init (initialize theWebFilesClassobject)

Init( longfilenames [,subdirectory] )

Init Initializes the WebFilesClass object.

longfilenames A Boolean constant, variable, EQUATE, or expression
indicating whether the Server generates long filenames
for its temporary files. Clarion versions 2.003 and lower
ignore this parameter in favor of short filenames
subdirectory A string constant, variable, EQUATE, or expression
containing a partial pathname. The WebFilesClass uses
this path fragment to construct pathnames for temporary
files and folders for this session. If omitted, the tempo-
rary filenames and foldernames are constructed without
the path fragment.
The Init method initializes the WebFilesClass object.

The subdirectory parameter contains a pathname fragment that gives you

some control over the placement of temporary files generated by the Server.
The subdirectory parameter should not contain a drive specification such as
c: or d:. The subdirectory parameter becomes the middle portion of
generated pathnames. The WebFilesClass object automatically generates the
beginning and ending of the pathnames, which comprise a sufficient name so
that the subdirectory parameter may be omitted with no adverse effects.

See Application Design Considerations—Directory Structures in the Internet

Connect User’s Guide for more information on directories.

Implementation: The Init method sets the values of various filenames, paths, directories, and
aliases used during this session.

Example:
Orders PROGRAM
!data declarations
WebFilesManager WebFilesClass !declare WebFilesManager object
CODE
[Link](1,'Orders\Temp') !initialize WebFilesManager object
!program code
[Link]
502 IBC LIBRARY REFERENCE

Kill (shut down theWebFilesClassobject)

Kill
The Kill method frees any memory allocated during the life of the object and
performs any other required termination code.

Implementation: The Kill method is one of the few IBC methods you will typically call
directly from your Web-enabled application.

LoadImage (return linkedimagefilename)

LoadImage(| filename |), STRING
| control, property |

LoadImage Returns just the filename portion of a runtime property,

such as PROP:Icon or PROP:Iconlist.
filename A string variable or expression containing the return
value of the runtime property.
control An integer constant, variable, EQUATE or expression
identifying a control (such as an IMAGE or LIST) with
an associated image file or files. This is the control’s
field equate number.
property An integer constant, variable, EQUATE or expression
indicating the runtime property that identifyies the image
file.
The LoadImage method returns just the filename portion of a runtime
property, such as PROP:Icon or PROP:Iconlist. The WebFilesClass uses this
filename to construct appropriate pathnames for images the Server extracts
to separate files for use by the Client browser. Typically, these are images
that are linked in to the Server executable and are not available to the Client
browser until they are written to a separate file.

Return DataType: STRING

Example:
[Link] FUNCTION
CODE
RETURN [Link]([Link], PROP:icon)
504 IBC LIBRARY REFERENCE

RemoveAll (removetemporary filesandfolders)

RemoveAll
The RemoveAll method removes all temporary directories and files created
during the life of the WebFilesClass object.

Example:
[Link] PROCEDURE

CODE
[Link]
IF ([Link])
IF ([Link])
[Link]([Link], Dir:None, FALSE)
ELSE
[Link]([Link](), Dir:None, FALSE)
END
YIELD()
END
[Link]
[Link] = FALSE
CHAPTER 14 WEB FILES CLASS 505

SelectTarget (set public or secure channel)

SelectTarget( security )

SelectTarget Puts the WebFilesClass object into public channel or

secure channel mode.
security An integer constant, variable, EQUATE, or expression
indicating whether a public or a secure channel is
required. Valid values are Secure:Full and Secure:None.
The SelectTarget method puts the WebFilesClass object into public channel
mode or secure channel mode so that various WebFilesClass methods
generate appropriate filenames and pathnames.

Implementation: EQUATEs for the security parameter are declared in [Link] as

follows:
ITEMIZE,PRE(Secure)
Default EQUATE
None EQUATE
Full EQUATE
Last EQUATE(Secure:Full)
END

Example:
[Link] PROCEDURE
Client &WebClientManagerClass
Filename CSTRING(FILE:MaxFilePath),AUTO
CODE
Client &= [Link]
[Link]([Link]())
IF ([Link]() OR NOT [Link])
Filename = [Link](Content:Html)
IF ([Link]())
[Link]
[Link]([Link], Filename)
ELSE
[Link]([Link], Filename)
END
[Link](Filename, [Link](), FALSE)
ELSE
[Link]([Link](), [Link])
[Link]([Link])
[Link]
END
[Link]()
506 IBC LIBRARY REFERENCE
CHAPTER 15 LAYOUT HTML CLASS 507

LAYOUT HTML CLASS

Overview
The LayoutHtmlClass generates an HTML <TABLE> structure to represent
some portion of a Clarion WINDOW, typically a control and its child
controls. Another object, such as a WebWindowClass object, can use the
LayoutHtmlClass to generate an HTML Web page that closely mimics the
appearance and behavior of a Clarion WINDOW.

LayoutHtmlClassConcepts

The LayoutHtmlClass allows another object to generate nested HTML

<TABLE> structures. By using the LayoutHtmlClass to nest HTML
<TABLE> structures, an object such as a WebWindowClass object can
produce a Web page that preserves the parent/child relationships (plus any
inherited positions and properties that result from those relationships) that
exist in the original WINDOW.

For example, a WebWindowClass object can use the LayoutHtmlClass to

generate an HTML <TABLE> to represent an OPTION control and its
RADIO controls, within another HTML <TABLE> containing the SHEET
control that contains both the OPTION control and yet another control, such
as a LIST.

In addition, by using the LayoutHtmlClass to nest HTML <TABLE>

structures, another object, such as a WebWindowClass object, can align
controls, horizontally and vertically, in a Windows-like manner, again,
preserving the look and feel of the original Clarion WINDOW or REPORT.

Relationship toOther Internet Builder Classes

The WebWindowClass and the WebReportClass create and manage

LayoutHtmlClass instances as needed to optimally format all or part of a
Web page.

The LayoutHtmlClass uses the HtmlClass to write the HTML code it

specifies.

The LayoutHtmlClass uses the HtmlItemClass/WebControlClass to provide

information about the WINDOW control it represents and to generate HTML
code for the control within a specific HTML <TABLE CELL> designated by
the LayoutHtmlClass.
510 IBC LIBRARY REFERENCE

Internet ConnectTemplate Implementation

The WebWindowClass and the WebReportClass create and manage

LayoutHtmlClass instances as needed. Therefore the template generated
code does not directly reference the LayoutHtmlClass.

SourceFiles

The LayoutHtmlClass source code is installed by default to the \LIBSRC

folder. The specific class declarations are in the following files and their
method definitions are in the corresponding .CLW files.

[Link] LayoutHtmlClass

Conceptual Example

The following example shows a typical sequence of statements to declare,

instantiate, initialize, use, and terminate a LayoutHtmlClass object and
related objects.

This example uses the LayoutHtmlClass to generate an HTML <TABLE> to

represent a related list of WINDOW controls. Typically, the list of controls
consists of all the children of a parent control. At the ultimate level, the
WINDOW is the parent.

[Link] PROCEDURE(*WebControlQueue Source, |

*HtmlClass Target, STRING style, SIGNED SnapX, SIGNED SnapY)

Layout LayoutHtmlClass !declare Layout object

CODE
[Link](style, SnapX, SnapY) !initialize Layout object
[Link](Source, Layout) !identify controls to lay out
[Link](Target) !write HTML for the controls
[Link] !shut down the Layout object

[Link] PROCEDURE|
(*WebControlQueue Source, *LayoutHtmlClass Layout)

CurIndex SIGNED,AUTO
CODE
LOOP CurIndex = 1 TO RECORDS(Source)
GET(Source, CurIndex)
IF ([Link]())
[Link]([Link])
END
END
CHAPTER 15 LAYOUT HTML CLASS 511

LayoutHtmlClass Proper ties

The LayoutHtmlClass contains the properties listed below.

SnapX(horizontal grid snap)

SnapX SIGNED
The SnapX property contains a horizontal grid snap factor for aligning
controls on the Web page. If the X coordinates of two WINDOW controls
differ by less than the value of SnapX, the LayoutHtmlClass object left
aligns the controls on the Web page.

Implementation: The Init method sets the value of the SnapX property. The Insert method
aligns the controls by placing them in the same HTML <TABLE
COLUMN>.

SeeAlso: Init, Insert

SnapY(vertical grid snap)

SnapY SIGNED
The SnapY property contains a vertical grid snap factor for aligning controls
on the Web page. If the Y coordinates of two WINDOW controls differ by
less than the value of SnapY, the LayoutHtmlClass object bottom aligns the
controls on the Web page.

Implementation: The Init method sets the value of the SnapY property. The Insert method
aligns the controls by placing them in the same HTML <TABLE ROW>.

SeeAlso: Init, Insert

Style(HTMLtable style)
Style CSTRING(100)
The Style property specifies the HTML <TABLE STYLE>.

Implementation: The Style property is primarily used to set the border width of the HTML
<TABLE>. The Init method sets the value of the Style property.

SeeAlso: Init
512 IBC LIBRARY REFERENCE

LayoutHtmlClass Methods
The LayoutHtmlClass contains the methods listed below.

Functional Organization—ExpectedUse

As an aid to understanding the LayoutHtmlClass , it is useful to organize its

methods into two categories according to their expected use—the primary
interface and the virtual methods. This organization reflects what we believe
is typical use of these methods.

Primary Interface Methods

The primary interface methods, which you are likely to call fairly routinely
from your program, can be further divided into three categories:

Housekeeping (one-time) Use:

Init initialize the LayoutHtmlClass object
CreateHtml generate HTML table
Kill shut down the LayoutHtmlClass object

Mainstream (repeated) Use:

Insert add control to layout process

Occasional Use:
SetCell set current control/cell

Virtual Methods

The LayoutHtmlClass has no virtual methods.

CHAPTER 15 LAYOUT HTML CLASS 513

CreateHtml (generate HTMLtable)

CreateHtml( html object )

CreateHtml Generates the HTML <TABLE> code.

html object The label of the HtmlClass object that writes the speci-
fied HTML code.
The CreateHtml method generates the HTML <TABLE> code. Within the
<TABLE> is HTML code representing each control (HtmlItemClass object)
named by the Insert method.

Example:
[Link] PROCEDURE(*WebControlQueue Source, |
*HtmlClass Target, STRING style, SIGNED SnapX, SIGNED SnapY)

Layout LayoutHtmlClass

CODE
[Link](style, SnapX, SnapY)
[Link](Source, Layout)
[Link](Target)
[Link]

SeeAlso: Insert
514 IBC LIBRARY REFERENCE

Init (initialize theLayoutHtmlClassobject)

Init( style, snapX, snapY )

Init Initializes the LayoutHtmlClass object.

style A string constant, variable, EQUATE, or expression
specifying the <STYLE> attributes for the HTML
<TABLE>.
snapX An integer constant, variable, EQUATE, or expression
specifying the horizontal grid snap factor.
snapY An integer constant, variable, EQUATE, or expression
specifying the vertical grid snap factor.
The Init method initializes the LayoutHtmlClass object.

Example:
[Link] PROCEDURE(*WebControlQueue Source, |
*HtmlClass Target, STRING style, SIGNED SnapX, SIGNED SnapY)

Layout LayoutHtmlClass

CODE
[Link](style, SnapX, SnapY)
[Link](Source, Layout)
[Link](Target)
[Link]

SeeAlso: SnapX, SnapY, Style

CHAPTER 15 LAYOUT HTML CLASS 515

Insert (addcontrol to layout process)

Insert( control object )

Insert Adds a control to the layout process.

control object The label of the HtmlItemClass/WebControlClass object
that represents a WINDOW or REPORT control.
The Insert method adds a control to the layout and HTML generation
process. Each control object named by the Insert method is represented in
the HTML <TABLE> structure generated by the CreateHtml method.

Example:
[Link] PROCEDURE|
(*WebControlQueue Source, *LayoutHtmlClass Layout)

CurIndex SIGNED,AUTO

CODE
LOOP CurIndex = 1 TO RECORDS(Source)
GET(Source, CurIndex)
IF ([Link]())
[Link]([Link])
END
END

SeeAlso: CreateHtml
516 IBC LIBRARY REFERENCE

Kill (shut down theLayoutHtmlClassobject)

Kill
The Kill method frees any memory allocated during the life of the object and
performs any other required termination code.

Example:
[Link] PROCEDURE(*WebControlQueue Source, |
*HtmlClass Target, STRING style, SIGNED SnapX, SIGNED SnapY)

Layout LayoutHtmlClass

CODE
[Link](style, SnapX, SnapY)
[Link](Source, Layout)
[Link](Target)
[Link]
CHAPTER 15 LAYOUT HTML CLASS 517

SetCell (set current control/cell)

SetCell( x, y ), LayoutCellClass, PROC

SetCell Sets the current control/cell for processing by other

LayoutHtmlClass methods.
x An integer constant, variable, EQUATE, or expression
specifying the cell’s column number.
y An integer constant, variable, EQUATE, or expression
specifying the cell’s row number.
The SetCell method returns a reference to the specified control/cell
(LayoutCellClass object) for processing by other LayoutHtmlClass methods.
Cells are identified by their x(column) and y(row) coordinates.

This method has the PROC attribute so you can call it like a procedure and
ignore the return value.

Return DataType: LayoutCellClass

Example:
[Link] PROCEDURE

CurCell &LayoutCellClass,AUTO
CurItem SIGNED,AUTO
Xpos SIGNED,AUTO
Ypos SIGNED,AUTO

CODE

SUBMIT ITEM CLASS

Overview 521
SubmitItemClass Concepts ..................................................................................521
Relationship to Other Internet Builder Classes ................................................... 521
Internet Connect Template Implementation .........................................................521
Source Files..........................................................................................................521
SubmitItem Properties 522
Event (event number) ...........................................................................................522
Extra (other event information) ...........................................................................522
Feq (control number) ...........................................................................................522
Name (new control contents) .............................................................................. 523
NewValue (new control contents) ....................................................................... 523
SubmitItem Methods 524
Reset (set SubmitItem properties)....................................................................... 524
520 IBC LIBRARY REFERENCE
CHAPTER 16 SUBMIT ITEM CLASS 521

SubmitItemClassConcepts

Browser Submit Strings

SubmitItemClass manages incoming data submitted from the Client browser.

When the end user enters data through the browser, the browser sends a
“submit string” to the Server. The submit string consists of a URL followed
by a question mark (?) and a list of field assignments of the form
‘field=value&field2=value2&field3=value3.’ The SubmitItemClass
represents a single field in this submit string. In addition to the new value
entered in the browser, the SubmitItemClass object contains the field equate
of the control and any event associated with the control (Event:Accepted,
Event:ScrollUp, etc.).

The WebServerClass creates and manages SubmitItemClass instances as

needed.

Relationship toOther Internet Builder Classes

The WebServerClass creates and manages SubmitItemClass instances as

needed to process the browser submit strings.

Internet ConnectTemplate Implementation

The WebServerClass creates and manages SubmitItemClass instances as

needed. Therefore the template generated code does not directly reference
SubmitItemClass objects.

SourceFiles

The SubmitItemClass source code is installed by default to the \LIBSRC

folder. The SubmitItemClass declarations reside in the following files and
their method definitions reside in the corresponding .CLW files.

[Link] SubmitItemClass
522 IBC LIBRARY REFERENCE

SubmitItem Proper ties

SubmitItemClass contains the properties listed below.

Event (event number)

Event SIGNED
The Event property contains the event number of the control updated in the
client browser.

Implementation: The Reset method sets the value of the Event property. The WebControlClass
uses this property to POST the appropriate event to the control in the Server
(Web-enabled Clarion application).

SeeAlso: Reset

Extra (other event information)

Extra ANY
The Extra property contains any other information associated with the
Event. For example, the Extra property may contain the thumb position for a
ScrollDrag event.

Implementation: The Reset method sets the value of the Extra property. The WebControlClass
uses this property to update the control in the Server (Web-enabled Clarion
application).

SeeAlso: Reset

Feq(control number)
Feq SIGNED
The Feq property contains the control number of the control updated in the
client browser.

Implementation: The Reset method sets the value of the Feq property. The WebControlClass
uses this property to update the control in the Server (Web-enabled Clarion
application).

SeeAlso: Reset
CHAPTER 16 SUBMIT ITEM CLASS 523

Name (newcontrol contents)

Name ANY
The Name property contains the HTML field name.

Implementation: The Reset method sets the value of the Name property.

SeeAlso: Reset

NewValue(newcontrol contents)
NewValue ANY
The NewValue property contains the value entered into the client browser.

Implementation: The Reset method sets the value of the NewValue property. The
WebControlClass uses this property to update controls in the Server (Web-
enabled Clarion application).

For entry fields, the NewValue property typically contains a string value. For
LISTs and SHEETs, NewValue typically contains a numeric positioning
value.

SeeAlso: Reset
524 IBC LIBRARY REFERENCE

SubmitItem Methods
SubmitItemClass contains only one method.

Reset (set SubmitItemproperties)

Reset( arguments )

Reset Sets the value of all the SubmitItemClass properties

based on the value of arguments.
arguments A string constant, variable, EQUATE, or expression
containing the submit string from the client browser in
the form field=value
The Reset method sets the value of all the SubmitItemClass properties by
parsing the arguments parameter.

Implementation: The Reset method converts the browser (HTML) field name to a Clarion
Field Equate number.

Example:
[Link] PROCEDURE

AssignPos SIGNED
EndPos SIGNED
EventNo SIGNED
EventPos SIGNED
StartPos SIGNED
NIL &SubmitItemClass

CODE

StartPos = [Link]

EndPos = INSTRING('&', [Link], 1, StartPos)

IF (EndPos = 0)
RETURN NIL
END

[Link](SUB([Link], StartPos, EndPos-StartPos))

[Link] = EndPos + 1
RETURN [Link]

SeeAlso: [Link]
CHAPTER 17 HTML CLASS 525

HTML CLASS

Overview 527
HtmlClass Concepts ............................................................................................ 527
Relationship to Other Internet Builder Classes ................................................... 527
Internet Connect Template Implementation .........................................................527
Source Files..........................................................................................................528
HtmlClass Properties 529
AppletCount (Java applets on this HTML page) .................................................529
Browser (browser manager object) ......................................................................529
Client (client manager object)............................................................................. 529
Files (file manager object) .................................................................................. 530
FirstControl (first input control) ..........................................................................530
FirstSelectable (first input control select all flag) ................................................530
JavaLibraryCab (Java Support Library cabinet name)........................................ 531
JavaLibraryZip (Java Support Library zip name) ................................................531
Option (web page scale information).................................................................. 532
UseFonts (use Windows fonts on Web page) .......................................................532
HtmlClass Methods 533
Functional Organization—Expected Use ............................................................533
CreateOpen (start new HTML page) .................................................................. 535
GetFontChanged (return font changed flag) ........................................................536
GetFontStyle (return HTML STYLE string) .......................................................537
GetPixelsX (convert horizontal dialog units to pixels) ........................................538
GetPixelsY (convert vertical dialog units to pixels) ............................................539
GetControlReference (return control HREF) ......................................................540
Init (initialize the HtmlClass object) ................................................................... 541
Kill (shut down the HtmlClass object)................................................................ 541
PopFont (restore pre-PushFont font) .................................................................. 542
PushFont (set current font) ................................................................................. 543
TakeNewControl (set first control) ......................................................................544
WriteAppletDimParameter (write Java applet dim parameter) .......................... 545
WriteAppletFilenameParameter (write Java applet filename parameter) ............546
WriteAppletFontParameter (write Java applet font parameter) .......................... 547
WriteAppletFooter (end Java applet) ...................................................................548
WriteAppletHeader (begin Java applet) ...............................................................549
526 IBC LIBRARY REFERENCE

WriteAppletOptParameter (write Java applet parameter) ....................................550

WriteAppletParameter (write Java applet parameter)..........................................551
WriteAppletUAID (write Java applet unique Id) .................................................552
WriteChildAppletFooter (end child Java applet) .................................................553
WriteChildAppletHeader (begin child Java applet) ............................................ 554
WriteContainerAppletHeader (begin container applet) ...................................... 555
WriteControlFooter (end HTML control)........................................................... 556
WriteControlHeader (begin HTML control) ...................................................... 556
WriteEventHandler (write HTML control accepted action) ............................... 557
WriteFontFooter (end HTML font) .................................................................... 559
WriteFontHeader (begin HTML font) .................................................................559
WriteFormFooter (end HTML FORM) .............................................................. 560
WriteFormHeader (begin HTML FORM) ...........................................................560
WriteJavaScript (write shared JavaScript functions) ...........................................561
WriteOnFocusHandler (write HTML control selected action) ............................562
WriteRefreshTimer (write HTML timer refresh) ................................................563
WriteSpace (write HTML space) .........................................................................564
WriteSubmitApplet (write Java applet coordinator) ........................................... 565
WriteTableFooter (end HTML TABLE)................................................................... 566
WriteTableHeader (begin HTML TABLE) .............................................................. 566
WriteTableNewCol (begin HTML TABLE CELL) .............................................567
WriteTableNewRow (begin HTML TABLE ROW) ................................................ 567
WriteText (write breakable text string) ................................................................568
CHAPTER 17 HTML CLASS 527

HtmlClassConcepts

The HtmlClass class writes HTML and other source code specified by
various IBC Library objects.

It contains functions for handling font information as HTML <STYLE>

attributes and as Java applet parameters. It also contains functions for writing
Java applets and JavaScript.

Typically your Web-enabled application instantiates a single global

HtmlClass object.

Relationship toOther Internet Builder Classes

The HtmlClass is derived from the TextOutputClass which provides basic

text file handling, including creating, opening, writing, and closing a text
file. See Text Output Class for more information.

The HtmlClass adds the HTML-specific text writing capability.

The WebWindowClass, the WebControlClass, and the WebReportClass all

rely on the HtmlClass to write various snippets of HTML code to the
appropriate destination.

Internet ConnectTemplate Implementation

The Internet Connect Templates generate code to instantiate a single global

HtmlClass object. The object is called HtmlManager. Other IBC Library
objects call the HtmlManager object as needed to write HTML snippets, so
there are very few references to the HtmlManager object within the template
generated code.
528 IBC LIBRARY REFERENCE

SourceFiles

The HtmlClass source code is installed by default to the \LIBSRC folder.

The specific class declarations reside in the following files and their method
definitions reside in the corresponding .CLW files.

[Link] TextOutputClass

[Link] HtmlClass
CHAPTER 17 HTML CLASS 529

HtmlClass Proper ties

The HtmlClass contains the properties listed below.

AppletCount (Java applets onthis HTML page)

AppletCount SIGNED
The AppletCount property contains the number of Java applets on this
HTML page. The HtmlClass does not use the AppletCount property; it is
available for developer use.

Browser (browser manager object)

Browser &BrowserManagerClass, PROTECTED
The Browser property is a reference to the BrowserManagerClass object that
provides information about the Client’s Web browse, such as whether the
browser supports Style Sheets or Java. The HtmlClass object uses this
property to generate HTML appropriate for the Client’s Web browser.

This property is PROTECTED, therefore, it can only be referenced by a

HtmlClass method, or a method in a class derived from HtmlClass.

Implementation: The CreateOpen method sets the value of the Browser property.

SeeAlso: CreateOpen

Client (clientmanager object)

Client &WebClientManagerClass, PROTECTED
The Browser property is a reference to the WebClientManagerClass object
that provides information about the Client, such as the IP address. The
HtmlClass object uses this property primarily to generate HTML control
IDs.

This property is PROTECTED, therefore, it can only be referenced by a

HtmlClass method, or a method in a class derived from HtmlClass.

Implementation: The CreateOpen method sets the value of the Client property.

SeeAlso: CreateOpen
530 IBC LIBRARY REFERENCE

Files(filemanager object)
Files &WebFilesClass, PROTECTED
The Files property is a reference to the WebFilesClass object that provides
all the file, directory, alias, and path information for the HtmlClass object.
The HtmlClass object uses this property to supply appropriate filenames and
pathnames within the generated HTML.

This property is PROTECTED, therefore, it can only be referenced by a

HtmlClass method, or a method in a class derived from HtmlClass.

Implementation: The Init method sets the value of the Files property.

SeeAlso: Init

FirstControl (first input control)

FirstControl SIGNED
The FirstControl property contains the control number (field equate) of the
control whose corresponding Web page control gets initial input focus when
the browser displays the Web page.

The HtmlClass object uses this property to generate HTML code that mimics
Windows behavior with regard to initial control focus on input forms.

Implementation: The TakeNewControl method sets the value of the FirstControl property. The
FirstControl property is only effective for entry fields and text fields under
NetScape browsers.

SeeAlso: TakeNewControl

FirstSelectable (first input control select all flag)

FirstSelectable BYTE
The FirstSelectable property indicates whether the control identified by the
FirstControl property allows block selection of its text. A value of one (1)
indicates block selectable text; a value of zero (0) indicates the text is not
block selectable.

Implementation: The TakeNewControl method sets the value of the FirstSelectable property.
Entry fields are block selectable; text fields are not block selectable.

SeeAlso: FirstControl, TakeNewControl

CHAPTER 17 HTML CLASS 531

JavaLibraryCab(Java Support Library cabinet name)

JavaLibraryCab CSTRING(FILE:MaxFilepath)
The JavaLibraryCab property contains the pathname of the Java Support
Library cabinet (.CAB) file. The HtmlClass object uses this property to send
the Java Support Library location to the Client’s browser.

Implementation: The CreateOpen method sets the value of the JavaLibraryCab property.

SeeAlso: Java Support Library

JavaLibraryZip (Java Support Libraryzip name)

JavaLibraryZip CSTRING(FILE:MaxFilepath)
The JavaLibraryZip property contains the pathname of the Java Support
Library archive (.ZIP) file. The HtmlClass object uses this property to send
the Java Support Library location to the Client’s browser.

Implementation: The CreateOpen method sets the value of the JavaLibraryZip property.

SeeAlso: Java Support Library

532 IBC LIBRARY REFERENCE

Option(webpage scale information)

Option HtmlOptionGroup
The Option property contains horizontal and vertical scaling factors for the
generated HTML page. The HtmlClass object uses this property to position
Web page controls in proportion to their corresponding Window controls.

Implementation: The CreateOpen method sets the value of the Option property. These scaling
factors come from the Internet Options extension template Advanced tab:
HTML Scaling - Pixels Per Character.

The GetPixelsX and GetPixelsY methods use this property to convert

Window dialog units to Web page pixels.

The HtmlOptionGroup is declared in [Link] as follows:

HtmlOptionGroup GROUP,TYPE
ScaleX REAL
ScaleY REAL
END

SeeAlso: CreateOpen, GetPixelsX, GetPixelsY

UseFonts (useWindows fonts onWebpage)

UseFonts BYTE
The UseFonts property indicates whether to apply the fonts set in the
Windows program to their corresponding HTML controls. A value of one (1)
applies the Windows fonts; a value of zero (0) does not apply the Windows
fonts, so that the Client’s default fonts are used.

Implementation: The Init method sets the UseFonts property to True. The UseFonts property
is only effective if the Client’s Web browser does not support style sheets.

SeeAlso: Init, [Link]

CHAPTER 17 HTML CLASS 533

HtmlClass Methods
The HtmlClass inherits all the methods from the TextOutputClass from
which it is derived. See TextOutputClass Methods for more information.

In addition to (or instead of) the inherited methods, the HtmlClass contains
the methods listed below.

Functional Organization—ExpectedUse

As an aid to understanding the HtmlClass , it is useful to organize its various

methods into two categories according to their expected use—the primary
interface and the virtual methods. This organization reflects what we believe
is typical use of these methods.

Primary Interface Methods

The primary interface methods, which other IBC Library objects call fairly
routinely, can be further divided into the following categories:

Housekeeping (once per application) Use:

Init initialize the HtmlClass object
Kill shut down the HtmlClass object

Mainstream Use:

Occasional Use:
CreateOpen start new HTML page
GetFontChanged return font changed flag
GetFontStyle return HTML STYLE string
GetPixelsX convert dialog units to pixels
GetPixelsY convert dialog units to pixels
GetControlReference return control HREF
PopFont restore pre-PushFont font
PushFont set current font
TakeNewControl set first control
WriteAppletDimParameter write Java applet dim parameter
WriteAppletFilenameParameterwrite Java applet filename parameter
WriteAppletFontParameter write Java applet font parameter
WriteAppletFooter end Java applet
WriteAppletHeader begin Java applet
WriteAppletOptParameter write Java applet parameter
WriteAppletParameter write Java applet parameter
WriteAppletUAID write Java applet UAID parameter
WriteChildAppletFooter end child Java applet
WriteChildAppletHeader begin child Java applet
WriteContainerAppletHeader begin container applet
534 IBC LIBRARY REFERENCE

WriteControlFooter end HTML control

WriteControlHeader begin HTML control
WriteEventHandler write HTML control accepted action
WriteFontFooter end HTML font
WriteFontHeader begin HTML font
WriteFormFooter end HTML FORM
WriteFormHeader begin HTML FORM
WriteJavaScript write shared JavaScript functions
WriteOnFocusHandler write HTML control selected action
WriteRefreshTimer write HTML timer refresh
WriteSpace write HTML non-breaking space
WriteSubmitApplet write shared Java submit applet
WriteTableFooter end HTML TABLE
WriteTableHeader begin HTML TABLE
WriteTableNewCol begin HTML TABLE CELL
WriteTableNewRow begin HTML TABLE ROW
WriteText write breakable text string
WriteI write text string
WritelnI write end of line marker
OpenI open the file
GetSizeI return file size in bytes
CloseI close the file
I
These methods are inherited from the TextOutputClass.

Virtual Methods

WriteJavaScript write shared JavaScript functions

CHAPTER 17 HTML CLASS 535

CreateOpen(start newHTML page)

CreateOpen( pathname, scaling, JSL path, client )

CreateOpen Starts a new HTML page.

pathname A string constant, variable, EQUATE, or expression
containing the pathname of the file that contains the
generated HTML code.
scaling The label of the structure that contains horizontal and
vertical Windows-to-Web scaling ratios.
JSL path A string constant, variable, EQUATE, or expression
containing the location of the Java Support Library.
client The label of the WebClientManagerClass object that
supplies information about the Client.
The CreateOpen method starts a new HTML page.

Implementation: The CreateOpen method sets the initial values of the Client, Browser, Option,
AppletCount, JavaLibraryCab, and JavaLibraryZip properties. The
CreateOpen method calls the [Link] method to
initialize a new output file.

Example:
[Link] PROCEDURE(*HtmlClass Target,STRING HtmlFilename)
CODE
[Link](HtmlFilename,[Link],SELF.| !start new HTML page
[Link],[Link])
[Link](Target) !page header
[Link](Target,0,[Link]) !page body
[Link](Target) !page footer
[Link] !finish page
[Link] = TRUE !prepare for next page

SeeAlso: AppletCount, Browser, Client, Option, JavaLibraryCab, JavaLibraryZip,

[Link]
536 IBC LIBRARY REFERENCE

GetFontChanged(return font changedflag)

GetFontChanged( new font ), BYTE

GetFontChanged Returns a value indicating whether the new font is

different than the current Web page font.
new font The label of the HtmlFontClass object that contains the
font information for a WINDOW or REPORT control.
The GetFontChanged method returns a value indicating whether the new
font is different than the current Web page font. A return value of one (1)
indicates the new font is different than the Web page font; a value of zero (0)
indicates the fonts are the same, therefore no HTML is required to apply the
new font.

The [Link] method returns a reference that can be used

for the new font parameter. The [Link] method is a
reference that can be used for the new font parameter.

Return DataType: BYTE

Example:
[Link] PROCEDURE(*HtmlClass Target)
CurFont HtmlFontClass
ParentControl GROUP(WebControlRefGroup).

CODE
[Link](CurFont) !get current control font
IF ([Link](CurFont)) !if different than Web page font
[Link](CurFont) !apply new font to Web control
END

SeeAlso: [Link], [Link]

CHAPTER 17 HTML CLASS 537

GetFontStyle (return HTML STYLEstring)

GetFontStyle( window font [, web font] ), STRING

GetFontStyle Returns the HTML code to implement the window font.

window font The label of the HtmlFontClass object that contains the
font information for a WINDOW or REPORT control.
web font The label of the HtmlFontClass object that contains the
current font information in effect for the Web page. If
omitted, GetFontStyle supplies the current Web page
font information.
The GetFontStyle method returns the HTML code needed to implement the
window font on the generated Web page.

The [Link] method returns a reference that can be used

for either font parameter. The [Link] method is a
reference that can be used for either font parameter.

Return DataType: STRING

Example:
[Link] PROCEDURE(*HtmlClass Target)
Result CSTRING(255)
CODE

IF ([Link] <> COLOR:None) !add BGCOLOR attribute

Result=Result&' BGCOLOR="'&IC:ColorText([Link])&'"'
END
IF ([Link]) !add BACKGROUND attribute
Result=Result&' BACKGROUND="'&[Link]([Link])&'"'
END
RETURN Result&[Link]([Link]) !add STYLE attribute

SeeAlso: [Link], [Link]

538 IBC LIBRARY REFERENCE

GetPixelsX(convert horizontal dialogunits topixels)

GetPixelsX( width ), SIGNED

GetPixelsX Returns the width in pixels for a given width in dialog

units.
width An integer constant, variable, EQUATE, or expression
containing a control width expressed in dialog units.
The GetPixelsX method returns the width in pixels for a given width in
expressed in dialog units. The HtmlClass object uses this method to position
Web page controls in proportion to their corresponding Window controls.

Implementation: The GetPixelsX method returns (width * [Link]) + [Link]/2.

Return DataType: SIGNED

Example:
[Link] PROCEDURE|
(STRING AppletName,STRING ClassName,SIGNED Width,SIGNED Height)

CODE
IF (Width = 0) THEN Width = 1.
IF (Height = 0) THEN Height = 1.
[Link]('<<applet NAME="'&AppletName&'" CODEBASE="/" CODE='&ClassName&'.class')
[Link](' ARCHIVE="' & [Link] & '" MAYSCRIPT')
[Link](' WIDTH=' & [Link](Width)) !convert width to pixels
[Link](' HEIGHT=' & [Link](Height)) !convert height to pixels
[Link]('>')
[Link]('cabbase',[Link])
[Link]('USID',[Link]())

SeeAlso: Option
CHAPTER 17 HTML CLASS 539

GetPixelsY(convert vertical dialogunits topixels)

GetPixelsY( height ), SIGNED

GetPixelsY Returns the height in pixels for a given height in dialog

units.
height An integer constant, variable, EQUATE, or expression
containing a control height expressed in dialog units.
The GetPixelsY method returns the height in pixels for a given height in
expressed in dialog units. The HtmlClass object uses this method to position
Web page controls in proportion to their corresponding Window controls.

Implementation: The GetPixelsY method returns (height * [Link]) + [Link]/2.

Return DataType: SIGNED

Example:
[Link] PROCEDURE|
(STRING AppletName,STRING ClassName,SIGNED Width,SIGNED Height)

SeeAlso: Option
540 IBC LIBRARY REFERENCE

GetControlReference(return control HREF)

GetControlReference( control ), STRING

GetControlReference
Returns the HTML HREF value for a control.
control An integer constant, variable, EQUATE, or expression
containing the control number. This is typically the field
equate for the control.
The GetControlReference method returns the HTML HREF value for a
control.

Implementation: The HREF value for a control determines what the Client browser does when
the end user manipulates or accepts the Web control. For example, the
following HREF value causes the Client browser to send the string
‘X30003=Ohio’ to the Server at [Link]
HREF=’[Link]

The Server (your Web-enabled application) translates the X30003 to its

corresponding Clarion control, assigns ‘Ohio’ to the control’s USE variable,
then POSTs an EVENT:Accepted for the control.

The GetControlReference method calls the [Link]

method to build the URL part of the HREF value.

Return DataType: STRING

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE
[Link]('<<NOBR>')
[Link]('<<A HREF="' & [Link]([Link]) & '">')
[Link]([Link]() & '<</A>')
[Link]('<</NOBR><<BR>')

SeeAlso: [Link]
CHAPTER 17 HTML CLASS 541

Init (initialize theHtmlClassobject)

Init( files )

Init Initializes the HtmlClass object.

files The label of the WebFilesClass object that supplies
filenames, pathnames, directories, and aliases for the
HtmlClass object.
The Init method initializes the HtmlClass object.

Implementation: The Init method sets the value of the Files property.

Example:
!data
CODE
[Link](1, '')
[Link](WebFilesManager)
!program code
[Link]
[Link]

SeeAlso: Files

Kill (shut down theHtmlClassobject)

Kill
The Kill method frees any memory allocated during the life of the object and
performs any other required termination code.

Example:
!data
CODE
[Link](1, '')
[Link](WebFilesManager)
!program code
[Link]
[Link]
542 IBC LIBRARY REFERENCE

PopFont (restore pre-PushFont font)

PopFont( control )

PopFont Restores font information to its pre-PushFont state.

control An integer constant, variable, EQUATE, or expression
containing the control number of the control whose font
is no longer the current one. This is typically the field
equate for the control.
The PopFont method restores font information to its pre-PushFont state.
Appropriate use of PushFont and PopFont allow child controls to correctly
inherit or override parent control font information. Appropriate use simply
means pairing a call to PushFont with a subsequent call to PopFont.

Example:
[Link] PROCEDURE(*HtmlClass Target)
CODE
[Link]([Link])

SeeAlso: PushFont
CHAPTER 17 HTML CLASS 543

PushFont (set current font)

PushFont( font, control )

PushFont Makes the control’s font the current one for use by other
HtmlClass methods.
font The label of the HtmlFontClass object that contains the
font information for the control.
control An integer constant, variable, EQUATE, or expression
containing the control number of the control whose font
to make current. This is typically the field equate for the
control.
The PushFont method makes the control’s font the current one for use by
other HtmlClass methods. Appropriate use of PushFont and PopFont allow
child controls to correctly inherit or override parent control font information.
Appropriate use simply means pairing a call to PushFont with a subsequent
call to PopFont.

Example:
[Link] PROCEDURE(*HtmlClass Target)
CurFont HtmlFontClass
CODE
[Link](CurFont)
[Link](CurFont, [Link])

SeeAlso: PopFont
544 IBC LIBRARY REFERENCE

TakeNewControl (set first control)

TakeNewControl( control, selectable )

TakeNewControl Does any HtmlClass processing needed whenever a

control is first encountered during HTML generation.
control An integer constant, variable, EQUATE, or expression
containing the control number of the control being
processed. This is typically the field equate for the
control.
selectable An integer constant, variable, EQUATE, or expression
indicating whether the control’s text is block selectable.
The TakeNewControl method does any HtmlClass processing needed
whenever a control is first encountered during HTML generation.

Implementation: The TakeNewControl method sets the FirstControl and FirstSelectable

properties for Entry controls and Text controls only.

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE
[Link]([Link], FALSE) !tell HtmlClass object a Text control
!is being processed
[Link]('<<TEXTAREA WRAP=VIRTUAL')
[Link]([Link](Target))
[Link](' COLS="' & INT(([Link]{PROP:width} + 2)/4) & '"')
[Link](' ROWS="' & INT(([Link]{PROP:height} + 4)/8) & '"')
[Link]('>')
[Link](IC:QuoteText(CLIP(CONTENTS([Link])), IC:RESET:Text))
[Link]('<</TEXTAREA>')
[Link]

SeeAlso: FirstControl, FirstSelectable

CHAPTER 17 HTML CLASS 545

WriteAppletDimParameter (write Java applet dimparameter)

WriteAppletDimParameter( x, y, width, height )

WriteAppletDimParameter
Writes the HTML to set an applet “Dim” parameter.
x An integer constant, variable, EQUATE, or expression
containing the applet’s horizontal position in dialog
units.
y An integer constant, variable, EQUATE, or expression
containing the applet’s vertical position in dialog units.
width An integer constant, variable, EQUATE, or expression
containing the applet’s width in dialog units.
height An integer constant, variable, EQUATE, or expression
containing the applet’s height in dialog units.
The WriteAppletDimParameter method writes the HTML to set an applet
“Dim” parameter. The “Dim” parameter determines the position and size
coordinates for the applet.

Implementation: The WriteAppletDimParameter method calls the WriteAppletParameter

method.
[Link] PROCEDURE(*HtmlClass Target)
!data
CODE
[Link]([Link], [Link](), MaxX, MaxY)
IF (SameAppletType)
[Link]('className', AppletType)
END
ControlNum = 1
LOOP CurIndex = 1 TO RECORDS(Controls)
GET(Controls, CurIndex)
ThisControl &= [Link]
IF ([Link]())
[Link](x, y, width, height)
[Link]('control' & ControlNum, [Link])
[Link](x, y, width, height)
IF (NOT SameAppletType)
[Link]('className', [Link]())
END
[Link](Target)
[Link]
ControlNum += 1
END
END
[Link]
END

SeeAlso: WriteAppletParameter
546 IBC LIBRARY REFERENCE

WriteAppletFilenameParameter (write Java applet filename parameter)

WriteAppletFilenameParameter( parameter, filename )

WriteAppletFilenameParameter
Writes the HTML to set an applet parameter equal to a
pathname.
parameter A string constant, variable, EQUATE, or expression
containing the name of the applet parameter to receive
the filename.
filename A string constant, variable, EQUATE, or expression
containing the filename to assign to the applet param-
eter.
The WriteAppletFilenameParameter method writes the HTML to set an
applet parameter equal to a pathname.

Implementation: The WriteAppletFilenameParameter method expands the filename to its full

pathname, then calls the WriteAppletParameter method.

Example:
[Link] PROCEDURE(*HtmlClass Target)
Filename CSTRING(FILE:MaxFileName)
CODE
Filename = [Link]()

[Link]('Picture', Filename)
[Link]('Label', [Link]())
[Link]('Hint', [Link]{PROP:tooltip})
[Link]('Align', [Link]())
IF ([Link](EVENT:Accepted) = Update:Full)
[Link]('Submit', 1)
END

SeeAlso: WriteAppletParameter
CHAPTER 17 HTML CLASS 547

WriteAppletFontParameter (write Java applet font parameter)

WriteAppletFontParameter( font )

WriteAppletFontParameter
Writes the HTML to set an applet font parameter.
font The label of the HtmlFontClass object that contains the
font information to apply.
The WriteAppletFontParameter method writes the HTML to set an applet
font parameter.

Implementation: The WriteAppletFontParameter method calls the WriteAppletParameter

method.

SeeAlso: WriteAppletParameter
548 IBC LIBRARY REFERENCE

WriteAppletFooter (endJava applet)

WriteAppletFooter
The WriteAppletFooter method writes the HTML code (JavaScript) to end
a Java applet started by the WriteAppletHeader method.

Example:
[Link] PROCEDURE(*HtmlClass Target)

Height SIGNED,AUTO
Width SIGNED,AUTO
CODE
GetPosition([Link],,,Width,Height)
[Link]([Link],[Link](),Width,Height)
[Link](Target)
[Link]

SeeAlso: WriteAppletHeader
CHAPTER 17 HTML CLASS 549

WriteAppletHeader (begin Java applet)

WriteAppletHeader( control ,class, width, height )

WriteAppletHeader
Writes the HTML writes the HTML code (JavaScript) to
begin a Java applet.
control An integer constant, variable, EQUATE, or expression
containing the control number of the Window control
corresponding to the Java applet. This is typically the
field equate for the control.
class A string constant, variable, EQUATE, or expression
containing the name of the Java Support Library (JSL)
class instantiated by the applet.
width An integer constant, variable, EQUATE, or expression
containing the width of the Window control correspond-
ing to the Java applet.
hieght An integer constant, variable, EQUATE, or expression
containing the height of the Window control correspond-
ing to the Java applet.
The WriteAppletHeader method writes the HTML code (JavaScript) to
begin a Java applet. End the Java applet with the WriteAppletFooter method.

Example:
[Link] PROCEDURE(*HtmlClass Target)

Height SIGNED,AUTO
Width SIGNED,AUTO
CODE
GetPosition([Link],,,Width,Height)
[Link]([Link],[Link](),Width,Height)
[Link](Target)
[Link]

SeeAlso: WriteAppletFooter
550 IBC LIBRARY REFERENCE

WriteAppletOptParameter (write Java applet parameter)

WriteAppletOptParameter( parameter, value )

WriteAppletOptParameter
Writes the HTML to set an applet parameter.
parameter A string constant, variable, EQUATE, or expression
containing the name of the applet parameter to receive
the value.
value A string constant, variable, EQUATE, or expression
containing the value to assign to the applet parameter.
The WriteAppletOptParameter method writes the HTML (JavaScript) to
set an applet parameter.

Implementation: The WriteAppletOptParameter method only writes the HTML if value is not
null. The WriteAppletOptParameter method calls the WriteAppletParameter
method.

Example:
[Link] PROCEDURE(*HtmlClass Target)

CurFont HtmlFontClass
CODE

[Link](CurFont)
[Link] = [Link]()

[Link](Target, [Link])
[Link]('Text', [Link])
[Link]('Align', [Link]())
[Link](CurFont)
IF ([Link])
[Link]('Wrap', '1')
END
IF ([Link])
[Link]('AutoSpotLink', [Link])
END

SeeAlso: WriteAppletParameter
CHAPTER 17 HTML CLASS 551

WriteAppletParameter (write Java applet parameter)

WriteAppletParameter( parameter, value )

WriteAppletParameter
Writes the HTML to set an applet parameter.
parameter A string constant, variable, EQUATE, or expression
containing the name of the applet parameter to receive
the value.
value A string constant, variable, EQUATE, or expression
containing the value to assign to the applet parameter.
The WriteAppletParameter method writes the HTML (JavaScript) to set an
applet parameter.

Implementation: Use the WriteAppletParameter method when value is not null. Use the
WriteAppletOptParameter method when value may be null.

Example:
[Link] PROCEDURE(*HtmlClass Target)
ForeColor LONG,AUTO
BackColor LONG,AUTO
CODE
GETFONT([Link],,, ForeColor)
BackColor = [Link]()
IF (ForeColor <> 0) AND (ForeColor <> COLOR:None)
[Link]('ForeColor', IC:RGB(ForeColor))
END
IF (BackColor <> COLOR:None)
[Link]('BackColor', IC:RGB(BackColor))
END

SeeAlso: WriteAppletOptParameter
552 IBC LIBRARY REFERENCE

WriteAppletUAID (write Java applet uniqueId)

WriteAppletUAID( control )

WriteAppletUAID Writes the HTML writes the HTML code to set an

applet UAID parameter.
control An integer constant, variable, EQUATE, or expression
containing the control number of the Window control
corresponding to the Java applet. This is typically the
field equate for the control.
The WriteAppletUAID method writes the HTML to set an applet UAID
parameter. The UAID parameter uniquely identifies the applet. All
communication with the applet uses this UAID value.

Implementation: The WriteAppletUAID method calls the WriteAppletParameter method.

Example:
[Link] PROCEDURE |
(SIGNED Feq,STRING AppletName,STRING ClassName,SIGNED Width,SIGNED Height)
CODE
[Link](AppletName,'ClarionLoader',Width,Height)
[Link]('className',ClassName)
[Link](Feq)

SeeAlso: WriteAppletParameter
CHAPTER 17 HTML CLASS 553

WriteChildAppletFooter (endchild Java applet)

WriteChildAppletFooter
The WriteChildAppletFooter method writes the HTML code (JavaScript)
to end a nested Java applet started by the WriteChildAppletHeader method
within a container applet. A container applet can contain other Java applets.
Container applets and their children require less HTML code and load
quicker than a corresponding set of individual applets.

Example:
[Link] PROCEDURE(*WebControlQueue TabControls,|
*HtmlClass Target,SIGNED Alignment,SIGNED SelectedTabFeq)
!data declarations
CODE
NumRecords = RECORDS(TabControls)
IF (NumRecords > 0)
[Link](Target)
TabNum = 1
[Link]([Link], 'ClarionTabControl', MaxX, MaxY)
LOOP CurIndex = 1 TO NumRecords
GET(TabControls, CurIndex)
ThisControl &= [Link]
IF ([Link]())
[Link]('tab' & TabNum, [Link])
[Link](Target)
[Link]
TabNum = TabNum + 1
END
END
[Link]
[Link](Target)
END

SeeAlso: WriteChildAppletHeader, WriteContainerAppletHeader

554 IBC LIBRARY REFERENCE

WriteChildAppletHeader (begin child Java applet)

WriteChildAppletHeader( name, control )

WriteChildAppletHeader
Writes the HTML code to begin a nested Java applet.
name A string constant, variable, EQUATE, or expression
containing the name of the applet.
control An integer constant, variable, EQUATE, or expression
containing the control number of the Window control
corresponding to the Java applet. This is typically the
field equate for the control.
The WriteChildAppletHeader method writes the HTML code to begin a
nested Java applet within a container applet. A container applet can contain
other Java applets. Container applets and their children require less HTML
code and load quicker than a corresponding set of individual applets.

End the nested Java applet with the WriteChildAppletFooter method.

SeeAlso: WriteChildAppletFooter, WriteContainerAppletHeader

CHAPTER 17 HTML CLASS 555

WriteContainerAppletHeader (begin container applet)

WriteContainerAppletHeader( control, class, width, height )

WriteContainerAppletHeader
Writes the HTML code to begin a container applet.
control An integer constant, variable, EQUATE, or expression
containing the control number of the Window control
corresponding to the Java applet. This is typically the
field equate for the control.
class A string constant, variable, EQUATE, or expression
identify the JSL container class.
width An integer constant, variable, EQUATE, or expression
containing the width of the applet in dialog units.
height An integer constant, variable, EQUATE, or expression
containing the height of the applet in dialog units.
The WriteContainerAppletHeader method writes the HTML code to begin
a container applet. A container applet can contain other Java applets.
Container applets and their children require less HTML code and load
quicker than a corresponding set of individual applets.

End the container applet with the WriteAppletFooter method.

SeeAlso: WriteAppletFooter
556 IBC LIBRARY REFERENCE

WriteControlFooter (endHTML control)

WriteControlFooter
The WriteControlFooter method writes the HTML code to end an HTML
control started by the WriteControlHeader method.

Implementation: The WriteControlFooter method calls the WriteFontFooter method.

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE
[Link](Target)
[Link] !write HTML for caption control header
[Link]([Link]()) !write HTML for caption control text
[Link] !write HTML for caption control footer
[Link](Target)

SeeAlso: WriteControlHeader, WriteFontFooter

WriteControlHeader (begin HTML control)

WriteControlHeader
The WriteControlHeader method writes the HTML code to begin an
HTML control. End the control with the WriteControlFooter method.

Implementation: The WriteControlHeader method calls the WriteFontHeader method.

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE
[Link](Target)
[Link] !write HTML for caption control header
[Link]([Link]()) !write HTML for caption control text
[Link] !write HTML for caption control footer
[Link](Target)

SeeAlso: WriteControlFooter, WriteFontHeader

CHAPTER 17 HTML CLASS 557

WriteEventHandler (write HTML control acceptedaction)

WriteEventHandler( action, event handler, return value )

WriteEventHandler
Writes the HTML code that defines what happens when
the end user changes the contents of a control with the
Web browser.
action An integer constant, variable, EQUATE, or expression
indicating the action to take when the change event
occurs. Typically, the GetEventAction method supplies
this value.
event handler A string constant, variable, EQUATE, or expression
naming the browser JavaScript event handler associated
with the HTML control.
return value A string constant, variable, EQUATE, or expression
indicating the JavaScript parameter value to return to the
Server for the updated control.
The WriteEventHandler method writes the HTML code that defines the
handling for a Web page control when the end user changes the contents of
the control with the Web browser.

Typically, the HTML code calls a JavaScript function that submits a request
to the Server. The request includes the control’s new value, an associated
event code, and optionally, a request to refresh the HTML page.

Implementation: The WriteEventHandler method defines a call to one of two JavaScript

functions. If action is Update:Full, WriteEventHandler defines a call to the
icSubmitForm() function; otherwise, WriteEventHandler defines a call to the
changed() function, passing action as the first parameter.

The action parameter EQUATEs are in [Link] as follows:

Update:OnBrowser EQUATE(0)
Update:Partial EQUATE(1)
Update:Full EQUATE(2)
Update:Refresh EQUATE(3)

Typically, the GetEventAction method supplies this value for the

WriteEventHandler method. See the example.
558 IBC LIBRARY REFERENCE

The event handler parameter EQUATEs are in [Link] as follows:

HTML:EntryChanged EQUATE('onChange')
HTML:TextChanged EQUATE('onChange')
HTML:CheckChanged EQUATE('onClick')
HTML:RadioChanged EQUATE('onClick')
HTML:SelectChanged EQUATE('onChange')

The changed() parameter parameter EQUATEs are in [Link] as

follows:
HTML:EntryValue EQUATE('[Link]') !control’s value
HTML:TextValue EQUATE('[Link]') !control’s value
HTML:CheckValue EQUATE('[Link]') !control’s on/off state
HTML:SelectValue EQUATE('[Link]') !selected row/tab/radio

The “this” qualifier identifies the current control object for Java enabled
browsers.

The WriteEventHandler method wrote just the black code in the following
HTML code examples:
<TD><INPUT TYPE=TEXT VALUE="00003" NAME="X30003" SIZE="10"
onChange="icSubmitForm()" OnFocus="[Link]()"></TD>

<TD><INPUT TYPE=TEXT VALUE="Dogwood Realty" NAME="X30005" SIZE="30"

onChange="changed(0,[Link],[Link])" OnFocus="[Link]()"></TD>

This Server generated HTML code defines two different controls with
different event handling behavior. On a change to the X30003 control, the
browser executes the icSubmitForm() function; on a change to the X30005
control, the browser executes the changed() function.

Example:
[Link] PROCEDURE(*HtmlClass Target)
CODE
[Link]('<<INPUT TYPE=CHECKBOX VALUE="1"')
IF ([Link]{PROP:checked})
[Link](' CHECKED')
END
[Link]([Link](Target))
[Link]|
([Link](EVENT:Accepted),HTML:CheckChanged,HTML:CheckValue)
[Link]('>')
[Link]([Link]())

SeeAlso: GetEventAction, WriteJavaScript

CHAPTER 17 HTML CLASS 559

WriteFontFooter (endHTML font)

WriteFontFooter( font )

WriteFontFooter Writes the HTML code to end a font setting started by

the WriteFontHeader method.
font The label of the HtmlFontClass object that contains the
font information to apply.
The WriteFontFooter method writes the HTML code to end a font setting
started by the WriteFontHeader method.

Example:
[Link] PROCEDURE(*HtmlClass H)
CODE
[Link]([Link])
[Link]([Link])
[Link]([Link])

SeeAlso: WriteFontHeader

WriteFontHeader (begin HTML font)

WriteFontHeader( font )

WriteFontHeader Writes the HTML code to begin a font setting.

font The label of the HtmlFontClass object that contains the
font information to apply.
The WriteFontHeader method writes the HTML code to begin a font
setting. End the font setting with the WriteFontFooter method.

Example:
[Link] PROCEDURE
CODE
IF (NOT [Link] AND [Link])
IF (RECORDS([Link]) > 0)
[Link]([Link])
END
END

SeeAlso: WriteFontFooter
560 IBC LIBRARY REFERENCE

WriteFormFooter (endHTML FORM)

WriteFormFooter
The WriteFormFooter method writes the HTML code to end an HTML
FORM started by the WriteFormHeader method.

Example:
[Link] PROCEDURE(*HtmlClass Target)
CODE
[Link]([Link]*1000,[Link])
[Link] !end the form
[Link]
[Link](Target)
[Link]('<</BODY>')
[Link]('<</HTML>')

SeeAlso: WriteFormHeader

WriteFormHeader (begin HTMLFORM)

WriteFormHeader( [attr] )

WriteFormHeader
Writes the HTML code to begin an HTML FORM.
attr A string constant, variable, EQUATE, or expression
containing the attribute to the HTML FORM. If omitted,
the method writes no attribute.
The WriteFormHeader method writes the HTML code to begin an HTML
FORM. End the FORM with the WriteFormFooter method.

to begin the HTML FORM.

Example:
[Link] PROCEDURE(*HtmlClass Target)
CODE
[Link]('<<HTML>')
[Link]('<<HEAD>')
[Link]('<<TITLE>')
[Link](Target)
[Link]('<</TITLE>')
[Link]('<</HEAD>')
[Link]('<<BODY')
[Link](' onLoad="setuptimer()" onUnload="killtimer()"')
[Link]('>')
[Link]() !begin the form
[Link](Target)

SeeAlso: WriteFormFooter
CHAPTER 17 HTML CLASS 561

WriteJavaScript (write sharedJavaScript functions)

WriteJavaScript, VIRTUAL
The WriteJavaScript method writes several HTML (JavaScript) functions.

For Java enabled browsers, the HTML code that defines the Web page can
execute these functions upon certain HTML events, such as onLoad,
onUnload, onFocus, onChange, onSubmit, etc.

WriteJavaScript is a VIRTUAL method so that other base class methods can

directly call the WriteJavaScript virtual method in a derived class. This lets
you easily implement your own custom version of this method.

Implementation: The WriteJavaScript method generates the following JavaScript functions:

<SCRIPT LANGUAGE="JavaScript">
function checkSubmit(form)
function setuptimer()
function setupapplet()
function dotimer()
function killtimer()
function changed(i, name, value)
function freeChangeList()
function icSubmitForm()
function reject(name)
function hotlinkto(where)
function ShowHelp(page,style)
</SCRIPT>

HTML code can associate these functions with specific HTML events, so
that the function is called when the event occurs. For example, the
WriteEventHandler method associates either the icSubmitForm() or the
changed() function with an “accepted” event for an HTML control.

Example:
[Link] PROCEDURE(*HtmlClass Target)
CODE
[Link]([Link]*1000, [Link])
[Link]
[Link] !write shared JavaScript functions
[Link](Target)
[Link]('<</BODY>')
[Link]('<</HTML>')

SeeAlso: WriteEventHandler
562 IBC LIBRARY REFERENCE

WriteOnFocusHandler (write HTML control selectedaction)

WriteOnFocusHandler( [action] )

WriteOnFocusHandler
Writes the HTML code that defines what happens when
the end user selects the control.
action A string constant, variable, EQUATE, or expression
containing the text of the function call to execute when
the control is selected. If omitted, the browser calls the
[Link]() function.
The WriteOnFocusHandler method writes the HTML code that defines the
handling for a Web page control when the end user selects the control with
the Web browser.

Typically, the HTML code calls the [Link]() function. The “this” qualifier
identifies the current control object for Java enabled browsers. The select()
function implements standard control selection behavior.

Implementation: If action is null or omitted, WriteOnFocusHandler generates a call to the

[Link]() function; otherwise, WriteOnFocusHandler generates the
function call defined within the action parameter.

The WriteOnFocusHandler method wrote just the black code in the following
HTML code example:
<TD><INPUT TYPE=TEXT VALUE="00003" NAME="X30003" SIZE="10"
onChange="icSubmitForm()" OnFocus="[Link]()"></TD>

This Server generated HTML code defines a control such that, when the
control is selected (gains focus), the browser executes the [Link]()
function.

Example:
[Link] PROCEDURE(*HtmlClass Target)
CODE
[Link]([Link], TRUE)
[Link]('<<INPUT TYPE=TEXT')
[Link](' VALUE="')
[Link]([Link]())
[Link]('"')
[Link]([Link](Target))
[Link](' SIZE="' & INT(([Link]{PROP:width} + 2)/4) & '"')
[Link]|
([Link](EVENT:Accepted),HTML:EntryChanged,HTML:EntryValue)
[Link] !set up gain focus handling
[Link]('>')
CHAPTER 17 HTML CLASS 563

WriteRefreshTimer (write HTML timer refresh)

WriteRefreshTimer( delay )

WriteRefreshTimer
Writes the HTML code that defines an automatic timed
page refresh.
delay An integer constant, variable, EQUATE, or expression
containing the number of seconds to delay before
refreshing the HTML page.
The WriteRefreshTimer method writes the HTML code that defines an
automatic timed page refresh. The HTML code requests a new page from the
same Server instance that generated the current page.

Implementation: If delay is not zero (0), WriteRefreshTimer generates a META HTTP

segment that defines the delay period and the action to take when the period
expires. The WriteRefreshTimer method wrote just the black code in the
following HTML code fragment:
<HTML>
<META HTTP-EQUIV="REFRESH" CONTENT="10;URL=/PUBLIC/[Link].672137224">
<HEAD>

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE
[Link]('<<HTML>')
IF ([Link] = Update:Refresh)
[Link]([Link])
END
[Link]('<<HEAD>')
!more page header code
564 IBC LIBRARY REFERENCE

WriteSpace(write HTML space)

WriteSpace( number )

WriteSpace Writes HTML non-breaking spaces.

number An integer constant, variable, EQUATE, or expression
containing the number of spaces to write.
The WriteSpace method writes HTML non-breaking spaces. The HtmlClass
object uses this method to indent menus.

Implementation: The WriteSpace method writes number non-breaking HTML spaces. The
HTML symbol for these spaces (across all browsers) is &nbsp.

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE
[Link]('<<NOBR>')
[Link](([Link]()-1)*2)
[Link]([Link]())
[Link]('<</NOBR><<BR>')
CHAPTER 17 HTML CLASS 565

WriteSubmitApplet (write Java applet coordinator)

WriteSubmitApplet( [timer] [,action] )

WriteSubmitApplet
Writes the HTML code that defines an applet to coordi-
nate communication between the Application Broker and
the Java controls on the page.
timer An integer constant, variable, EQUATE, or expression
containing the milliseconds between browser timer
events (the speed of the browser timer). This is typically
a function of the value of the
[Link] property. If omitted,
timer defaults to zero (0).
action An integer constant, variable, EQUATE, or expression
indicating the action to invoke when the timer period
expires. This is typically the value of the
[Link] property. If omitted,
action defaults to zero (0).
The WriteSubmitApplet method writes the HTML code that defines an
applet to coordinate communication between the Application Broker and the
Java controls on the page

Implementation: The WriteSubmitApplet method wrote the following HTML code fragment:
<<applet NAME="AppSubmit" CODEBASE="/" CODE=[Link] ARCHIVE="/
[Link]" MAYSCRIPT WIDTH=2 HEIGHT=2>
<param name=cabbase value="/[Link]">
<param name=USID value="/PUBLIC/ORDERS/[Link].1389494281">
<param name=className value="ClarionCOM">
<param name=UAID value="524289">
<param name=NumListBoxes value="0">
</applet>

Example:
[Link] PROCEDURE(*HtmlClass Target)
CODE
[Link]([Link]*1000,[Link])
[Link]
[Link]
[Link](Target)
[Link]('<</BODY>')
[Link]('<</HTML>')

SeeAlso: [Link], [Link]

566 IBC LIBRARY REFERENCE

WriteTableFooter (endHTMLTABLE)
WriteTableFooter
The WriteTableFooter method writes the HTML code to end an HTML
TABLE started by the WriteTableHeader method.

Example:

SeeAlso: WriteTableHeader

WriteTableHeader (begin HTMLTABLE)

WriteTableHeader( [attr] )

WriteTableHeader
Writes the HTML code to begin an HTML TABLE.
attr A string constant, variable, EQUATE, or expression
containing the attribute to the HTML TABLE. If omit-
ted, the method writes no attribute.
The WriteTableHeader method writes the HTML code to begin an HTML
TABLE. End the TABLE with the WriteTableFooter method.

Example:

SeeAlso: WriteTableFooter
CHAPTER 17 HTML CLASS 567

WriteTableNewCol (begin HTMLTABLECELL)

WriteTableNewCol( [attr] )

WriteTableNewCol
Writes the HTML code to begin an HTML TABLE
CELL.
attr A string constant, variable, EQUATE, or expression
containing the attribute to the HTML TABLE CELL. If
omitted, the method writes no attribute.
The WriteTableNewCol method writes the HTML code to end the previous
TABLE CELL and begin a new CELL. End the CELL with the
WriteTableNewCol, WriteTableNewRow, or WriteTableFooter method.

Example:

SeeAlso: WriteTableFooter, WriteTableNewRow

WriteTableNewRow (begin HTMLTABLEROW)

WriteTableNewRow( [attr] )

WriteTableNewRow
Writes the HTML code to begin an HTML TABLE
ROW.
attr A string constant, variable, EQUATE, or expression
containing the attribute to the HTML TABLE ROW. If
omitted, the method writes no attribute.
The WriteTableNewRow method writes the HTML code to end the previous
ROW and begin a new ROW. End the ROW with the WriteTableNewRow or
WriteTableFooter method.

Example:

SeeAlso: WriteTableFooter
568 IBC LIBRARY REFERENCE

WriteText (write breakable textstring)

WriteText( text )

WriteText Writes HTML breakable text string.

text A string constant, variable, EQUATE, or expression
containing the text to write, including ASCII carriage
return characters to mark the break points.
The WriteText method writes HTML breakable text string. The HtmlClass
object uses this method to indent menus.

Implementation: The WriteSpace method writes HTML to represent text by translating ASCII
carriage return characters within text to their HTML equivalent: <<BR>.

Example:
[Link] PROCEDURE(*HtmlClass Target)
CODE
IF ([Link])
[Link]([Link]())
ELSE
[Link]('<<NOBR>')
[Link]([Link]())
[Link]('<</NOBR>')
END
CHAPTER 18 TEXT OUTPUT CLASS 569

TEXT OUTPUT CLASS

TextOutPutClassConcepts

TextOutPutClass provides basic text file handling, including creating,

opening, writing, and closing a text file. This basic file handling is
fundamental to the generation of HTML code and Java Support Library
(JSL) data by your Web-enabled Clarion application.

Typically your Web-enabled application instantiates a single global

TextOutPutClass object.

Relationship toOther Internet Builder Classes

The JslManagerClass instantiates its own TextOutputClass object to write

JSL data and protocol that enables fast partial page updates to (just the Java
controls on) the generated Web pages.

The HttpClass uses the TextOutputClass to write the HTTP header

information that preceeds the generated HTML code.

The HtmlClass is derived from the TextOutputClass. The TextOutputClass

provides basic file handling methods, including creating, opening, writing,
and closing the text file. The HtmlClass adds all the HTML-specific text
writing capability.

Internet ConnectTemplate Implementation

The Internet Connect Templates do not directly refer to any TextOutputClass

objects.

SourceFiles

The TextOutputClass source code is installed by default to the \LIBSRC

folder. The specific class declarations reside in the following files and their
method definitions reside in the corresponding .CLW files.

[Link] TextOutputClass
572 IBC LIBRARY REFERENCE

TextOutputClass Methods
The TextOutputClass contains the methods listed below.

Functional Organization—ExpectedUse

As an aid to understanding the TextOutputClass , it is useful to organize its

various methods into two categories according to their expected use—the
primary interface and the virtual methods. This organization reflects what we
believe is typical use of these methods.

Primary Interface Methods

The primary interface methods, which other IBC Library objects call fairly
routinely, can be further divided into three categories:

Housekeeping (one-time) Use:

Mainstream Use:
CreateOpen create and open the file
Open open the file
GetSize return file size
Write write text
Writeln write text and newline marker
Close close the file

Occasional Use:

Virtual Methods

The TextOutputClass has no virtual methods.

CHAPTER 18 TEXT OUTPUT CLASS 573

Close(closethefile)
Close
The Close method closes the text file.

Implementation: The Close method calls the Writeln method to write any buffer contents to
disk and add a trailing carriage return.

Example:
[Link] PROCEDURE(*HtmlClass Target,STRING HtmlFilename)
CODE
[Link](HtmlFilename,[Link], | !open text file
[Link],[Link])
[Link](Target)
[Link](Target,0,[Link]())
[Link](Target)
[Link] !close text file
[Link] = TRUE

SeeAlso: Writeln
574 IBC LIBRARY REFERENCE

CreateOpen(create andopenthefile)
CreateOpen( filename )

CreateOpen Opens the text file.

filename A string constant, variable, EQUATE, or expression
containing the pathname of the file to open.
The CreateOpen method opens the named text file, creating it first if
necessary.

Implementation: The CreateOpen method creates a file declared in [Link] as

follows:
TargetFilename CSTRING(FILE:MaxFilepath)
MAXTARGETLEN EQUATE(8000)

TargetFile FILE,DRIVER('DOS'),NAME(TargetFilename),PRE(TGT),THREAD,CREATE
RECORD RECORD,PRE()
TextLine CSTRING(MAXTARGETLEN+1)
END
END

Example:
[Link] PROCEDURE
Protocol CSTRING(20)
ErrorNum CSTRING(5)
ErrorMsg CSTRING(30)

CODE
[Link]([Link]) !open text file
Protocol = [Link]('HttpProtocol')
ErrorNum = [Link]('ErrorNum')
ErrorMsg = [Link]('ErrorMsg')
[Link](Protocol & ' ' & ErrorNum & ' ' & ErrorMsg)
[Link]()
[Link]()
[Link]() !close text file
CHAPTER 18 TEXT OUTPUT CLASS 575

GetSize (return file size)

GetSize( filename ), LONG

GetSize Returns the size of the filename file.

filename A string constant, variable, EQUATE, or expression
containing the pathname of the file.
The GetSize method returns the size of the filename file in bytes. If the file
does not exist or cannot be opened, GetSize returns zero (0).

Return DataType: LONG

Example:
[Link] PROCEDURE
CODE
IF ([Link])
[Link] = [Link]([Link]) !get file size
ASSERT([Link]<>0)

IC:RemoveFile([Link])
IC:RenameFile([Link], [Link])
[Link]('Content-length', '' & [Link])
ELSE
[Link] = [Link]
END
[Link] = IC:GetStrDateTime(TODAY(), CLOCK())
[Link] = [Link]
[Link]()
[Link]()
576 IBC LIBRARY REFERENCE

Open(openthefile)
Open( filename )

Open Opens the text file.

filename A string constant, variable, EQUATE, or expression
containing the pathname of the file to open.
The Open method opens the named text file. The file must exist, otherwise
the Open method fails.

Implementation: The CreateOpen method offers to GPF (halt) the program if the file does not
exist. You (or the end user) may allow the program to continue, but
subsequent attempts to access the file will fail.

Example:
[Link] PROCEDURE
CODE

[Link]([Link]) !open the text file

[Link]('<<HTML>')
[Link]('<<P>Error code: ' & [Link] & '<</P>')
[Link]('<</HTML>')
[Link]() !close the file
CHAPTER 18 TEXT OUTPUT CLASS 577

Write (write text)

Write( text )

Write Writes text to the target file.

text A string constant, variable, EQUATE, or expression
containing the text to write.
The Write method writes text to the target file, without ending the line.
Multiple calls to the Write method continue to extend the current line. The
Writeln method ends the current line.

Implementation: The maximum line length is determined by the file definition, typically
supplied by the CreateOpen method.

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE
[Link]('<<NOBR>') !begin line
[Link]([Link]()) !extend line
[Link]('<</NOBR>') !end line

SeeAlso: CreateOpen, Writeln

578 IBC LIBRARY REFERENCE

Writeln (write text andnewlinemarker)

Writeln( [text] )

Writeln Writes text and a newline marker to the target file.

text A string constant, variable, EQUATE, or expression
containing the text to write. If omitted, Writeln writes
only the newline marker.
The Writeln method writes text to the target file, ending the current line. The
Write method extends the current line.

Implementation: The Writeln method provides error checking for each write.

Example:
[Link] PROCEDURE(*HtmlClass Target)

CODE
[Link]('<<NOBR>') !begin line
[Link]([Link]()) !extend line
[Link]('<</NOBR>') !end line
!end line

SeeAlso: Write
CHAPTER 19 HTTP CLASSES 579

HTTP CLASSES

Overview 581
HttpClass Concepts ............................................................................................. 581
HttpPageBaseClass Concepts ............................................................................. 581
Relationship to Other Internet Builder Classes ................................................... 582
Internet Connect Template Implementation .........................................................582
Source Files..........................................................................................................582
HttpClass Properties 583
Arguments (incoming field data) ........................................................................ 583
BrowserInfo (Web browser properties) .............................................................. 584
Cookies (information stored on Client) .............................................................. 585
Files (WebFilesClass object) .............................................................................. 586
HttpPage (HttpPageBaseClass object) .................................................................586
ProgName (server name) .................................................................................... 587
ProcName (password protected Web page) ........................................................ 587
ServerInfo (outgoing http information) ...............................................................588
HttpClass Methods 589
Functional Organization—Expected Use ............................................................589
FinishPage (prepend http to outgoing transmission) ...........................................591
GetArguments (return incoming field data).........................................................591
GetAuthorizedInfo (get client password) ............................................................592
GetBrowserProperty (return browser property) ...................................................593
GetCookie (return cookie value) ......................................................................... 594
GetServerProperty (return outgoing http information) ........................................595
Init (initialize the HttpClass object) .....................................................................596
Kill (shut down the HttpClass object) ..................................................................596
PreparePage (prime ServerInfo for next transmission) ...................................... 597
PreparePageForBrowser (prime ServerInfo for HTML transmission) ............... 598
PreparePageForJava (prime ServerInfo for JSL transmission) ...........................599
PrepareUnauthorized (prime ServerInfo for password challenge) ......................600
ProcessHeader (process incoming http) .............................................................. 601
SendCookies (update cookies on client) ..............................................................601
SetBrowserProperty (set browser property) ....................................................... 602
SetCookie (set cookie value) .............................................................................. 603
SetProgName (set server name) ...........................................................................604
580 IBC LIBRARY REFERENCE

SetProcName (set protected area name) ............................................................. 605

SetServerProperty (set outgoing http item) ........................................................ 606
HttpPageBaseClass Properties 607
ExpireDateTime (transmission expiration timestamp) ........................................607
FileHandler (TextOutputClass object) ................................................................ 607
FileLen (transmission size) ................................................................................. 608
GotHtmlBody (http only transmission) ...............................................................608
HtmlFilename (HTML/JSL transmission file) ....................................................609
Http (HttpClass object) ........................................................................................609
NowDateTime (transmission timestamp) ............................................................610
PageFilename (entire transmission file) ..............................................................610
Status (status of Client request) .......................................................................... 611
HttpPageBaseClass Methods 612
Functional Organization—Expected Use ............................................................612
AppendDefaultBody (supply default HTML) .....................................................613
FinishPage (prepend http to outgoing transmission) .......................................... 614
HandleStatusCode (process status code) .............................................................615
Init (initialize the HttpPageBaseClass object) .....................................................616
Kill (shut down the HttpPageBaseClass object) ................................................. 617
PreparePage (set outgoing http items) ................................................................ 617
PreparePageBody (virtual to set outgoing http items) ........................................ 618
SetupHttpStatus (set outgoing http status indicators) ..........................................619
WritePageBody (write outgoing http body)........................................................ 620
CHAPTER 19 HTTP CLASSES 581

HttpClassConcepts

Hyper-Text Transfer Protocol (http) is the protocol that web servers use to
transmit HTML pages to internet browsers. Conversely, internet browsers
use http to transmit their requests to web servers.

Not surprisingly, then, the IBC Library’s HttpClass class has two http related
jobs:
• To process incoming http headers sent from the Client to the
Server. Specifically, it extracts the browser type, any
authorization information, and any cookies (Server information
stored on the Client) from the incoming http.
• To build http headers for outgoing HTML and Java Support
Library (JSL) data, including cookies, demands for
authorization, error messages, content size, etc.

HttpPageBaseClassConcepts

The HttpPageBaseClass prepares and writes the outgoing http headers for
HttpClass objects.

The HttpPageBaseClass collects the final pieces of http information not

provided by the HttpClass, then extracts all the outgoing http information in
the proper sequence (from the [Link] property), and finally
prepends it to the outgoing HTML or JSL data.
582 IBC LIBRARY REFERENCE

Relationship toOther Internet Builder Classes

The BrokerClass creates and manages a single instance of the HttpClass. The
BrokerClass relies on this HttpClass object to do both jobs described above.
That is, to process incoming http headers, and to build http headers for
outgoing HTML and JSL data.

The HttpClass is derived from the HttpBaseClass class. The HttpBaseClass

class is an abstract class whose methods are not defined. It provides a
reference for all of its derived classes, including the HttpClass.

The HttpClass relies on the WebFilesClass to provide appropriate filenames

and pathnames. It also relies on the TextOutputClass to provide basic file
handling, including creating, opening, writing to, and closing its files.

Internet ConnectTemplate Implementation

The BrokerClass creates and manages a single instance of the HttpClass.

Therefore the template generated code does not directly reference the
HttpClass object.

SourceFiles

The HttpClass source code is installed by default to the \LIBSRC folder. The
specific class declarations are in the following files and their method
definitions are in the corresponding .CLW files.

[Link] HttpClass
CHAPTER 19 HTTPCLASS 583

HttpClass Proper ties

The HttpClass contains the properties listed below.

Arguments (incomingfield data)

Arguments ANY, PROTECTED
The Arguments property contains data entered through the Client’s Web
page. The GetArguments method returns the value of the Arguments
property.

This property is PROTECTED, therefore, it can only be referenced by an

HttpClass method, or a method in a class derived from HttpClass.

Implementation: The Arguments property contains a list of field assignments of the form
‘field1=value1&field2=value2&fieldN=valueN’. The SubmitItemClass
manages a single field assignment within this string.

The ProcessHeader method sets the value of the Arguments property based
on the incoming http which contains something like the following http
fragment:
GET /PUBLIC/[Link].1043595275?X30003=OH&X30005=Ohio&X30006=OK HTTP/1.0

SeeAlso: GetArguments, ProcessHeader, SubmitItemClass

584 IBC LIBRARY REFERENCE

BrowserInfo (Webbrowser properties)

BrowserInfo &HttpInfoQueue
The BrowserInfo property is a reference to a structure that contains
information about the Client’s Web browser.

The SetBrowserProperty method adds BrowserInfo items. The

GetBrowserProperty method returns specific BrowserInfo items.

Implementation: The BrowserInfo property is inherited from the HttpBaseClass class. It

contains information extracted from the incoming http header by the
ProcessHeader method. The information is stored in a queue with the same
structure as the HttpInfoQueue declared in [Link] as follows:
HttpInfoQueue QUEUE,TYPE
Name CSTRING(40)
Value CSTRING(255)
Special SIGNED
END

Typical BrowserInfo items include:

User-Agent: Mozilla/2.0 (compatible; MSIE 3.01; Windows 95)
Authorization: Basic OnBhc3M=
Extension: Security/Remote-Passphrase
Accept-Language: en
UA-pixels: 800x600
UA-color: color8
UA-OS: Windows 95
UA-CPU: x86

SeeAlso: GetBrowserProperty, ProcessHeader, SetBrowserProperty

CHAPTER 19 HTTPCLASS 585

Cookies(informationstoredonClient)
Cookies&CookesQueue
The Cookies property is a reference to a structure that contains information
stored on the Client machine (cookies) at the request of the Server.

A server can send data to a client which the client stores locally. This is
known as a cookie. A cookie contains a range of URLs for which it is valid.
When the client returns to a URL within that range, the server can query the
cookie and use its data. A server cannot query a cookie from another server.

This mechanism provides a way to maintain persistent user-specific

information between remote computing sessions. For example, an
application which requires a user to provide a username can use a cookie to
avoid the Login process after the first visit. Your web-enabled applications
can use cookies to store user preferences such as the default city and state for
new records. These settings can be retrieved each time the user runs the
application over the web.

Cookies are machine and browser specific so a client who accesses a site
from more than one machine or uses more than one browser will need to
provide the cookie information once for each machine and browser.

The GetCookie method returns a specific cookie item from the Client. The
SetCookie method sets a specific cookie item to send to the Client. The
SendCookies method updates the cookies on the Client machine.

Implementation: The Cookies property is inherited from the HttpBaseClass class. It contains
information (cookies) extracted from the incoming http header by the
ProcessHeader method. The information is stored in a queue with the same
structure as the CookiesQueue declared in [Link] as follows:
CookiesQueue QUEUE,TYPE
Name CSTRING(40)
Value CSTRING(255)
Path CSTRING(255)
ExpireDate LONG
ExpireTime LONG
Modified BYTE
END

SeeAlso: GetCookie, ProcessHeader, SendCookies, SetCookie

586 IBC LIBRARY REFERENCE

Files(WebFilesClassobject)
Files &WebFilesClass
The Files property is a reference to the WebFilesClass object that provides
all the filenames, pathnames, directories, and aliases required by the
HttpClass object.

Implementation: The Init method sets the value of the Files property.

SeeAlso: Init

HttpPage (HttpPageBaseClassobject)
HttpPage &HttpPageBaseClass, PROTECTED
The HttpPage property is a reference to the HttpPageBaseClass object that
prepares and writes the outgoing http headers for the HttpClass object.

This property is PROTECTED, therefore, it can only be referenced by an

HttpClass method, or a method in a class derived from HttpClass.

Implementation: The PreparePage method sets the value of the HttpPage property. The
HttpPage property inputs the final pieces of information into the ServerInfo
property, then extracts all the outgoing http information in the proper
sequence from the ServerInfo property, and prepends it to the outgoing
HTML or JSL data.

SeeAlso: HttpPageBaseClass, PreparePage, ServerInfo

CHAPTER 19 HTTPCLASS 587

ProgName (server name)

ProgName CSTRING(255), PROTECTED
The ProgName property identifies the Server. Typically this is the name of
the program as launched by the Application Broker; however, it may be any
value that appropriately identifies the Server.

The SetProgName method sets the value of this property.

This property is PROTECTED, therefore, it can only be referenced by an

HttpClass method, or a method in a class derived from HttpClass.

Implementation: The HttpClass object uses the ProgName property to identify the Server for
password protected areas and for cookies.

SeeAlso: Cookies, SetProgName, PrepareUnauthorized

ProcName (password protectedWebpage)

ProcName CSTRING(255), PROTECTED
The ProcName property names a Web page that is password protected.
Typically this is the name of the procedure that generates the protected Web
page; however, it may be any value that appropriately identifies the protected
area to end users.

The SetProcName method sets the value of this property. The

PrepareUnauthorized method prepares the password challenge to send to the
Client.

This property is PROTECTED, therefore, it can only be referenced by an

HttpClass method, or a method in a class derived from HttpClass.

SeeAlso: SetProcName, PrepareUnauthorized

588 IBC LIBRARY REFERENCE

ServerInfo (outgoinghttp information)

ServerInfo &HttpInfoQueue
The ServerInfo property is a reference to a structure that contains
information about the Server transmission to the Client. This information is
passed to the Client within the outgoing http header generated by the
HttpClass object.

The GetServerProperty method returns a specific ServerInfo item. The

SetServerProperty method sets a specific ServerInfo item.

Implementation: The ServerInfo property is inherited from the HttpBaseClass class. This
property contains information set by the HttpClass object. The information is
stored in a queue with the same structure as the HttpInfoQueue declared in
[Link] as follows:
HttpInfoQueue QUEUE,TYPE
Name CSTRING(40)
Value CSTRING(255)
Special SIGNED
END

The HttpClass object adds information to the ServerInfo queue as the

informaion becomes available. Then, the HttpClass object uses the HttpPage
property (an HttpPageBaseClass object) to extract the information from the
queue in the sequence needed to create the http header. The HttpClass object
frees and reallocates the ServerInfo queue between page transmissions.

Typical ServerInfo items include:

HttpProtocol: HTTP/1.0
Server:
Content-length:
Content-type:
Last-modified:
Date:
Expires:
Allowed:
MIME-Version:
WWW-authenticate:
Set-Cookie:
Pragma: no-cache
ErrorNum:
ErrorMsg:

SeeAlso: GetServerProperty, SetServerProperty

CHAPTER 19 HTTPCLASS 589

HttpClass Methods
The HttpClass contains the methods listed below.

Functional Organization—ExpectedUse

As an aid to understanding the HttpClass, it is useful to organize its various

methods into two categories according to their expected use—the primary
interface and the virtual methods. This organization reflects what we believe
is typical use of these methods.

Primary Interface Methods

The primary interface methods, which you are likely to call fairly routinely
from your program, can be further divided into three categories:

Housekeeping (one-time) Use:

Init initialize the HttpClass object
Kill shut down the HttpClass object

Mainstream Use:
GetCookie return cookie value
SetCookie set cookie value
SetProcName set protected area name
SetProgName set server name

Occasional Use:
ProcessHeader process incoming http
GetArguments return incoming field data
GetAuthorizedInfo get Client password
PreparePageForBrowserprime ServerInfo for HTML page
PreparePageForJava prime ServerInfo for JSL page
PrepareUnauthorized prime ServerInfo for password page
FinishPage prepend http to outgoing page
590 IBC LIBRARY REFERENCE

Virtual Methods

GetBrowserProperty return browser property

GetServerProperty return outgoing http information
SetBrowserProperty set browser property
SetServerProperty set outgoing http information
PreparePage prime ServerInfo for next page
SendCookies update cookies on client
CHAPTER 19 HTTPCLASS 591

FinishPage (prependhttp to outgoingtransmission)

FinishPage
The FinishPage method writes the http text appropriate to the outgoing
transmission (HTML code or JSL data) then prepends it to the outgoing
transmission. Finally, FinishPage prepares the HttpClass object to handle the
next transmission.

Implementation: The FinishPage method extracts http information from the ServerInfo
property, formats it to HTTP/1.0 standards, then prepends it to the outgoing
transmission.

The FinishPage method prepares for the next transmission by DISPOSEing

the HttpPage property and the ServerInfo property.

Example:
[Link] PROCEDURE(STRING Filename,SIGNED Security,BYTE dontmove)
CODE
[Link](200, Filename)
[Link]()
[Link](Filename,Security,dontmove)

SeeAlso: HttpPage, ServerInfo

GetArguments (return incomingfield data)

GetArguments, STRING
The GetArguments method returns the value of the Arguments property.

Return DataType: STRING

Example:
[Link] PROCEDURE
CODE
RETURN [Link]()

SeeAlso: Arguments
592 IBC LIBRARY REFERENCE

GetAuthorizedInfo (get client password)

GetAuthorizedInfo( username, password )

GetAuthorizedInfo
Gets the Client’s (end user) username and password.
username A string variable to receive the Client’s username.
password A string variable to receive the Client’s password.
The GetAuthorizedInfo method gets the Client’s (end user) username and
password.

Implementation: The GetAuthorizedInfo method calls the GetBrowserProperty method to get

the information from the BrowserInfo property.

Example:
[Link] PROCEDURE(STRING AreaName,*STRING User,*STRING Password)
CODE
[Link](AreaName)
[Link](User, Password)

SeeAlso: BrowserInfo, GetBrowserProperty

CHAPTER 19 HTTPCLASS 593

GetBrowserProperty (return browser property)

GetBrowserProperty( property ), STRING, VIRTUAL

GetBrowserProperty
Returns the specified browser property.
property A string constant, variable, EQUATE, or expression
identifying the property to return.
The GetBrowserProperty method returns a browser property that was set
by the SetBrowserProperty method.

GetBrowserProperty is a VIRTUAL method so that other base class methods

can directly call the GetBrowserProperty virtual method in a derived class.
This lets you easily implement your own custom version of this method.

Implementation: The GetBrowserProperty method gets the information from the BrowserInfo
property.

Return DataType: STRING

Example:
[Link] PROCEDURE
BrowserType STRING(100)
CODE
BrowserType = [Link]('User-Agent')
IF (INSTRING('MSIE 4.', BrowserType, 1, 1))
[Link] &= IE40
ELSIF (INSTRING('MSIE 3.', BrowserType, 1, 1))
[Link] &= IE30
ELSIF (INSTRING('Mozilla/4.', BrowserType, 1, 1))
[Link] &= Mozilla4
ELSIF (INSTRING('Mozilla/3.', BrowserType, 1, 1))
[Link] &= NetScape3x
END

SeeAlso: BrowserInfo, SetBrowserProperty

594 IBC LIBRARY REFERENCE

GetCookie (return cookie value)

GetCookie( cookie ), STRING

GetCookie Returns the specified cookie value.

cookie A string constant, variable, EQUATE, or expression
identifying the cookie whose value to return.
The GetCookie method returns the specified cookie value.

Implementation: The GetCookie method gets the information from the Cookies property. The
Cookies property may contain cookie values that came from the Client (set
by the ProcessHeader method) as well as cookie values set by the Server (set
by the SetCookie method) to send to the Client.

Return DataType: STRING

Example:
PrepareProcedure ROUTINE
DefaultCity = [Link]('City')

ProcedureReturn ROUTINE
[Link]('City', DefaultCity)

SeeAlso: Cookies, SetCookie

CHAPTER 19 HTTPCLASS 595

GetServerProperty (return outgoinghttp information)

GetServerProperty( item ), STRING, VIRTUAL

GetServerProperty
Returns the specified outgoing http information.
item A string constant, variable, EQUATE, or expression
identifying the item to return.
The GetServerProperty method returns an information item that was set by
the SetServerProperty method. The returned information is typically used to
build the outgoing http headers.

GetServerProperty is a VIRTUAL method so that other base class methods

can directly call the GetServerProperty virtual method in a derived class.
This lets you easily implement your own custom version of this method.

Implementation: The GetServerProperty method gets the information from the ServerInfo
property.

Return DataType: STRING

Example:
[Link] PROCEDURE
Protocol CSTRING(20)
ErrorNum CSTRING(5)
ErrorMsg CSTRING(30)

CODE
[Link]([Link])

Protocol = [Link]('HttpProtocol')
ErrorNum = [Link]('ErrorNum')
ErrorMsg = [Link]('ErrorMsg')

[Link](Protocol & ' ' & ErrorNum & ' ' & ErrorMsg)
[Link]()
[Link]()
[Link]()
IF ([Link])
[Link]([Link], [Link], [Link], TRUE)
ELSE
[Link]()
END

SeeAlso: ServerInfo, SetServerProperty

596 IBC LIBRARY REFERENCE

Init (initialize theHttpClassobject)

Init( files )

Init Initializes the HttpClass object.

files The label of the WebFilesClass object that provides all
the filenames, pathnames, directories, and aliases
required by the HttpClass object.
The Init method initializes the HttpClass object.

Implementation: The Init method sets the value of the Files property. It also instantiates the
BrowserInfo, Cookies, and ServerInfo properties.

Example:
[Link] PROCEDURE(STRING ProgramName, WebFilesClass Files)
CODE
[Link] &= Files
[Link] &= NEW HttpClass !instantiate new HttpClass object
[Link](Files) !and initialize it
[Link](ProgramName)

Kill (shut down theHttpClassobject)

Kill
The Kill method frees all memory allocated during the life of the object and
performs any other required termination code.

Implementation: The Kill method DISPOSEs the BrowserInfo, Cookies, and ServerInfo
properties.

Example:
[Link] PROCEDURE
CODE
[Link]
IF (NOT ([Link] &= NULL))
[Link] !shut down HttpClass object
DISPOSE([Link])
END
CHAPTER 19 HTTPCLASS 597

PreparePage (prime ServerInfo for next transmission)

PreparePage( http page, status [,filename] ), VIRTUAL, PROTECTED

PreparePage Primes the ServerInfo property with http information

pertaining to the next outgoing transmission.
http page The label of the HttpPageBaseClass object that prepares
and writes the outgoing http header for the HttpClass
object.
status An integer constant, variable, EQUATE, or expression
containing the status code to send to the Client. The
status code indicates the status of the Server’s response
to the Client’s request.
filename A string constant, variable, EQUATE, or expression
containing the name of the file to send to the Client
browser. If omitted, the HttpClass object creates a
dummy page to send.
The PreparePage method primes the ServerInfo property with http
information pertaining to the next outgoing transmission (HTML or JSL
data).

PreparePage is a VIRTUAL method so that other base class methods can

directly call the PreparePage virtual method in a derived class. This lets you
easily implement your own custom version of this method.

This method is PROTECTED, therefore, it can only be called by an

HttpClass method, or a method in a class derived from HttpClass.

Implementation: The PreparePage method prepares for the transmission by DISPOSEing the
HttpPage property and the ServerInfo property. Then it calls the
[Link] method to prime the ServerInfo property
with http settings for the next transmission.

Typically, the filename parameter names the file containing HTML code or
JSL data prepared by the WebWindow class object. The BrokerClass object
passes the filename to the HttpClass object, which passes it on to the
HttpPageBaseClass object.

Example:
[Link] PROCEDURE(SIGNED status, <STRING Filename>)
HttpPage &HttpPageBaseClass

CODE
HttpPage &= NEW HttpPageBrowserClass
[Link](HttpPage, status, Filename)

SeeAlso: HttpPage, [Link], [Link],

ServerInfo
598 IBC LIBRARY REFERENCE

PreparePageForBrowser (prime ServerInfo for HTML transmission)

PreparePageForBrowser( status [,filename] )

PreparePageForBrowser
Primes the ServerInfo property with http information
pertaining to the next outgoing HTML transmission.
status An integer constant, variable, EQUATE, or expression
containing the status code to send to the Client. The
status codes indicates the Server’s response to the
Client’s request.
filename A string constant, variable, EQUATE, or expression
containing the name of the file to send to the Client. If
omitted, ...
The PreparePageForBrowser method primes the ServerInfo property with
http information pertaining to the next outgoing HTML transmission.

Implementation: The PreparePageForBrowser method calls the PreparePage method to prime

the ServerInfo property with http settings for the transmission.

Example:
[Link] PROCEDURE(<STRING Filename>)
HttpPage &HttpPageBaseClass
CODE
[Link](401, Filename) !prepare password challenge page
[Link]('WWW-authenticate','basic realm="'&[Link]&'"')

[Link](STRING Filename, SIGNED Security, BYTE dontmove)

CODE
[Link](200, Filename) !prepare new html page
IF ([Link])
[Link]('Pragma', 'no-cache')
END
[Link]()
[Link](Filename, Security, dontmove)

SeeAlso: PreparePage, [Link], ServerInfo

CHAPTER 19 HTTPCLASS 599

PreparePageForJava (prime ServerInfo for JSLtransmission)

PreparePageForJava( status [,filename] )

PreparePageForJava
Primes the ServerInfo property with http information
pertaining to the next outgoing JSL data transmission.
status An integer constant, variable, EQUATE, or expression
containing the status code to send to the Client. The
status codes indicates the Server’s response to the
Client’s request.
filename A string constant, variable, EQUATE, or expression
containing the name of the file to send to the Client. If
omitted, ...
The PreparePageForJava method primes the ServerInfo property with http
information pertaining to the next outgoing JSL data transmission.

Implementation: The PreparePageForJava method calls the PreparePage method to prime the
ServerInfo property with http settings for the transmission.

Example:
[Link] PROCEDURE(STRING Filename, SIGNED Security)
CODE
[Link](200, Filename)
[Link]()
[Link](Filename, Security, TRUE)

SeeAlso: PreparePage, [Link], ServerInfo

600 IBC LIBRARY REFERENCE

PrepareUnauthorized(prime ServerInfo for password challenge)

PrepareUnauthorized( [filename] )

PrepareUnauthorized
Primes the ServerInfo property with http information
pertaining to a password protected area.
filename A string constant, variable, EQUATE, or expression
containing the name of the file to send to the Client. If
omitted, ...
The PrepareUnauthorized method primes the ServerInfo property with http
information pertaining to a password protected HTML page.

Implementation: The PrepareUnauthorized method calls the PreparePage method to prime the
ServerInfo property with http settings for the transmission.

Example:
[Link] PROCEDURE(STRING Filename, SIGNED Security)
CODE
[Link](Filename)
IF ([Link])
[Link]('Pragma', 'no-cache')
END
[Link]()
[Link](Filename, Security, TRUE)

SeeAlso: PreparePage, ServerInfo

CHAPTER 19 HTTPCLASS 601

ProcessHeader (processincominghttp)
ProcessHeader( http text )

ProcessHeader Processes incoming http headers.

http text A string constant, variable, EQUATE, or expression
containing the http text to process.
The ProcessHeader method processes incoming http headers. It extracts
information for the BrowserInfo property, the Cookies property, and the
Arguments property.

Implementation: The ProcessHeader method clears and reloads the Arguments, BrowserInfo,
and Cookies properties.

Example:
[Link] PROCEDURE(STRING HeaderText)
CODE
[Link](HeaderText)

SeeAlso: Arguments, BrowserInfo, Cookies

SendCookies(update cookiesonclient)
SendCookies, VIRTUAL
The SendCookies method primes the ServerInfo property with cookie
information for the next outgoing transmission.

SendCookies is a VIRTUAL method so that other base class methods can

directly call the SendCookies virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The SendCookies method extracts current cookie information from the
Cookies property, and calls the SetServerProperty method to add the cookie
information to the ServerInfo property. The FinishPage method includes the
ServerInfo information (including the cookies) in the outgoing http.

Example:
[Link] PROCEDURE
CODE
[Link]()
[Link]()

SeeAlso: Cookies, GetCookie, ServerInfo, SetCookie

602 IBC LIBRARY REFERENCE

SetBrowserProperty (set browser property)

SetBrowserProperty( property, value ), VIRTUAL, PROTECTED

SetBrowserProperty
Sets the value of the specified browser property.
property A string constant, variable, EQUATE, or expression
identifying the property whose value to set.
value A string constant, variable, EQUATE, or expression
containing the contents of the property.
The SetBrowserProperty method sets the value of the specified browser
property. The GetBrowserProperty method returns values set by the
SetBrowserProperty method.

SetBrowserProperty is a VIRTUAL method so that other base class methods

can directly call the SetBrowserProperty virtual method in a derived class.
This lets you easily implement your own custom version of this method.

This method is PROTECTED, therefore, it can only be called by an

HttpClass method, or a method in a class derived from HttpClass.

Implementation: The SetBrowserProperty method adds items to the BrowserInfo property.

Example:
[Link]('HttpProtocol', 'HTTP/1.0')

SeeAlso: BrowserInfo, GetBrowserProperty

CHAPTER 19 HTTPCLASS 603

SetCookie (set cookie value)

SetCookie( cookie, value [,expire date] [,expire time] [,path] )

SetCookie Sets the value of the specified cookie.

cookie A string constant, variable, EQUATE, or expression
identifying the cookie whose value to set.
value A string constant, variable, EQUATE, or expression
containing the contents of the cookie. If value is set to
null (‘’), the Client’s browser deletes the cookie.
expire date An integer constant, variable, EQUATE, or expression
containing the cookie expiration date. If omitted, expire
date and expire time is set to 28 days from the present
system time.
expire time An integer constant, variable, EQUATE, or expression
containing the cookie expiration time. If omitted, expire
timedefaults to zero (0).
path A string constant, variable, EQUATE, or expression
containing the path of the cookie. If omitted, the path
defaults to null (‘’). The Client’s browser determines
how the path information is applied.
The SetCookie method sets the value of the specified cookie. When the
Client receives the cookie information, if value is set to null (‘’), the Client’s
browser deletes the cookie.

The GetCookie method returns cookie values set by the SetCookie method or
by the ProcessHeader method.

Implementation: The SetCookie method updates the Cookie property. The FinishPage method
includes the contents of the Cookie property in the outgoing http header.

Example:
PrepareProcedure ROUTINE
DefaultCity = [Link]('City')

ProcedureReturn ROUTINE
[Link]('City', DefaultCity)

SeeAlso: Cookies, FinishPage, GetCookie

604 IBC LIBRARY REFERENCE

SetProgName (set server name)

SetProgName( name )

SetProgName Sets the Server name.

name A string constant, variable, EQUATE, or expression
identifying the server.
The SetProgName method sets the Server name.

The name parameter typically contains the name of the program as launched
by the Application Broker; however, it may contain any value that
appropriately identifies the Server.

Implementation: The SetProgName method sets the value of the ProgName property. The
HttpClass object uses the ProgName property to identify the Server for
password protected areas and for cookies.

Example:
[Link](‘Net Orders’)

SeeAlso: Cookies, ProgName, PrepareUnauthorized

CHAPTER 19 HTTPCLASS 605

SetProcName (set protectedareaname)

SetProcName( name )

SetProcName Sets the name of a password protected Web page.

name A string constant, variable, EQUATE, or expression
identifying the password protected Web page.
The SetProcName method sets the name of a password protected Web page
(or area, if the protected page is the entry point to other pages).

The name parameter typically contains the name of the procedure that
generates the protected Web page; however, it may contain any value that
appropriately identifies the password protected area to end users, because
this is the name end users see when the Client browser prompts for the
password.

Implementation: The SetProcName method sets the value of the ProcName property. The
HttpClass object uses the both the ProgName and ProcName properties to
identify password protected Web pages.

Example:
[Link] PROCEDURE(STRING AreaName,*STRING User,*STRING Password)
CODE
[Link](AreaName)
[Link](User, Password)

The PrepareUnauthorized method prepares the password challenge to send to

the Client.

SeeAlso: ProcName, ProgName, PrepareUnauthorized

606 IBC LIBRARY REFERENCE

SetServerProperty (set outgoinghttp item)

SetServerProperty( name, value [,special] [,multiple] ), VIRTUAL

SetServerProperty
Sets the value of the specified outgoing http item.
name A string constant, variable, EQUATE, or expression
identifying the property whose value to set.
value A string constant, variable, EQUATE, or expression
containing the contents of the item.
special An integer constant, variable, EQUATE, or expression
indicating whether the item requires special handling. If
omitted, special defaults to zero(0).
multiple An integer constant, variable, EQUATE, or expression
indicating whether the item replaces other items with the
same name. A value of one(1) allows multiple items with
the same name; a value of zero(0) allows only one item
with the same name. If omitted, multiple defaults to
zero(0). For example, there may be more than one “Set-
Cookie” item, but there is only one “Server” item.
The SetServerProperty method sets the value of the specified outgoing http
item. The GetServerProperty method returns values set by the
SetServerProperty method.

SetServerProperty is a VIRTUAL method so that other base class methods

can directly call the SetServerProperty virtual method in a derived class. This
lets you easily implement your own custom version of this method.

Implementation: The SetServerProperty method adds items to the ServerInfo property. The
FinishPage method includes these items in the outgoing http header.

Example:
[Link] PROCEDURE
NumCookies SIGNED,AUTO
ExtendedValue CSTRING(1000)
DateTime CSTRING(100)
I SIGNED,AUTO
CODE
NumCookies = RECORDS([Link])
LOOP I = 1 TO NumCookies
GET([Link], I)
ExtendedValue = [Link]&'="'&[Link]&'"'
[Link]('Set-Cookie', ExtendedValue, FALSE, TRUE)
END

SeeAlso: ServerInfo, FinishPage, GetServerProperty

CHAPTER 19 HTTPPAGEBASECLASS 607

HttpPageBaseClass Proper ties

The HttpPageBaseClass contains the properties listed below.

ExpireDateTime (transmissionexpirationtimestamp)
ExpireDateTime STRING(100), PROTECTED
The ExpireDateTime property contains the date and time the transmitted
page expires or is no longer valid.

This property is PROTECTED, therefore, it can only be referenced by an

HttpPageBaseClass method, or a method in a class derived from
HttpPageBaseClass.

Implementation: The PreparePage method sets the value of the ExpireDateTime property. The
HttpClass object includes this timestamp in the http header it sends to the
Client browser. The browser determines how the timestamp is actually used.

SeeAlso: PreparePage

FileHandler (TextOutputClassobject)
FileHandler &TextOutputClass, PROTECTED
The FileHandler property is a reference to the TextOutputClass object that
handles basic file handling, such as creating, opening, writing, and closing,
for the HttpPageBaseClass object.

This property is PROTECTED, therefore, it can only be referenced by an

HttpPageBaseClass method, or a method in a class derived from
HttpPageBaseClass.

Implementation: The Init method instantiates a new FileHandler for the HttpPageBaseClass
object.

SeeAlso: Init, TextOutputClass

608 IBC LIBRARY REFERENCE

FileLen(transmissionsize)
FileLen ULONG, PROTECTED
The FileLen property contains the size of the entire transmission, including
the http header information. The HttpPageBaseClass includes the
transmission size in the outgoing http header.

This property is PROTECTED, therefore, it can only be referenced by an

HttpPageBaseClass method, or a method in a class derived from
HttpPageBaseClass.

Implementation: The PreparePage method sets the value of the FileLen property.

SeeAlso: PreparePage

GotHtmlBody (http only transmission)

GotHtmlBody BYTE, PROTECTED
The GotHtmlBody property indicates whether a body file (containing
HTML code or JSL data) was passed to the HttpClass object. A value of one
(1) indicates a body file was passed; a value of zero (0) indicates no body
was passed and the HttpClass object should supply a default HTML body.

This property is PROTECTED, therefore, it can only be referenced by an

HttpPageBaseClass method, or a method in a class derived from
HttpPageBaseClass.

Implementation: The Init method sets the value of the GotHtmlBody property.

SeeAlso: Init
CHAPTER 19 HTTPPAGEBASECLASS 609

HtmlFilename (HTML/JSLtransmissionfile)
HtmlFilename CSTRING(FILE:MaxFileName), PROTECTED
The HtmlFilename property identifies the temporary file that contains only
the body of the transmission—that is, the file that contains the HTML code
or JSL data, but does not contain the http header information.

This property is PROTECTED, therefore, it can only be referenced by an

HttpPageBaseClass method, or a method in a class derived from
HttpPageBaseClass.

Implementation: The Init method sets the value of the HtmlFilename property.

SeeAlso: Init

Http (HttpClassobject)
Http &HttpBaseClass, PROTECTED
The Http property is a reference to the (parent) HttpClass object that handles
both incoming and outgoing http headers.

This property is PROTECTED, therefore, it can only be referenced by an

HttpPageBaseClass method, or a method in a class derived from
HttpPageBaseClass.

Implementation: The Init method sets the value of the Http property. The HttpPageBaseClass
object uses the Http property to access the http information (ServerInfo)
already collected by and resident in the Http property. The
HttpPageBaseClass object also uses some of the Http property’s methods
(SetServerProperty) to add the final pieces of http information before
assempling the http header.

SeeAlso: [Link], [Link], Init

610 IBC LIBRARY REFERENCE

NowDateTime (transmissiontimestamp)
NowDateTime STRING(100), PROTECTED
The NowDateTime property contains the date and time on the server
machine when the transmitted file was created. The HttpPageBaseClass
object uses this property to calculate the ExpireDateTime property.

This property is PROTECTED, therefore, it can only be referenced by an

HttpPageBaseClass method, or a method in a class derived from
HttpPageBaseClass.

Implementation: The PreparePage method sets the value of the NowDateTime property.

SeeAlso: PreparePage, ExpireDateTime

PageFilename (entire transmissionfile)

PageFilename CSTRING(FILE:MaxFileName), PROTECTED
The PageFilename property identifies the file output by the
HttpPageBaseClass object that contains the entire transmission—that is, the
file that ultimately contains both the http header and the HTML code or JSL
data.

This property is PROTECTED, therefore, it can only be referenced by an

HttpPageBaseClass method, or a method in a class derived from
HttpPageBaseClass.

Implementation: The Init method sets the value of the PageFilename property.

SeeAlso: Init
CHAPTER 19 HTTPPAGEBASECLASS 611

Status(statusof Client request)

Status SIGNED, PROTECTED
The Status property contains the status code the Server returns to the Client.
The Status property indicates the status of the Client request.

This property is PROTECTED, therefore, it can only be referenced by an

HttpPageBaseClass method, or a method in a class derived from
HttpPageBaseClass.

Implementation: The Init method sets the value of the Status property. The HandleStatusCode
and SetupHttpStatus methods set a corresponding message. Valid status
codes and messages include:
Code Message
200 'OK'
201 'Created'
202 'Accepted'
204 'No Content'
300 'Multiple Choices'
301 'Moved Permanently'
302 'Moved Temporarily'
304 'Not Modified'
400 'Bad Request'
401 'Unauthorized'
403 'Forbidden'
404 'Not Found'
500 'Internal Server Error'
501 'Not Implemented'
502 'Bad Gateway'
503 'Service Unavailable'
other 'UNKNOWN!'
SeeAlso: HandleStatusCode, Init, SetupHttpStatus
612 IBC LIBRARY REFERENCE

HttpPageBaseClass Methods
The HttpPageBaseClass contains the methods listed below.

Functional Organization—ExpectedUse

As an aid to understanding the HttpPageBaseClass, it is useful to organize its

methods into two categories according to their expected use—the primary
interface and the virtual methods. This organization reflects what we believe
is typical use of these methods.

Primary Interface Methods

The primary interface methods, which you are likely to call fairly routinely
from your program, can be further divided into three categories:

Housekeeping (one-time) Use:

Init initialize HttpPageBaseClass object
Kill shut down HttpPageBaseClass object

Mainstream Use:

Occasional Use:
SetupHttpStatus set outgoing http status indicators

Virtual Methods

AppendDefaultBody supply default HTML

FinishPage prepend http to outgoing transmission
HandleStatusCode process status code
PreparePage set outgoing http items
PreparePageBody virtual to set outgoing http items
WritePageBody write outgoing http body
CHAPTER 19 HTTPPAGEBASECLASS 613

AppendDefaultBody (supply default HTML)

AppendDefaultBody, VIRTUAL, PROTECTED
The AppendDefaultBody method creates and appends some default HTML
code to the transmission. The HttpPageBaseClass uses this method to supply
some meaningful HTML when the Client requested a new HTML page, but
the Server was otherwise unable to generate it.

AppendDefaultBody is a VIRTUAL method so that other base class methods

can directly call the AppendDefaultBody virtual method in a derived class.
This lets you easily implement your own custom version of this method.

This method is PROTECTED, therefore, it can only be called by an

HttpPageBaseClass method, or a method in a class derived from
HttpPageBaseClass.

Implementation: The AppendDefaultBody method creates HTML to display the status code
(Status property) for the Client’s request. The GotHtmlBody property
indicates whether the expected HTML is present or absent.

Example:
[Link] PROCEDURE
CODE
!procedure code

IF ([Link]) !if HTML exists, merge it

[Link]([Link],[Link],[Link],TRUE)
ELSE !if HTML is missing
[Link]() !create some to display the status code
END

SeeAlso: GotHtmlBody, Status

614 IBC LIBRARY REFERENCE

FinishPage (prependhttp to outgoingtransmission)

FinishPage, VIRTUAL
The FinishPage method writes the http text appropriate to the outgoing
transmission (HTML code or JSL data) then prepends it to the outgoing
transmission.

FinishPage is a VIRTUAL method so that other base class methods can

directly call the FinishPage virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: The [Link] method calls the

[Link] method. The FinishPage method
extracts http information from the ServerInfo property, formats it to HTTP/
1.0 standards, then prepends it to the outgoing transmission.

Example:
[Link] PROCEDURE !derived class FinishPage method
CODE
[Link]()
[Link]() !calls [Link]

SeeAlso: [Link], [Link]

CHAPTER 19 HTTPPAGEBASECLASS 615

HandleStatusCode(processstatuscode)
HandleStatusCode, VIRTUAL, PROTECTED
The HandleStatusCode method performs all required status code
processing, including setting a corresponding status message, and any other
http items that are status code dependent.

HandleStatusCode is a VIRTUAL method so that other base class methods

can directly call the HandleStatusCode virtual method in a derived class.
This lets you easily implement your own custom version of this method.

This method is PROTECTED, therefore, it can only be called by an

HttpPageBaseClass method, or a method in a class derived from
HttpPageBaseClass.

Implementation: The HandleStatusCode method calls the SetupHttpStatus method to set an

outgoing message corresponding to the Status property.

Example:
[Link] PROCEDURE
CODE
IF ([Link])
[Link] = [Link]([Link])
IC:RemoveFile([Link])
IC:RenameFile([Link], [Link])
[Link]('Content-length', '' & [Link])
ELSE
[Link] = [Link]
END
[Link]()
[Link]() !set status message & other status dependent http

SeeAlso: [Link], SetupHttpStatus, Status

616 IBC LIBRARY REFERENCE

Init (initialize theHttpPageBaseClassobject)

Init( httpclass, status, page, tempfilename )

Init Initializes the HttpPageBaseClass object.

httpclass The label of the HttpClass object that provides access to
the outgoing http information (ServerInfo). This is
typically that same object that calls the Init method.
status An integer constant, variable, EQUATE, or expression
indicating the status of the Client request.
page A string constant, variable, EQUATE, or expression
containing the filename/pathname of the file to send to
the Client.
tempfile A string constant, variable, EQUATE, or expression
containing the filename/pathname of the temporary file
used to build the page file.
The Init method initializes the HttpPageBaseClass object.

Implementation: The Init method sets the value of the GotHtmlBody, HtmlFilename, Http,
PageFilename, and Status properties, and instantiates a new TextOutputClass
object for the FileHandler property.

Example:
[Link] PROCEDURE |
(*HttpPageBaseClass HttpPage,SIGNED Status,<STRING Filename>)
CODE
[Link]()
[Link] &= HttpPage
[Link](SELF,status,Filename,[Link](Filename))
[Link]()

SeeAlso: GotHtmlBody, FileHandler, HtmlFilename, Http, PageFilename, Status

CHAPTER 19 HTTPPAGEBASECLASS 617

Kill (shut down theHttpPageBaseClassobject)

Kill
The Kill method frees any memory allocated during the life of the object and
performs any other required termination code.

Implementation: The Kill method DISPOSEs the FileHandler property.

Example:
[Link] PROCEDURE
CODE
[Link]()
IF (NOT [Link] &= NULL)
[Link]()
DISPOSE([Link])
END

SeeAlso: FileHandler

PreparePage (set outgoinghttp items)

PreparePage, VIRTUAL
The PreparePage method sets the final pieces of outgoing http information.

PreparePage is a VIRTUAL method so that other base class methods can

directly call the PreparePage virtual method in a derived class. This lets you
easily implement your own custom version of this method.

Implementation: Among other things, the PreparePage method calls the PreparePageBody and
HandleStatusCode methods to add the final outgoing http information to the
[Link] property.

Example:
[Link] PROCEDURE |
(*HttpPageBaseClass HttpPage, SIGNED Status, <STRING Filename>)
CODE
[Link]()
[Link] &= HttpPage
[Link](SELF,status,Filename,[Link](Filename))
[Link]() !wrap up outgoing http information

SeeAlso: HandleStatusCode, [Link], PreparePageBody

618 IBC LIBRARY REFERENCE

PreparePageBody (virtual to set outgoinghttp items)

PreparePageBody, VIRTUAL, PROTECTED
The PreparePageBody method is a virtual placeholder to set some outgoing
http information.

PreparePageBody is a VIRTUAL method so that other base class methods

can directly call the PreparePageBody virtual method in a derived class. This
lets you easily implement your own custom version of this method.

This method is PROTECTED, therefore, it can only be called by an

HttpPageBaseClass method, or a method in a class derived from
HttpPageBaseClass.

Implementation: The [Link] method does nothing. It is a

placeholder for derived class methods.

Example:
[Link] PROCEDURE
CODE
IF ([Link])
[Link] = [Link]([Link])
IC:RemoveFile([Link])
IC:RenameFile([Link], [Link])
[Link]('Content-length', '' & [Link])
ELSE
[Link] = [Link]
END
[Link] = IC:GetStrDateTime(TODAY(), CLOCK())
[Link] = [Link]
[Link]()
[Link]()

SeeAlso: [Link]
CHAPTER 19 HTTPPAGEBASECLASS 619

SetupHttpStatus(set outgoinghttp statusindicators)

SetupHttpStatus( status ), PROTECTED

SetupHttpStatus Sets the initial outgoing http header information.

status An integer constant, variable, EQUATE, or expression
indicating the status of the Client request.
The SetupHttpStatus method sets the initial outgoing http header
information.

This method is PROTECTED, therefore, it can only be called by an

HttpPageBaseClass method, or a method in a class derived from
HttpPageBaseClass.

Implementation: The SetupHttpStatus method sets the HttpProtocol, ErrorNum, and ErrorMsg
outgoing http items. These are the initial items interpreted by the Client
browser. The ErrorNum and ErrorMsg values depend on the Status property.

Example:
[Link] PROCEDURE
CODE
[Link]([Link])

SeeAlso: Status
620 IBC LIBRARY REFERENCE

WritePageBody (write outgoinghttp body)

WritePageBody, VIRTUAL, PROTECTED
The WritePageBody method writes all the outgoing http information that
requires no special handling or special positioning within the http header.

WritePageBody is a VIRTUAL method so that other base class methods can

directly call the WritePageBody virtual method in a derived class. This lets
you easily implement your own custom version of this method.

This method is PROTECTED, therefore, it can only be called by an

HttpPageBaseClass method, or a method in a class derived from
HttpPageBaseClass.

Implementation: The WritePageBody method loops through the [Link]

property, writing out each non-special item. Special items that require
specific positioning, such as HttpProtocol, ErrorNum, and ErrorMsg, are
handled separately.

Example:
[Link] PROCEDURE
Protocol CSTRING(20)
ErrorNum CSTRING(5)
ErrorMsg CSTRING(30)
CODE
[Link]([Link])
Protocol = [Link]('HttpProtocol')
ErrorNum = [Link]('ErrorNum')
ErrorMsg = [Link]('ErrorMsg')
[Link](Protocol & ' ' & ErrorNum & ' ' & ErrorMsg)

[Link]() !write non-special http information

[Link]()
[Link]()
IF ([Link])
[Link]([Link], [Link], [Link], TRUE)
ELSE
[Link]()
END

SeeAlso: [Link]
Friends of the IBC Library 621

FRIENDS OF THE IBC LIBRARY

FRIENDS OF THE IBC LIBRARY 67

Overview 69
Friend Concepts .................................................................................................... 69
Internet Connect Template Implementation ...............................................................69
Source Files ........................................................................................................... 69
Data 70
FrameWindow................................................................................................................. 70
Procedures 71
GetWebActiveFrame () .......................................................................................... 71
SetWebActiveFrame () .......................................................................................... 71
WebControlFactory () ............................................................................................ 71
622 IBC Library Reference
Friends of the IBC Library 623

Friend Concepts

Typically, your Web-enabled application instantiates a global

WebFrameClass object to represent the mergeable controls on the
APPLICATION frame.

Internet Connect Template Implementation

The Internet Connect Templates generate code to derive a global

WebFrameClass object to represent the mergeable controls on the
APPLICATION frame.

The derived WebFrameClass object is called MainFrame. The Internet

Connect Templates generate virtual methods within the MainFrame class to
simulate standard Windows control merging behavior on the Web pages
generated by the application.

SourceFiles

The WebWindowClass source code is installed by default to the \LIBSRC

folder. The source files and their components are as follows:

[Link] WebFrameClass class declarations

[Link] WebFrameClass method definitions

624 IBC Library Reference

Data
The contains the data items listed below.

FrameWindow
FrameWindow &WINDOW
The FrameWindow property is a reference to the program’s APPLICATION
(main window). The WebFrameClass uses the FrameWindow property to
reference the program’s main window.
Friends of the IBC Library 625

Procedures
The contains the procedures listed below.

GetWebActiveFrame ()
GetWebActiveFrame
The GetWebActiveFrame procedure returns a reference to the active
WebFrameClass object. They are used to tell the system when a frame
window has been opened, and closed, and to find out what the current
frame is. If you had more than one frame window, then
SetWebActiveFrame would be called more than once during the
program's lifetime.

Implementation: The .

Example:

SeeAlso: SetWebActiveFrame

SetWebActiveFrame ()
SetWebActiveFrame( WebFrameClass )
The SetWebActiveFrame procedure returns a reference to the active
WebFrameClass object. They are used to tell the system when a frame
window has been opened, and closed, and to find out what the current
frame is. If you had more than one frame window, then
SetWebActiveFrame would be called more than once during the
program's lifetime.

Implementation: The .

Example:

SeeAlso: GetWebActiveFrame

WebControlFactory ()
WebControlFactory( type )
The WebControlFactory procedure returns a reference to the active
WebFrameClass object. They are used to tell the system when a frame
window has been opened, and closed, and to find out what the current
frame is. If you had more than one frame window, then
626 IBC Library Reference

SetWebActiveFrame would be called more than once during the

program's lifetime.

Implementation: The .

Example:

SeeAlso: GetWebActiveFrame
Friends of the IBC Library 627
628 IBC Library Reference
Friends of the IBC Library 629
630 IBC Library Reference
INDEX 631

WebButtonClassMethods ......................................................328
INDEX WebControlClassMethods ....................................................227
WebHtmlCheckClassMethods..............................................271
BeginUpdate
A JSLManagerClassMethods...................................................457
BodyFooter
ActionOnAccept WebWindowClassMethods .......................................................170
WebControlClassProperties ................................................. 221 BodyHeader
Active WebWindowClassMethods .......................................................171
WebServerClassProperties .....................................................66 BorderWidth
AddControl WebHtmlGroupClassProperties............................................279
WebWindowClassMethods....................................................... 167 WebHtmlOptionClassProperties...........................................291
AddControlsToLayout WebHtmlSheetClassProperties ............................................304
WebControlListClassMethods.............................................. 135 WebWindowBaseClassProperties........................................141
WebWindowClassMethods....................................................... 169 Broker.................................................................................................32
AddEvent WebClientManagerClassProperties .................................... 94
JSLEventsClassMethods...................................................... 481 WebServerClassProperties.....................................................66
AddQueueEn try BrokerClass.......................................................................................41
JSLManagerClassMethods .................................................. 456 BrokerClassMethods ......................................................................46
aliases .................................................................................. 489 CloseChannel ...................................................................................47
Alignment GetAuthorizedInfo.......................................................................48
WebCaptionClassProperties................................................. 422 GetClient................................................................................. 49
AllowJava GetRequestArguments ..................................................................50
WebWindowBaseClassProperties....................................... 140 Init ...................................................................................... 51
AltText Kill..................................................................................52
WebHtmlImageClassProperties ........................................ 346 OpenChannel....................................................................................53
AppendDefaultBody ProcessHttpHeader.........................................................................54
HttpPageBaseClassMethods ................................. 613 SetClient ................................................................................. 55
AppletCount SetClientBrowser........................................................................55
HtmlClassProperties........................................................... 529 TakeFile...............................................................................................56
Application Broker.............................................................................32 TakeHtmlPage.........................................................................................57
ArgIndex TakeJslData.......................................................................................58
WebServerClassProperties .....................................................66 TakeUnauthorized............................................................................59
Arguments BrokerClassProperties............................................................... 44
HttpClassProperties ........................................................... 583 Client ....................................................................................... 44
Authorize Files......................................................................................... 45
WebWindowClassProperties................................................ 162 Http .................................................................................... 44
AuthorizeArea ServerName......................................................................................45
WebWindowClassProperties................................................ 163 BrokerClasssynopsis ......................................................................35
AutoSpotLink Browser
WebJavaListClassProperties ................................................ 359 HtmlClassProperties...........................................................529
WebJavaStringClassProperties............................................ 380 WebClientManagerClassProperties .................................... 94
BrowserInfo
B HttpClassProperties............................................................584
BrowserManagerClass ......................................................................109
Background
BrowserManagerClassMethods.................................................112
WebAreaClassProperties ...................................................... 411
Init .................................................................................... 112
WebWindowBaseClassProperties....................................... 140
BrowserManagerClassProperties...........................................110
BackImage
Kind ....................................................................................... 110
WebAreaClassProperties ...................................................... 411
SetNoCache..............................................................................110
WebWindowBaseClassProperties....................................... 140
SubmitFromJava ................................................................................. 111
BeforeResetControl
SupportsStyleSheets...............................................................111
632 IBC LIBRARY REFERENCE

C CreateChildHtml
WebWindowBaseClassMethods.............................................153
cachingoptions......................................................................... 451 WebWindowClassMethods .......................................................172
ClassLibraries .............................................................................31 CreateClose
Client.............................................................................................32 WebWindowBaseClassProperties........................................142
BrokerClassProperties ..............................................................44 CreateColorParameters
HtmlClassProperties........................................................... 529 WebControlClassMethods .................................................. 229
JSLManagerClassProperties................................................ 453 CreateDummyHtmlPage
WebServerClassProperties .....................................................67 WebWindowClassMethods ..................................................... 173
Close CreateForeColorParameter
ShutDownClassMethods..........................................................90 WebControlClassMethods .................................................. 230
TextOutputClassMethods...................................................... 573 CreateHtml
CloseChannel LayoutHtmlClassMethods ................................................... 513
BrokerClassMethods.................................................................47 WebCaptionClassMethods....................................................423
JSLManagerClassMethods .................................................. 458 WebClientAreaClassMethods ...............................................437
CloseImage WebCloseButtonClassMethods............................................388
WebWindowBaseClassProperties....................................... 141 WebControlClassMethods ....................................................231
CommandLine WebControlListClassMethods ..............................................136
WebServerClassProperties .....................................................68 WebHtmlGroupClassMethods..................................................280
Connect WebHtmlMenuClassMethods...............................................288
WebServerClassMethods ........................................................74 WebHtmlOptionClassMethods .............................................292
Container WebHtmlSheetClassMethods...............................................305
WebControlClassProperties ................................................. 222 WebHtmlTabClassMethods.......................................................315
Container Applet ....................................................................... 555 WebJavaButtonClassMethods .............................................337
Conventions WebJavaImageClassMethods..................................................350
documentation.............................................................................37 WebJavaListClassMethods ...................................................362
Cookies WebJavaStringClassMethods...............................................381
HttpClassProperties ........................................................... 585 WebLiteralClassMethods................................................... 400
CopyControlsToWindow WebMenubarClassMethods......................................................429
WebFrameClassMethods ..................................................... 120 WebNullControlClassMethods .............................................402
CopyControlToWindow WebToolbarClassMethods ....................................................433
WebFrameClassMethods ..................................................... 122 CreateHtmlExtra
CreateCaption WebControlClassMethods .................................................. 232
WebWindowBaseClassProperties....................................... 141 WebHtmlRegionClassMethods ............................................302
CreateCellContents CreateHtmlPage
WebControlClassMethods.................................................... 227 WebWindowClassMethods ..................................................... 174
WebHotlinkClassMethods..................................................... 398 CreateJslData
WebHtmlButtonClassMethods............................................. 332 WebCloseButtonClassMethods............................................390
WebHtmlCheckClassMethods............................................. 272 WebControlClassMethods ....................................................232
WebHtmlEntryClassMethods ............................................... 276 WebHtmlCheckClassMethods..............................................273
WebHtmlImageClassMethods ............................................. 347 WebHtmlEntryClassMethods................................................277
WebHtmlItemClassMethods................................................. 284 WebHtmlListClassMethods...................................................357
WebHtmlListClassMethods .................................................. 356 WebHtmlOptionClassMethods .............................................293
WebHtmlMenuClassMethods .............................................. 287 WebHtmlTabClassMethods.......................................................316
WebHtmlPromptClassMethods ............................................... 298 WebHtmlTextClassMethods......................................................327
WebHtmlRadioClassMethods.............................................. 300 WebJavaButtonClassMethods .............................................339
WebHtmlStringClassMethods .............................................. 378 WebJavaImageClassMethods..................................................352
WebHtmlTextClassMethods ..................................................... 325 WebJavaListClassMethods ...................................................364
CreateCellFooter WebJavaStringClassMethods...............................................382
WebControlClassMethods.................................................... 228 WebNullControlClassMethods .............................................402
CreateCellHeader WebWindowClassMethods .......................................................175
WebControlClassMethods.................................................... 228 CreateOpen
INDEX 633

HtmlClassMethods............................................................. 535 JslEventsClassProperties ......................................................479

TextOutputClassMethods...................................................... 574 ExpireDateTime
CreatePageFooter HttpPageBaseClass Properties ............................... 607
WebWindowClassMethods....................................................... 176 Extra
CreatePageHeader SubmitItem Properties .............................................................522
WebWindowClassMethods....................................................... 176
CreateParams F
WebCloseButtonClassMethods........................................... 391
WebControlClassMethods.................................................... 233 Feq
WebHtmlTabClassMethods...................................................... 317 SubmitItem Properties .............................................................522
WebJavaButtonClassMethods............................................. 339 WebControlClassProperties..................................................223
WebJavaImageClassMethods................................................. 353 Feq2Id
WebJavaListClassMethods................................................... 365 WebClientManagerClassMethods ...................................... 97
WebJavaStringClassMethods .............................................. 383 FileHandler
CreateTabControl HttpPageBaseClass Properties ............................... 607
WebHtmlSheetClassMethods.............................................. 307 FileLen
CreateToolbar HttpPageBaseClass Properties ............................... 608
WebWindowBaseClassProperties....................................... 142 Filename
CreateUnauthorizedPage WebJavaImageClassProperties......................................... 349
WebWindowClassMethods....................................................... 177 Files
CurSubmit BrokerClassProperties..............................................................45
WebServerClassProperties .....................................................67 HtmlClassProperties........................................................... 530
HttpClassProperties ........................................................... 586
D JSLManagerClassProperties.................................................453
WebServerClassProperties.....................................................69
DefaultButton WebWindowBaseClassProperties........................................144
WebWindowBaseClassProperties....................................... 143 FinishPage
DefaultButtonNeeded HttpClassMethods.............................................................. 591
WebWindowBaseClassProperties....................................... 143 HttpPageBaseClassMethods ................................. 614
DialogPageBackColor FirstControl
WebServerClassProperties .....................................................68 HtmlClassProperties........................................................... 530
DialogPageImage FirstSelectable
WebServerClassProperties .....................................................68 HtmlClassProperties........................................................... 530
DialogWinBackColor Format
WebServerClassProperties .....................................................68 WebJavaListClassProperties.................................................360
DialogWinImage FormatBorderWidth
WebServerClassProperties .....................................................69 WebWindowBaseClassProperties........................................145
DisabledAction FrameWindow
WebControlClassProperties ................................................. 222 WebFrameClassProperties....................................................119
WebWindowBaseClassProperties....................................... 144 FromQ
Documentation Conventions ..............................................................37 WebJavaListClassProperties.................................................360
DoSetChildDefaults
WebControlClassMethods.................................................... 233 G
dynamic HTML............................................................................................451
GetAlias
E WebFilesClassMethods .........................................................492
GetAlignText
Event WebControlClassMethods .................................................. 234
SubmitItem Properties............................................................. 522 GetAppletType
EventActionQ WebCloseButtonClassMethods............................................392
WebJavaListClassProperties ................................................ 359 WebControlClassMethods ....................................................234
EventQ WebHtmlTabClassMethods.......................................................318
634 IBC LIBRARY REFERENCE

WebJavaButtonClassMethods............................................. 340 GetControlReference

WebJavaImageClassMethods................................................. 354 HtmlClassMethods ........................................................... 540
WebJavaListClassMethods................................................... 366 GetCookie
WebJavaStringClassMethods .............................................. 384 HttpClassMethods.............................................................. 594
WebNullControlClassMethods............................................. 403 GetCreateClose
WebToolbarClassMethods.................................................... 434 WebWindowBaseClassMethods.............................................155
GetArguments WebWindowClassMethods .......................................................188
HttpClassMethods.............................................................. 591 GetDirectory
GetAuthorized WebFilesClassMethods ....................................................... 493
WebWindowClassMethods....................................................... 179 GetEventAction
GetAuthorizedInfo WebControlClassMethods .................................................. 239
BrokerClassMethods.................................................................48 WebJavaListClassMethods ...................................................367
HttpClassMethods.............................................................. 592 WebJavaToolButtonClassMethods ................................... 343
GetBackgroundColor GetEventNumber
WebAreaClassMethods......................................................... 412 JSLEventsClassMethods .................................................... 484
WebClientAreaClassMethods............................................... 438 GetEventString
WebControlClassMethods.................................................... 235 JSLEventsClassMethods .................................................... 485
WebListClassMethods ........................................................... 355 GetFilename
WebWindowBaseClassMethods ............................................ 154 WebFilesClassMethods ....................................................... 494
WebWindowClassMethods....................................................... 180 WebJavaButtonClassMethods .............................................342
GetBackgroundImage GetFirstChild
WebWindowBaseClassMethods ............................................ 154 WebWindowBaseClassMethods.............................................157
WebWindowClassMethods....................................................... 181 WebWindowClassMethods .......................................................187
GetBrowserProperty GetFont
HttpClassMethods.............................................................. 593 WebAreaClassMethods .........................................................414
GetButtonInClientArea WebControlClassMethods ....................................................240
WebWindowClassMethods....................................................... 182 GetFontChanged
GetCanDisable HtmlClassMethods ........................................................... 536
WebControlClassMethods.................................................... 236 GetFontStyle
WebJavaButtonClassMethods............................................. 341 HtmlClassMethods ........................................................... 537
GetCellAttributes GetHasHotkey
WebAreaClassMethods....................................................... 413 WebButtonClassMethods ......................................................330
WebCaptionClassMethods ................................................... 424 WebControlClassMethods ....................................................240
WebControlClassMethods.................................................... 237 WebHtmlCheckClassMethods..............................................274
WebHtmlMenuClassMethods .............................................. 289 WebHtmlGroupClassMethods..................................................281
WebHtmlStringClassMethods............................................... 379 WebHtmlPromptClassMethods................................................299
WebLiteralClassMethods .................................................. 401 WebHtmlRadioClassMethods...............................................301
WebNullControlClassMethods............................................. 404 WebHtmlTabClassMethods.......................................................319
GetChildren GetHelpHandler
WebWindowBaseClassMethods ............................................ 156 WebWindowBaseClassMethods.............................................157
WebWindowClassMethods....................................................... 183 WebWindowClassMethods .......................................................189
GetChoiceChanged GetHelpReference
WebControlClassMethods.................................................. 238 WebWindowBaseClassMethods.............................................158
GetClient WebWindowClassMethods .......................................................190
BrokerClassMethods.................................................................49 GetHelpTarget
GetCloneFeq WebWindowBaseClassMethods.............................................158
WebCloseButtonClassMethods........................................... 393 WebWindowClassMethods .......................................................192
GetControl GetInternetEnabled
WebWindowBaseClassMethods ............................................ 155 WebServerClassMethods...................................................... 75
WebWindowClassMethods....................................................... 184 GetIsChild
GetControlInfo WebControlClassMethods .................................................. 241
WebWindowClassMethods....................................................... 186 WebHtmlSheetClassMethods...............................................308
INDEX 635

WebHtmlTabClassMethods...................................................... 320 WebWindowClassMethods .......................................................194

WebNullControlClassMethods............................................. 405 GetSize
GetLevel TextOutputClassMethods.......................................................575
WebControlClassMethods.................................................... 242 GetTableAttributes
GetMenubarFeq WebControlClassMethods .................................................. 245
WebFrameClassMethods ..................................................... 123 WebHtmlOptionClassMethods .............................................294
WebWindowBaseClassMethods ............................................ 158 WebHtmlSheetClassMethods...............................................309
WebWindowClassMethods....................................................... 191 WebWindowClassMethods .......................................................195
GetNameAttribute GetTargetSecurity
WebControlClassMethods.................................................... 242 WebWindowClassMethods ..................................................... 195
GetPageImage GetTempFilename
WebWindowBaseClassMethods ............................................ 159 WebFilesClassMethods ....................................................... 500
WebWindowClassMethods....................................................... 192 GetText
GetParentBackgroundColor WebCaptionClassMethods....................................................426
WebControlClassMethods.................................................... 243 WebControlClassMethods ....................................................245
GetPixelsX GetToolbarFeq
HtmlClassMethods............................................................. 538 WebFrameClassMethods......................................................124
GetPixelsY WebWindowBaseClassMethods.............................................160
HtmlClassMethods............................................................. 539 WebWindowClassMethods .......................................................196
GetPosition GetToolbarMode
WebCaptionClassMethods ................................................... 425 WebWindowBaseClassMethods.............................................160
WebClientAreaClassMethods............................................... 439 WebWindowClassMethods .......................................................199
WebCloseButtonClassMethods........................................... 394 GetUseChanged
WebControlClassMethods.................................................... 244 WebControlClassMethods .................................................. 246
WebHtmlTabClassMethods...................................................... 322 GetVisible
WebMenubarClassMethods..................................................... 430 WebAreaClassMethods ....................................................... 415
WebToolbarClassMethods.................................................... 435 WebButtonClassMethods ......................................................331
GetProgramRef WebCaptionClassMethods....................................................427
WebFilesClassMethods......................................................... 495 WebCloseButtonClassMethods............................................395
GetPublicDirectory WebControlClassMethods ....................................................247
WebFilesClassMethods......................................................... 496 WebHtmlItemClassMethods..................................................285
GetQuotedText WebHtmlMenuClassMethods...............................................290
WebControlClassMethods.................................................... 245 WebHtmlTabClassMethods.......................................................323
GetReadyForPage WebMenubarClassMethods......................................................431
WebServerClassMethods ........................................................76 WebNullControlClassMethods .............................................406
GetRelativeFilename WebToolbarClassMethods ....................................................436
WebFilesClassMethods......................................................... 498 GetWebActiveFrame
GetRequestArguments WebWindowBaseClassMethods.............................................161
BrokerClassMethods.................................................................50 WebWindowClassMethods .......................................................198
GetRequestedWholePage GotCommandLine
WebServerClassMethods ........................................................77 WebServerClassProperties.....................................................69
GetSendWholePage GotHtmlBody
WebServerClassMethods ........................................................78 HttpPageBaseClass Properties ............................... 608
GetSeparateSecure GroupBorderWidth
WebFilesClassMethods......................................................... 499 WebWindowBaseClassProperties........................................145
GetServerProperty
HttpClassMethods.............................................................. 595 H
GetShowMenubar
WebWindowBaseClassMethods ............................................ 159 Halt
WebWindowClassMethods....................................................... 194 WebServerClassMethods........................................................79
GetShowToolbar HandleStatusCode
WebWindowBaseClassMethods ............................................ 159 HttpPageBaseClassMethods ................................. 615
636 IBC LIBRARY REFERENCE

Header Files ................................................................................ 36 WriteTableNewCol .............................................................................. 567

Height WriteTableNewRow ........................................................................... 567
WebCloseButtonClassProperties...................................... 387 WriteText...........................................................................................568
HelpDocument HtmlClassProperties ................................................................529
WebWindowBaseClassProperties....................................... 145 AppletCount...............................................................................529
HelpEnabled Browser ......................................................................................529
WebWindowBaseClassProperties....................................... 146 Client ..................................................................................... 529
HelpRelative Files....................................................................................... 530
WebWindowBaseClassProperties....................................... 146 FirstControl........................................................................... 530
HelpStyle FirstSelectable...........................................................................530
WebWindowBaseClassProperties....................................... 146 JavaLibraryCab ..............................................................................531
Html JavaLibraryZip...........................................................................531
WebReportClassProperties .................................................. 445 Option ................................................................................... 532
HTML codegenerator .....................................................30, UseFonts ..........................................................................................532
31 HtmlFilename
HtmlClass........................................................................................ 527 HttpPageBaseClass Properties ............................... 609
HtmlClassMethods .................................................................. 533 HtmlOption
CreateOpen .............................................................................. 535 WebWindowBaseClassProperties........................................147
GetControlReference.............................................................. 540 HtmlPreview....................................................................................443
GetFontChanged .................................................................... 536 HtmlTarget
GetFontStyle ............................................................................. 537 WebWindowClassProperties.................................................163
GetPixelsX................................................................................. 538 Http
GetPixelsY................................................................................. 539 BrokerClassProperties..............................................................44
Init .................................................................................... 541 HttpPageBaseClass Properties ............................... 609
Kill................................................................................ 541 HttpClass ................................................................................... 581
PopFont............................................................................................ 542 HttpClassMethods....................................................................589
PushFont ......................................................................................... 543 FinishPage.................................................................................591
TakeNewControl ..................................................................................544 GetArguments ................................................................................591
WriteAppletDimParameter ......................................................... 545 GetAuthorizedInfo.....................................................................592
WriteAppletFilenameParameter ............................................... 546 GetBrowserProperty................................................................593
WriteAppletFontParameter......................................................... 547 GetCookie..................................................................................594
WriteAppletFooter .................................................................... 548 GetServerProperty ...................................................................595
WriteAppletHeader .................................................................. 549 Init .................................................................................... 596
WriteAppletOptParameter .......................................................... 550 Kill................................................................................ 596
WriteAppletParameter ................................................................. 551 PreparePage...................................................................................597
WriteAppletUAID...................................................................... 552 PreparePageForBrowser.............................................................598
WriteChildAppletFooter........................................................... 553 PreparePageForJava ...................................................................599
WriteChildAppletHeader......................................................... 554 PrepareUnauthorized ..............................................................600
WriteContainerAppletHeader .................................................... 555 ProcessHeader...............................................................................601
WriteControlFooter................................................................... 556 SendCookies...................................................................................601
WriteControlHeader................................................................. 556 SetBrowserProperty.................................................................602
WriteEventHandler................................................................... 557 SetCookie...................................................................................603
WriteFontFooter........................................................................ 559 SetProcName .................................................................................605
WriteFontHeader........................................................................... 559 SetProgName.................................................................................604
WriteFormFooter ........................................................................... 560 SetServerProperty....................................................................606
WriteFormHeader ......................................................................... 560 HttpClassProperties .................................................................583
WriteJavaScript......................................................................... 561 Arguments .................................................................................583
WriteOnFocusHandler................................................................. 562 BrowserInfo................................................................................584
WriteRefreshTimer................................................................... 563 Cookies.......................................................................................585
WriteSpace.......................................................................... 564 Files....................................................................................... 586
WriteSubmitApplet................................................................... 565 HttpPage ....................................................................................586
WriteTableFooter........................................................................... 566 ProcName........................................................................................587
WriteTableHeader......................................................................... 566
INDEX 637
Init
ProgName........................................................................................587 BrokerClassMethods ................................................................51
ServerInfo .................................................................................. 588 BrowserManagerClassMethods...........................................112
HttpPage
HttpClassProperties ........................................................... 586
HttpPageBaseClass........................................................................... 581
HttpPageBaseClassMethods ..................................... 612
AppendDefaultBody ......................................................................613
FinishPage................................................................................ 614
HandleStatusCode....................................................................... 615
Init .................................................................................... 616
Kill................................................................................ 617
PreparePage...................................................................................617
PreparePageBody .................................................................. 618
SetupHttpStatus....................................................................... 619
WritePageBody................................................................... 620
HttpPageBaseClass Properties ................................... 607
ExpireDateTime............................................................................. 607
FileHandler................................................................................ 607
FileLen ............................................................................ 608
GotHtmlBody...................................................................................608
HtmlFilename ........................................................................... 609
Http .................................................................................. 609
NowDateTime................................................................................ 610
PageFilename................................................................................ 610
Status.................................................................................... 611
HttpProtocol.................................................................................... 588
Hyper-Text Transfer Protocol........................................................581

I
IBCLibrary ......................................................................30,
31
IBCLibrary Reference.................................................................... 30
IC:CurControl.................................................................................. 220
[Link]............................................................................................42
[Link]...............................................................93,
109
[Link]...........................................................270,
410
[Link]..........................................................................................478
[Link]..........................................................................................490
[Link]..........................................................................................528
[Link]..................................................................................................582
[Link] ............................................................................................. 452
[Link]............................................................220,
510
[Link] ...................................................... 444
[Link] ...............................................................................................444
[Link] ............................................................64,
521
[Link]...........................................................................................64
[Link] ...........................................................528,
571
[Link]................................................117, 133, 220
[Link]...............................................................................................133
638 IBC LIBRARY REFERENCE

HtmlClassMethods ............................................................. 541

HttpClassMethods.............................................................. 596
HttpPageBaseClassMethods .................................616
JSLEventsClassMethods...................................................... 482
JSLManagerClassMethods .................................................. 459
LayoutHtmlClassMethods..................................................... 514
WebAreaClassMethods......................................................... 416
WebButtonClassMethods...................................................... 333
WebCaptionClassMethods ................................................... 428
WebClientManagerClassMethods ...................................... 98
WebCloseButtonClassMethods........................................... 396
WebControlClassMethods.................................................... 248
WebControlListClassMethods.............................................. 138
WebFilesClassMethods......................................................... 501
WebHtmlGroupClassMethods..................................................282
WebHtmlOptionClassMethods............................................. 295
WebHtmlSheetClassMethods.............................................. 310
WebJavaListClassMethods................................................... 368
WebJavaStringClassMethods.............................................. 385
WebMenubarClassMethods......................................................432
WebReportClassMethods .................................................... 447
WebServerClassMethods ........................................................80
WebWindowClassMethods .......................................................200
Insert
LayoutHtmlClassMethods..................................................... 515
Internet BuilderClass(IBC) Library .......................................... 30
Internet Builder ClassSynopsis................................................. 35
Internet Builder Classes .............................................................31
Internet ConnectTerms andConcepts ..................................... 32
InternetDataSinkClass.....................................................................41
IP
WebClientManagerClassProperties .................................... 95
IsCentered
WebWindowClassProperties................................................ 163
IsDynamic
WebControlClassProperties ................................................. 223
IsEnabled
WebHtmlTabClassProperties ....................................................314
WebJavaButtonClassProperties ........................................336
IsSecure
WebWindowClassProperties................................................ 164
IsSplash
WebWindowBaseClassProperties....................................... 147

J
Java events ..................................................................................... 477
Java Support Library...................................................................32
Java SupportLibrary (JSL) ..........................................................451
Java-enabled browser......................................................................32
JavaLibraryCab
HtmlClassProperties........................................................... 531
INDEX 639

JavaLibraryPath LayoutHtmlClassMethods .....................................................516

WebServerClassProperties .....................................................70 WebAreaClassMethods .........................................................417
JavaLibraryZip WebClientManagerClassMethods ...................................... 99
HtmlClassProperties........................................................... 531 WebControlClassMethods ....................................................249
JSL............................................................................................. 451 WebControlListClassMethods ..............................................138
Jsl WebFilesClassMethods .........................................................502
WebClientManagerClassProperties.................................... 95 WebJavaListClassMethods ...................................................369
JslEventsClass............................................................................... 477 WebReportClassMethods .....................................................447
JSLEventsClassMethods ........................................................... 480 WebServerClassMethods........................................................81
AddEvent......................................................................................... 481 WebWindowClassMethods...................................200, 201
GetEventNumber.......................................................................... 484 Kind
GetEventString ......................................................................... 485 BrowserManagerClassProperties.........................................110
Init .................................................................................... 482
Kill................................................................................ 483 L
JslEventsClassProperties ........................................................... 479
EventQ ............................................................................................. 479 LastText
JSLManagerClass.............................................................................. 451 WebJavaStringClassProperties ............................................380
JSLManagerClassMethods........................................................ 455 LayoutHtmlClass..................................................................................509
AddQueueEn try .................................................. 456 LayoutHtmlClassMethods ...........................................................512
BeginUpdate............................................................................. 457 CreateHtml.................................................................................513
CloseChannel................................................................................. 458 Init .................................................................................... 514
Init .................................................................................... 459 Insert ..................................................................................... 515
Kill................................................................................ 459 Kill ................................................................................ 516
OpenChannel................................................................................. 460 SetCell .................................................................................. 517
RemoveAllQueueEntries ............................................................ 462 LayoutHtmlClassProperties.........................................................511
RemoveQueueEntries................................................................. 463 SnapX ............................................................................. 511
ScrollQueueDown......................................................................... 464 SnapY ............................................................................. 511
ScrollQueueUp .............................................................................. 465 Style ...................................................................................... 511
SelectControl ............................................................................ 466 LoadImage
SetAttribute .......................................................................... 467 WebFilesClassMethods .........................................................503
SetAttributeFilename .............................................................. 468 LocalFont
SetAttributeLong ................................................................. 469 WebAreaClassProperties ......................................................411
SetChecked .................................................................................... 470
SetIconAttribute........................................................................ 471
M
SetListChoice ........................................................................... 472 menumerging............................................................................117
SetQueueEntry.............................................................................. 473 MenubarFeq
SetValue........................................................................................... 474 WebFrameClassProperties ...................................................119
JSLManagerClassProperties...................................................... 453 WebWindowBaseClassProperties........................................148
Client..................................................................................... 453 MenubarType
Files ...................................................................................... 453 WebWindowBaseClassProperties........................................148
Security................................................................................. 454 mergemenusandtoolbars.......................................................117
Target................................................................................................ 454
N
K
Name
Kill SubmitItem Properties .............................................................523
BrokerClassMethods.................................................................52 NewValue
HtmlClassMethods............................................................. 541 SubmitItem Properties .............................................................523
HttpClassMethods.............................................................. 596 NextHtmlPage
HttpPageBaseClassMethods ................................. 617 WebClientManagerClassMethods ....................................100
JSLEventsClassMethods...................................................... 483 NowDateTime
JSLManagerClassMethods .................................................. 459
640 IBC LIBRARY REFERENCE

HttpPageBaseClass Properties ............................... 610 BrokerClassMethods.................................................................54

NumPages ProcName
WebReportClassProperties .................................................. 446 HttpClassProperties ...........................................................587
ProgName
O HttpClassProperties ...........................................................587
ProgramName
Object Orientedsystem.................................................................. 31 WebServerClassProperties.....................................................71
Open PushFont
TextOutputClassMethods...................................................... 576 HtmlClassMethods .............................................................543
OpenChannel WebAreaClassMethods .........................................................418
BrokerClassMethods.................................................................53 WebControlClassMethods.....................................................251
JSLManagerClassMethods .................................................. 460
Option Q
HtmlClassProperties........................................................... 532
OptionBorderWidth Q
WebWindowBaseClassProperties....................................... 148 WebReportClassProperties...................................................445
OwnerWindow QueueActionQ
WebControlClassProperties ................................................. 223 WebJavaListClassProperties.................................................361
Quit
P WebServerClassMethods ........................................................82

PageBackground R
WebWindowBaseClassProperties....................................... 149
PageFilename RealParentFeq
HttpPageBaseClass Properties ............................... 610 WebControlClassProperties..................................................224
PageImage RefreshDisabled
WebWindowBaseClassProperties....................................... 149 WebControlClassMethods.....................................................252
PageToReturnTo RemoveAll
WebServerClassProperties .....................................................70 WebFilesClassMethods .........................................................504
ParentFeq RemoveAllQueueEntries
WebControlClassProperties ................................................. 224 JSLManagerClassMethods...................................................462
Partial PageUpdates ....................................................................451 RemoveQueueEntries
persistent communication....................................................................33 JSLManagerClassMethods...................................................463
PopFont Reports ...................................................................................... 443
HtmlClassMethods............................................................. 542 Reset
WebControlClassMethods.................................................... 250 SubmitItem Methods ...........................................................524
PreparePage ResetControl
HttpClassMethods.............................................................. 597 WebButtonClassMethods ......................................................331
HttpPageBaseClassMethods ................................. 617 WebCloseButtonClassMethods............................................397
PreparePageBody WebControlClassMethods.....................................................253
HttpPageBaseClassMethods ................................. 618 WebHtmlButtonClassMethods..............................................334
PreparePageForBrowser WebHtmlCheckClassMethods..............................................275
HttpClassMethods.............................................................. 598 WebHtmlEntryClassMethods ................................................278
PreparePageForJava WebHtmlItemClassMethods..................................................286
HttpClassMethods.............................................................. 599 WebHtmlListClassMethods...................................................358
PrepareUnauthorized WebHtmlOptionClassMethods..............................................296
HttpClassMethods.............................................................. 600 WebHtmlSheetClassMethods...............................................311
Preview WebHtmlTabClassMethods.......................................................323
WebReportClassMethods..................................................... 448 WebHtmlTextClassMethods......................................................327
ProcessHeader WebJavaButtonClassMethods..............................................342
HttpClassMethods.............................................................. 601 WebJavaListClassMethods ...................................................370
ProcessHttpHeader ResetFromControls
WebWindowClassMethods .......................................................200
INDEX 641

ResetFromQueue SetCentered
WebControlClassMethods.................................................. 254 WebWindowClassMethods .......................................................202
WebJavaListClassMethods................................................... 371 SetChecked
JSLManagerClassMethods...................................................470
S SetChildDefaults
WebControlClassMethods ....................................................256
ScrollQueueDown WebHtmlImageClassMethods..............................................348
JSLManagerClassMethods .................................................. 464 WebHtmlSheetClassMethods...............................................313
ScrollQueueUp WebWindowClassMethods .......................................................202
JSLManagerClassMethods .................................................. 465 SetClient
Security BrokerClassMethods.................................................................55
JSLManagerClassProperties................................................ 454 SetClientBrowser
SelectControl BrokerClassMethods.................................................................55
JSLManagerClassMethods .................................................. 466 SetCookie
SelectTarget HttpClassMethods..............................................................603
WebFilesClassMethods......................................................... 505 SetDescription
SendCookies WebControlClassMethods ....................................................257
HttpClassMethods.............................................................. 601 WebHtmlImageClassMethods..............................................348
SentHtml SetDialogPageBackground
WebWindowClassProperties................................................ 164 WebServerClassMethods........................................................83
Server ...........................................................................................32 SetDialogWinBackground
WebReportClassProperties .................................................. 446 WebServerClassMethods........................................................84
WebWindowBaseClassProperties....................................... 149 SetDirty
ServerInfo WebJavaListClassMethods ...................................................372
HttpClassProperties ........................................................... 588 SetEventAction
ServerName WebControlClassMethods ....................................................258
BrokerClassProperties ..............................................................45 WebJavaListClassMethods ...................................................373
SetAttribute SetFont
JSLManagerClassMethods .................................................. 467 WebAreaClassMethods .........................................................420
SetAttributeFilename SetFormatOptions
JSLManagerClassMethods .................................................. 468 WebWindowClassMethods .......................................................203
SetAttributeLong SetHelpDocument
JSLManagerClassMethods .................................................. 469 WebWindowClassMethods .......................................................204
SetAutoSpotLink SetHelpURL
WebControlClassMethods.................................................... 255 WebWindowClassMethods .......................................................205
WebJavaListClassMethods................................................... 372 SetIconAttribute
WebJavaStringClassMethods .............................................. 386 JSLManagerClassMethods...................................................471
SetBackground SetListChoice
WebAreaClassMethods......................................................... 419 JSLManagerClassMethods...................................................472
WebWindowClassMethods....................................................... 201 SetNewPageDisable
SetBorderWidth WebServerClassMethods........................................................86
WebControlClassMethods.................................................... 255 SetNextAction
WebHtmlGroupClassMethods ................................................. 283 WebServerClassMethods........................................................87
WebHtmlOptionClassMethods............................................. 297 SetNoCache
WebHtmlSheetClassMethods.............................................. 312 BrowserManagerClassProperties.........................................110
SetBreakable SetNumPages
WebControlClassMethods.................................................... 256 WebReportClassMethods .....................................................448
WebStringClassMethods....................................................... 377 SetPageBackground
SetBrowserProperty WebWindowClassMethods .......................................................206
HttpClassMethods.............................................................. 602 SetParentDefaults
SetCell WebAreaClassMethods .........................................................421
LayoutHtmlClassMethods..................................................... 517 WebControlClassMethods ....................................................260
642 IBC LIBRARY REFERENCE

WebControlListClassMethods.............................................. 139 NewValue ............................................................................................... 523

WebHtmlRegionClassMethods............................................ 303 SubmitItemClass...........................................................67, 521
WebHtmlTabClassMethods...................................................... 324 SupportsStyleSheets
SetPassword BrowserManagerClassProperties.........................................111
WebWindowClassMethods....................................................... 207 SuppressControl
SetProcName WebWindowClassMethods .......................................................210
HttpClassMethods.............................................................. 605 Synopsis.............................................................................................35
SetProgName SyntaxDiagrams....................................................................................37
HttpClassMethods.............................................................. 604
SetQueue T
WebControlClassMethods.................................................... 261
WebJavaListClassMethods................................................... 375 TakeCreatePage
SetQueueEntry WebWindowClassMethods .......................................................211
JSLManagerClassMethods .................................................. 473 TakeEvent
SetSendWholePage WebFrameClassMethods......................................................125
WebServerClassMethods ........................................................85 WebServerClassMethods........................................................88
SetServerProperty WebWindowClassMethods .......................................................212
HttpClassMethods.............................................................. 606 TakeFile
SetSplash BrokerClassMethods ................................................................56
WebWindowClassMethods....................................................... 208 WebClientManagerClassMethods ....................................100
SetTimer TakeHtmlPage
WebWindowClassMethods....................................................... 209 BrokerClassMethods ................................................................57
SetupHttpStatus WebClientManagerClassMethods ....................................101
HttpPageBaseClassMethods ................................. 619 TakeJslData
SetValue BrokerClassMethods ................................................................58
JSLManagerClassMethods .................................................. 474 WebClientManagerClassMethods ....................................103
SheetBorderWidth TakeNewControl
WebWindowBaseClassProperties....................................... 150 HtmlClassMethods .............................................................544
ShutDownClassMethods ...............................................................90 TakePageSent
Close .......................................................................................90 WebServerClassMethods........................................................89
SnapX TakeRequest
LayoutHtmlClassProperties .................................................. 511 WebWindowClassMethods .......................................................213
WebWindowBaseClassProperties....................................... 150 TakeUnauthorized
SnapY BrokerClassMethods ................................................................59
LayoutHtmlClassProperties .................................................. 511 WebClientManagerClassMethods ....................................105
WebWindowBaseClassProperties....................................... 150 TakeUnknownSubmit
Started WebWindowClassMethods .......................................................214
WebJavaListClassProperties ................................................ 361 Target
Status JSLManagerClassProperties.................................................454
HttpPageBaseClass Properties ............................... 611 temporary files ...................................................................... 489
Style Text
LayoutHtmlClassProperties .................................................. 511 WebLiteralClassProperties ................................................399
Submit Strings........................................................................... 521 TextOutPutClass ..................................................................................571
SubmitFromJava TextOutputClassMethods ............................................................572
BrowserManagerClassProperties ..................................... 111 Close..................................................................................... 573
SubmitItem Methods ................................................................ 524 CreateOpen...............................................................................574
Reset .......................................................................................... 524 GetSize.......................................................................................575
SubmitItem Properties .................................................................. 522 Open ..................................................................................... 576
Event........................................................................................... 522 Write...................................................................................... 577
Extra ..................................................................................... 522 Writeln................................................................................... 578
Feq.............................................................................................. 522 TimeOut
Name ................................................................................................ 523 WebServerClassProperties.....................................................71
INDEX 643

TimerAction BeforeResetControl.......................................................................328
WebWindowBaseClassProperties....................................... 151 GetHasHotkey.................................................................................330
TimerDelay GetVisible ............................................................................. 331
WebWindowBaseClassProperties....................................... 151 Init .................................................................................... 333
TitleContents ResetControl..............................................................................331
WebWindowClassMethods....................................................... 215 WebCaptionClassMethods..........................................................423
toolbar merging .............................................................................. 117 CreateHtml.................................................................................423
ToolbarFeq GetCellAttributes.......................................................................424
WebFrameClassProperties................................................... 119 GetPosition ................................................................................425
WebWindowBaseClassProperties....................................... 152 GetText..................................................................................................... 426
GetVisible ............................................................................. 427
U Init .................................................................................... 428
WebCaptionClassProperties.......................................................422
UpdateCopyChoice Alignment...................................................................................422
WebControlClassMethods.................................................... 261 WebClientAreaClassMethods....................................................437
UpdateCopyUse CreateHtml.................................................................................437
WebControlClassMethods.................................................... 262 GetBackgroundColor....................................................................438
UpdateState GetPosition ................................................................................439
WebJavaListClassMethods................................................... 376 WebClientManagerClass....................................................................93
UseFonts WebClientManagerClassMethods ........................................... 96
HtmlClassProperties .......................................................... 532 Feq2Id...........................................................................................97
Using the IBCLibrary ................................................................. 32 Init ...................................................................................... 98
Kill..................................................................................99
V NextHtmlPage ................................................................................100
ValidatePassword TakeFile.............................................................................................100
WebWindowClassMethods....................................................... 216 TakeHtmlPage...................................................................................... 101
TakeJslData.....................................................................................103
W TakeUnauthorized..........................................................................105
WebClientManagerClassProperties ......................................... 94
wallpaper...........................................................159, 181, Broker ...........................................................................................94
192 Browser ........................................................................................94
Web-enable applications............................................................ 31 IP ...................................................................................95
Web-enabled applications.......................................................... 30 Jsl....................................................................................... 95
Web-enabledClarion application.................................................. 32 WebClientManagerClass synopsis...............................................35
WebAreaClass..................................................................................... 409 WebCloseButtonClassMethods .................................................388
WebAreaClassMethods .............................................................. 412 CreateHtml.................................................................................388
GetBackgroundColor................................................................... 412 CreateJslData............................................................................390
GetCellAttributes ...................................................................... 413 CreateParams ................................................................................391
GetFont............................................................................................. 414 GetAppletType................................................................................392
GetVisible............................................................................. 415 GetCloneFeq...................................................................................393
Init .................................................................................... 416 GetPosition ................................................................................394
Kill................................................................................ 417 GetVisible ............................................................................. 395
PushFont ......................................................................................... 418 Init .................................................................................... 396
SetBackground ........................................................................ 419 ResetControl..............................................................................397
SetFont....................................................................................... 420 WebCloseButtonClassProperties ...........................................387
SetParentDefaults.................................................................... 421 Height.................................................................................... 387
WebAreaClassProperties ........................................................... 411 Width..................................................................................... 387
Background .............................................................................. 411 X ...................................................................... 387
BackImage...................................................................................... 411 Y ...................................................................... 387
LocalFont................................................................................... 411 WebControlClass.................................................................................219
WebButtonClassMethods ........................................................... 328 WebControlClassDerivedClasses .........................................263
WebControlClassMethods ..........................................................225
644 IBC LIBRARY REFERENCE

BeforeResetControl...................................................................... 227 IsDynamic ........................................................................................223

CreateCellContents ................................................................. 227 OwnerWindow.......................................................................................223
CreateCellFooter...................................................................... 228 ParentFeq.........................................................................................224
CreateCellHeader.................................................................... 228 RealParentFeq ...............................................................................224
CreateColorParameters.............................................................. 229 WebControlListClassMethods....................................................134
CreateForeColorParameter........................................................ 230 AddControlsToLayout...................................................................135
CreateHtml ................................................................................ 231 CreateHtml.................................................................................136
CreateHtmlExtra....................................................................... 232 Init .................................................................................... 138
CreateJslData........................................................................... 232 Kill................................................................................ 138
CreateParams................................................................................ 233 SetParentDefaults ....................................................................139
DoSetChildDefaults ................................................................. 233 WebFilesClass................................................................................489
GetAlignText ................................................................................... 234 WebFilesClassMethods...............................................................491
GetAppletType............................................................................... 234 GetAlias ................................................................................ 492
GetBackgroundColor................................................................... 235 GetDirectory...............................................................................493
GetCanDisable .............................................................................. 236 GetFilename..............................................................................494
GetCellAttributes ...................................................................... 237 GetProgramRef ..............................................................................495
GetChoiceChanged................................................................ 238 GetPublicDirectory ...................................................................496
GetEventAction ........................................................................ 239 GetRelativeFilename ...............................................................498
GetFont............................................................................................. 240 GetSeparateSecure......................................................................499
GetHasHotkey................................................................................ 240 GetTempFilename.............................................................................. 500
GetIsChild ............................................................................ 241 Init .................................................................................... 501
GetLevel........................................................................................... 242 Kill................................................................................ 502
GetNameAttribute.................................................................... 242 LoadImage.................................................................................503
GetParentBackgroundColor....................................................... 243 RemoveAll........................................................................................504
GetPosition................................................................................ 244 SelectTarget.....................................................................................505
GetQuotedText......................................................................................245 WebFrameClass..................................................................................117
GetTableAttributes ........................................................................ 245 WebFrameClassMethods ................................................................120
GetText.....................................................................................................245 CopyControlsToWindow .................................................................. 120
GetUseChanged ..................................................................... 246 CopyControlToWindow......................................................................122
GetVisible............................................................................. 247 GetMenubarFeq.............................................................................123
Init .................................................................................... 248 GetToolbarFeq................................................................................124
Kill................................................................................ 249 TakeEvent................................................................................................125
PopFont....................................................................................................250 WebFrameClassProperties .........................................................119
PushFont ......................................................................................... 251 FrameWindow...................................................................................... 119
RefreshDisabled....................................................................... 252 MenubarFeq....................................................................................119
ResetControl ............................................................................. 253 ToolbarFeq.......................................................................................119
ResetFromQueue......................................................................... 254 WebHotlinkClassMethods...........................................................398
SetAutoSpotLink............................................................................ 255 CreateCellContents..................................................................398
SetBorderWidth........................................................................ 255 WebHtmlButtonClassMethods ...................................................332
SetBreakable ............................................................................ 256 CreateCellContents..................................................................332
SetChildDefaults....................................................................... 256 ResetControl..............................................................................334
SetDescription .......................................................................... 257 WebHtmlCheckClassMethods ...................................................271
SetEventAction......................................................................... 258 BeforeResetControl.......................................................................271
SetParentDefaults.................................................................... 260 CreateCellContents..................................................................272
SetQueue.................................................................................. 261 CreateJslData............................................................................273
UpdateCopyChoice...................................................................... 261 GetHasHotkey.................................................................................274
UpdateCopyUse............................................................................ 262 ResetControl..............................................................................275
WebControlClassProperties....................................................... 221 WebHtmlEntryClassMethods......................................................276
ActionOnAccept............................................................................. 221 CreateCellContents..................................................................276
Container ................................................................................... 222 CreateJslData............................................................................277
DisabledAction.......................................................................... 222 ResetControl..............................................................................278
Feq.............................................................................................. 223 WebHtmlGroupClassMethods ...................................................280
INDEX 645

CreateHtml ................................................................................ 280 WebHtmlSheetClassProperties..................................................304

GetHasHotkey................................................................................ 281 BorderWidth...............................................................................304
Init .................................................................................... 282 WebHtmlStringClassMethods.....................................................378
SetBorderWidth........................................................................ 283 CreateCellContents..................................................................378
WebHtmlGroupClassProperties................................................. 279 GetCellAttributes.......................................................................379
BorderWidth.............................................................................. 279 WebHtmlTabClassMethods.............................................................315
WebHtmlImageClassMethods................................................... 347 CreateHtml.................................................................................315
CreateCellContents ................................................................. 347 CreateJslData............................................................................316
SetChildDefaults....................................................................... 348 CreateParams ................................................................................317
SetDescription .......................................................................... 348 GetAppletType................................................................................318
WebHtmlImageClassProperties................................................. 346 GetHasHotkey.................................................................................321
AltText ............................................................................................... 346 GetIsChild............................................................................. 320
WebHtmlItemClassMethods....................................................... 284 GetPosition ................................................................................322
CreateCellContents ................................................................. 284 GetVisible ............................................................................. 323
GetVisible............................................................................. 285 ResetControl..............................................................................323
ResetControl ............................................................................. 286 SetParentDefaults ....................................................................324
WebHtmlListClassMethods........................................................ 356 WebHtmlTabClassProperties ..........................................................314
CreateCellContents ................................................................. 356 IsEnabled ...................................................................................314
CreateJslData........................................................................... 357 WebHtmlTextClassMethods .......................................................325
ResetControl ............................................................................. 358 CreateCellContents..................................................................325
WebHtmlMenuClassMethods.................................................... 287 CreateJslData............................................................................327
CreateCellContents ................................................................. 287 ResetControl..............................................................................327
CreateHtml ................................................................................ 288 WebImageClass...................................................................................345
GetCellAttributes ...................................................................... 289 WebJavaButtonClassMethods ...................................................336
GetVisible............................................................................. 290 CreateHtml.................................................................................337
WebHtmlOptionClassMethods .................................................. 292 CreateJslData............................................................................339
CreateHtml ................................................................................ 292 CreateParams ................................................................................339
CreateJslData........................................................................... 293 GetAppletType................................................................................340
GetTableAttributes ........................................................................ 294 GetCanDisable ...............................................................................341
Init .................................................................................... 295 GetFilename..............................................................................342
ResetControl ............................................................................. 296 ResetControl..............................................................................342
SetBorderWidth........................................................................ 297 WebJavaButtonClassProperties.................................................336
WebHtmlOptionClassProperties................................................ 291 IsEnabled ...................................................................................336
BorderWidth.............................................................................. 291 WebJavaImageClassMethods........................................................350
WebHtmlPromptClassMethods................................................. 298 CreateHtml.................................................................................350
CreateCellContents ................................................................. 298 CreateJslData............................................................................352
GetHasHotkey................................................................................ 299 CreateParams ................................................................................353
WebHtmlRadioClassMethods.................................................... 300 GetAppletType................................................................................354
CreateCellContents ................................................................. 300 WebJavaImageClassProperties .................................................349
GetHasHotkey................................................................................ 301 Filename ....................................................................................349
WebHtmlRegionClassMethods ................................................. 302 WebJavaListClassMethods.........................................................362
CreateHtmlExtra....................................................................... 302 CreateHtml.................................................................................362
SetParentDefaults.................................................................... 303 CreateJslData............................................................................364
WebHtmlSheetClassMethods.................................................... 305 CreateParams ................................................................................365
CreateHtml ................................................................................ 305 GetAppletType................................................................................366
CreateTabControl.......................................................................... 307 GetEventAction.........................................................................367
GetIsChild ............................................................................ 308 Init .................................................................................... 368
GetTableAttributes ........................................................................ 309 Kill................................................................................ 369
Init .................................................................................... 310 ResetControl..............................................................................370
ResetControl ............................................................................. 311 ResetFromQueue .........................................................................371
SetBorderWidth........................................................................ 312 SetAutoSpotLink.......................................................................372
SetChildDefaults....................................................................... 313 SetDirty ................................................................................. 373
646 IBC LIBRARY REFERENCE

SetEventAction......................................................................... 373 Server ................................................................................... 446

SetQueue.................................................................................. 375 WebServerClass....................................................................................63
UpdateState .............................................................................. 376 WebServerClassMethods..............................................................72
WebJavaListClassProperties...................................................... 359 Connect ........................................................................................74
AutoSpotLink............................................................................. 359 GetInternetEnabled ....................................................................75
EventActionQ............................................................................ 359 GetReadyForPage ..........................................................................76
Format........................................................................................ 360 GetRequestedWholePage............................................................77
FromQ .............................................................................................. 360 GetSendWholePage.......................................................................78
QueueActionQ............................................................................... 361 Halt .......................................................................................... 79
Started.................................................................................. 361 Init ...................................................................................... 80
WebJavaStringClassMethods.................................................... 381 Kill..................................................................................81
CreateHtml ................................................................................ 381 Quit.......................................................................................... 82
CreateJslData........................................................................... 382 SetDialogPageBackground..........................................................83
CreateParams................................................................................ 383 SetDialogWinBackground.............................................................84
GetAppletType............................................................................... 384 SetNewPageDisable.......................................................................86
Init .................................................................................... 385 SetNextAction..............................................................................87
SetAutoSpotLink............................................................................ 386 SetSendWholePage.......................................................................85
WebJavaStringClassProperties ................................................. 380 TakeEvent..................................................................................................88
AutoSpotLink............................................................................. 380 TakePageSent.........................................................................................89
LastText............................................................................................ 380 WebServerClassProperties...........................................................66
WebJavaToolButtonClassMethods......................................... 343 Active ...................................................................................... 66
GetEventAction ........................................................................ 343 ArgIndex.......................................................................................66
WebListClass ................................................................................. 355 Broker............................................................................................66
WebListClassMethods Client ....................................................................................... 67
GetBackgroundColor................................................................... 355 CommandLine..................................................................................68
WebLiteralClassMethods............................................................ 400 CurSubmit ..........................................................................................67
CreateHtml ................................................................................ 400 DialogPageBackColor.....................................................................68
GetCellAttributes ...................................................................... 401 DialogPageImage............................................................................68
WebLiteralClassProperties.......................................................... 399 DialogWinBackColor.......................................................................68
Text ............................................................................................................399 DialogWinImage.........................................................................69
WebMenubarClassMethods........................................................... 429 Files......................................................................................... 69
CreateHtml ................................................................................ 429 GotCommandLine...........................................................................69
GetPosition................................................................................ 430 JavaLibraryPath................................................................................70
GetVisible............................................................................. 431 PageToReturnTo ....................................................................................70
Init .................................................................................... 432 ProgramName.........................................................................................71
WebNullControlClassMethods .................................................. 402 TimeOut..............................................................................................71
CreateHtml ................................................................................ 402 WebServerClasssynopsis..............................................................35
CreateJslData........................................................................... 402 WebStringClassMethods.............................................................377
GetAppletType............................................................................... 403 SetBreakable.............................................................................377
GetCellAttributes ...................................................................... 404 WebToolbarClassMethods..........................................................433
GetIsChild ............................................................................ 405 CreateHtml.................................................................................433
GetVisible............................................................................. 406 GetAppletType................................................................................434
WebReportClass................................................................................. 443 GetPosition ................................................................................435
WebReportClassMethods .......................................................... 447 GetVisible ............................................................................. 436
Init .................................................................................... 447 WebWindowBaseClassMethods ...................................................153
Kill................................................................................ 447 CreateChildHtml........................................................................153
Preview ...................................................................................... 448 GetBackgroundColor....................................................................154
SetNumPages ............................................................................... 448 GetBackgroundImage..................................................................154
WebReportClassProperties........................................................ 445 GetChildren................................................................................156
Html............................................................................................. 445 GetControl..................................................................................155
NumPages...................................................................................... 446 GetCreateClose........................................................................155
Q ...................................................................... 445 GetFirstChild..............................................................................157
INDEX 647

GetHelpHandler..............................................................................157 CreateJslData............................................................................175
GetHelpReference................................................................... 158 CreatePageFooter.........................................................................176
GetHelpTarget.................................................................................158 CreatePageHeader.......................................................................176
GetMenubarFeq.............................................................................158 CreateUnauthorizedPage ...........................................................177
GetPageImage ...............................................................................159 GetAuthorized ...........................................................................179
GetShowMenubar...............................................................................159 GetBackgroundColor....................................................................180
GetShowToolbar..................................................................................159 GetBackgroundImage..................................................................181
GetToolbarFeq................................................................................160 GetButtonInClientArea.............................................................182
GetToolbarMode ............................................................................160 GetChildren................................................................................183
GetWebActiveFrame..........................................................................161 GetControl..................................................................................184
WebWindowBaseClassProperties............................................. 140 GetControlInfo...........................................................................186
AllowJava......................................................................................... 140 GetCreateClose........................................................................188
Background .............................................................................. 140 GetFirstChild..............................................................................187
BackImage...................................................................................... 140 GetHelpHandler..............................................................................189
BorderWidth.............................................................................. 141 GetHelpReference ...................................................................190
CloseImage............................................................................... 141 GetHelpTarget.................................................................................192
CreateCaption........................................................................... 141 GetMenubarFeq.............................................................................191
CreateClose.............................................................................. 142 GetPageImage...............................................................................192
CreateToolbar ................................................................................ 142 GetShowMenubar............................................................................... 194
DefaultButton ............................................................................ 143 GetShowToolbar.................................................................................. 194
DefaultButtonNeeded............................................................. 143 GetTableAttributes .........................................................................195
DisabledAction.......................................................................... 144 GetTargetSecurity..........................................................................195
Files ...................................................................................... 144 GetToolbarFeq................................................................................196
FormatBorderWidth...................................................................... 145 GetToolbarMode ............................................................................199
GroupBorderWidth ....................................................................... 145 GetWebActiveFrame ......................................................................... 198
HelpDocument............................................................................... 145 Init .................................................................................... 200
HelpEnabled ............................................................................. 146 Kill ..........................................................................200, 201
HelpRelative.............................................................................. 146 ResetFromControls.......................................................................200
HelpStyle ................................................................................... 146 SetBackground.........................................................................201
HtmlOption ................................................................................ 147 SetCentered ..............................................................................202
IsSplash..................................................................................... 147 SetChildDefaults .......................................................................202
MenubarFeq ................................................................................... 148 SetFormatOptions....................................................................203
MenubarType................................................................................. 148 SetHelpDocument .........................................................................204
OptionBorderWidth....................................................................... 148 SetHelpURL.....................................................................................205
PageBackground.......................................................................... 149 SetPageBackground ....................................................................206
PageImage ..................................................................................... 149 SetPassword ...................................................................................207
Server......................................................................................... 149 SetSplash...................................................................................208
SheetBorderWidth ........................................................................ 150 SetTimer.....................................................................................209
SnapX ............................................................................. 150 SuppressControl ............................................................................210
SnapY ............................................................................. 150 TakeCreatePage ................................................................................. 211
TimerAction............................................................................... 151 TakeEvent............................................................................................... 212
TimerDelay...................................................................................... 151 TakeRequest......................................................................................... 213
ToolbarFeq...................................................................................... 152 TakeUnknownSubmit......................................................................... 214
WebWindowClass .............................................................................. 131 TitleContents .............................................................................215
WebWindowClassMethods............................................................. 165 ValidatePassword ..........................................................................216
AddControl ................................................................................ 167 WebWindowClassProperties ......................................................162
AddControlsToLayout.................................................................. 169 Authorize ....................................................................................162
BodyFooter...................................................................................... 170 AuthorizeArea............................................................................163
BodyHeader ................................................................................... 171 HtmlTarget........................................................................................163
CreateChildHtml....................................................................... 172 IsCentered .................................................................................163
CreateDummyHtmlPage..................................................................173 IsSecure .....................................................................................164
CreateHtmlPage............................................................................ 174 SentHtml.....................................................................................164
648 IBC LIBRARY REFERENCE

WebWindowClasssynopsis................................................................35 HtmlClassMethods .............................................................564

Width WriteSubmitApplet
WebCloseButtonClassProperties...................................... 387 HtmlClassMethods .............................................................565
Write WriteTableFooter
TextOutputClassMethods...................................................... 577 HtmlClassMethods .............................................................566
WriteAppletDimParameter WriteTableHeader
HtmlClassMethods............................................................. 545 HtmlClassMethods .............................................................566
WriteAppletFilenameParameter WriteTableNewCol
HtmlClassMethods............................................................. 546 HtmlClassMethods .............................................................567
WriteAppletFontParameter WriteTableNewRow
HtmlClassMethods............................................................. 547 HtmlClassMethods .............................................................567
WriteAppletFooter WriteText
HtmlClassMethods........................................................... 548 HtmlClassMethods .............................................................568
WriteAppletHeader
HtmlClassMethods........................................................... 549 X
WriteAppletOptParameter
HtmlClassMethods........................................................... 550 X
WriteAppletParameter WebCloseButtonClassProperties......................................387
HtmlClassMethods........................................................... 551
WriteAppletUAID
Y
HtmlClassMethods........................................................... 552 Y
WriteChildAppletFooter WebCloseButtonClassProperties......................................387
HtmlClassMethods........................................................... 553
WriteChildAppletHeader
HtmlClassMethods........................................................... 554
WriteContainerAppletHeader
HtmlClassMethods........................................................... 555
WriteControlFooter
HtmlClassMethods........................................................... 556
WriteControlHeader
HtmlClassMethods........................................................... 556
WriteEventHandler
HtmlClassMethods........................................................... 557
WriteFontFooter
HtmlClassMethods........................................................... 559
WriteFontHeader
HtmlClassMethods........................................................... 559
WriteFormFooter
HtmlClassMethods........................................................... 560
WriteFormHeader
HtmlClassMethods........................................................... 560
WriteJavaScript
HtmlClassMethods........................................................... 561
Writeln
TextOutputClassMethods...................................................... 578
WriteOnFocusHandler HtmlClassMethods
.........................................................................
562
WritePageBody
HttpPageBaseClassMethods ................................. 620
WriteRefreshTimer
HtmlClassMethods............................................................. 563
WriteSpace
648 INDEX 649
IBC LIBRARY REFERENCE
NOTES 649

NOTES
650 C L A R I O N  IBC LIBRARY REFERENCE
NOTES 651
652 C L A R I O N  IBC LIBRARY REFERENCE
NOTES 653
654 C L A R I O N  IBC LIBRARY REFERENCE

Internet Builder Class Reference
No ratings yet
Internet Builder Class Reference
654 pages
Rational Application Developer For WebSphere Software V8 Programming Guide
No ratings yet
Rational Application Developer For WebSphere Software V8 Programming Guide
1,946 pages
Internet Application Guide
No ratings yet
Internet Application Guide
242 pages
Web Application Developers Guide
No ratings yet
Web Application Developers Guide
296 pages
Web Services Developers Guide
No ratings yet
Web Services Developers Guide
84 pages
Web Services Developers Guide PDF
No ratings yet
Web Services Developers Guide PDF
84 pages
Program AS 400
No ratings yet
Program AS 400
184 pages
EnterprisePharo PDF
No ratings yet
EnterprisePharo PDF
278 pages
Web Development With Java Using Hibernate, JSPs and Servlets ISBN 9781846288623, 1846288622 Instant EPUB Download
No ratings yet
Web Development With Java Using Hibernate, JSPs and Servlets ISBN 9781846288623, 1846288622 Instant EPUB Download
15 pages
Progress Webspeed
No ratings yet
Progress Webspeed
142 pages
TIBCO General Interface Overview
No ratings yet
TIBCO General Interface Overview
7 pages
2016 10 06 EnterprisePharo
No ratings yet
2016 10 06 EnterprisePharo
278 pages
Aswsp WebSpeed
No ratings yet
Aswsp WebSpeed
234 pages
PHP Best Practices Guide
No ratings yet
PHP Best Practices Guide
89 pages
Developing Java Servlets 2nd Edition James Goodwill Ebook Testbank Solutions Powerful Reading Format
No ratings yet
Developing Java Servlets 2nd Edition James Goodwill Ebook Testbank Solutions Powerful Reading Format
151 pages
Websphere Version 4 Application Developm
No ratings yet
Websphere Version 4 Application Developm
602 pages
Joel Murach, Michael Urban - Murach's Java Servlets and JSP (3rd Edition) (Training & Reference) - 2014 PDF
100% (2)
Joel Murach, Michael Urban - Murach's Java Servlets and JSP (3rd Edition) (Training & Reference) - 2014 PDF
767 pages
Borland JBuilder 9 Developing J2EE Applications
No ratings yet
Borland JBuilder 9 Developing J2EE Applications
106 pages
6-5-1 Webmethods Error Message Reference PDF
No ratings yet
6-5-1 Webmethods Error Message Reference PDF
1,020 pages
Weber Lang
No ratings yet
Weber Lang
78 pages
Phalcon PHP Framework Documentation
No ratings yet
Phalcon PHP Framework Documentation
635 pages
IbmWS and Microsoft Net
100% (1)
IbmWS and Microsoft Net
424 pages
Building Web Applications With NetTalk
No ratings yet
Building Web Applications With NetTalk
184 pages
Developing WebLogic Server Applications
No ratings yet
Developing WebLogic Server Applications
125 pages
WebLogic Server Application Development
No ratings yet
WebLogic Server Application Development
125 pages
Building Modern Frontends with htmx
No ratings yet
Building Modern Frontends with htmx
269 pages
Webmethods Administrator: User'S Guide
No ratings yet
Webmethods Administrator: User'S Guide
50 pages
(Ebook) Core Servlets and Javaserver Pages: Advanced Technologies by Marty Hall, Larry Brown, Yaakov Chaikin ISBN 9780131482609, 0131482602
No ratings yet
(Ebook) Core Servlets and Javaserver Pages: Advanced Technologies by Marty Hall, Larry Brown, Yaakov Chaikin ISBN 9780131482609, 0131482602
76 pages
Application Broker
No ratings yet
Application Broker
27 pages
Web-Based Database Applications Overview
No ratings yet
Web-Based Database Applications Overview
25 pages
PHP: The Right Way Guide
No ratings yet
PHP: The Right Way Guide
88 pages
Practicalcodeigniter3 PDF
100% (1)
Practicalcodeigniter3 PDF
196 pages
Building Distributed Applications Using The Progress Appserver
No ratings yet
Building Distributed Applications Using The Progress Appserver
248 pages
Using Zend Framework 2
No ratings yet
Using Zend Framework 2
414 pages
Net Suite Open Air So A Papi Guide
No ratings yet
Net Suite Open Air So A Papi Guide
212 pages
Rational Application Developer V6 Guide
100% (2)
Rational Application Developer V6 Guide
1,460 pages
Ebook Murach S Java Servlets and JSP 3rd Edition Murach Training Reference Joel Murach Michael Urban 9781890774783, 1890774782
100% (4)
Ebook Murach S Java Servlets and JSP 3rd Edition Murach Training Reference Joel Murach Michael Urban 9781890774783, 1890774782
192 pages
WS Message Broker Basics
No ratings yet
WS Message Broker Basics
368 pages
OSCCE System Management Guide
No ratings yet
OSCCE System Management Guide
94 pages
Essential Web Technologies Explained
No ratings yet
Essential Web Technologies Explained
10 pages
Implementing CICS Web Services Sg247206
No ratings yet
Implementing CICS Web Services Sg247206
628 pages
Pub Websphere Application Server Administration Using Jython
No ratings yet
Pub Websphere Application Server Administration Using Jython
496 pages
Lisp Web Tales
100% (1)
Lisp Web Tales
65 pages
Java Server Pages 1st Edition Hans Bergsten Ebook Testbank Solutions Complete Data Access
100% (3)
Java Server Pages 1st Edition Hans Bergsten Ebook Testbank Solutions Complete Data Access
130 pages
Sphinx PDF
No ratings yet
Sphinx PDF
440 pages
Microsoft Project Silk
No ratings yet
Microsoft Project Silk
319 pages
Development Tools For As400
100% (1)
Development Tools For As400
107 pages
Internet and Web Development Basics
No ratings yet
Internet and Web Development Basics
4 pages
WebSphere Application Server Express V6 Developers Guide and Development Examples 1st Ed Edition Bill Moore Ebook Extended Edition
100% (1)
WebSphere Application Server Express V6 Developers Guide and Development Examples 1st Ed Edition Bill Moore Ebook Extended Edition
34 pages
Getting Started With Webmethods Portal
No ratings yet
Getting Started With Webmethods Portal
54 pages
Vmime Book
No ratings yet
Vmime Book
74 pages
Web Application Development & Deployment Guide
No ratings yet
Web Application Development & Deployment Guide
30 pages
J2EE Server Config in JBuilder
No ratings yet
J2EE Server Config in JBuilder
144 pages
WebObjects3.5 DevelopersGuide
No ratings yet
WebObjects3.5 DevelopersGuide
218 pages
Learning Lisp for Web Development
No ratings yet
Learning Lisp for Web Development
91 pages
Dynamic File Driver Reference
No ratings yet
Dynamic File Driver Reference
86 pages
PDFXCDriver 30
No ratings yet
PDFXCDriver 30
50 pages
ST FF
No ratings yet
ST FF
15 pages
ClarioNET Manual (GauchoNet)
No ratings yet
ClarioNET Manual (GauchoNet)
144 pages
Integrating Subversion in Clarion IDE
No ratings yet
Integrating Subversion in Clarion IDE
3 pages
Clarion X ML Support
No ratings yet
Clarion X ML Support
31 pages
Clarion IDE FAQs and Tips Guide
No ratings yet
Clarion IDE FAQs and Tips Guide
175 pages
Advanced Topics Reference Guide
No ratings yet
Advanced Topics Reference Guide
265 pages
Honor Device App Initialization Logs
No ratings yet
Honor Device App Initialization Logs
18 pages
GameCenter Application Log Analysis
No ratings yet
GameCenter Application Log Analysis
11 pages
Comprehensive Guide to Express.js
No ratings yet
Comprehensive Guide to Express.js
10 pages
Lab 2a & 2b Instructions
No ratings yet
Lab 2a & 2b Instructions
5 pages
Network Support Interview Tips for IT
No ratings yet
Network Support Interview Tips for IT
9 pages
FortiGate Web Filtering Configuration Guide
No ratings yet
FortiGate Web Filtering Configuration Guide
96 pages
Honor Device QuickGame Log Errors
No ratings yet
Honor Device QuickGame Log Errors
19 pages
Network Devices Overview and Functions
No ratings yet
Network Devices Overview and Functions
179 pages
Notes Sharing Web App with Django
No ratings yet
Notes Sharing Web App with Django
28 pages
PHP Server-Side Scripting Overview
No ratings yet
PHP Server-Side Scripting Overview
170 pages
Comprehensive Guide to Network Protocols
No ratings yet
Comprehensive Guide to Network Protocols
2 pages
Principles of Network Applications
No ratings yet
Principles of Network Applications
38 pages
Golang Session Cookie Authentication Guide
No ratings yet
Golang Session Cookie Authentication Guide
12 pages
Internet Fundamentals Course Manual
No ratings yet
Internet Fundamentals Course Manual
66 pages
Web Application Security Essentials
No ratings yet
Web Application Security Essentials
25 pages
GLPI 10 System Requirements Overview
No ratings yet
GLPI 10 System Requirements Overview
6 pages
CC Experiment 5
No ratings yet
CC Experiment 5
4 pages
DHCP Server Installation Guide
No ratings yet
DHCP Server Installation Guide
16 pages
Honor Device QuickGame Errors
No ratings yet
Honor Device QuickGame Errors
23 pages
Web App Penetration Testing Analysis
No ratings yet
Web App Penetration Testing Analysis
146 pages
GameCenter Startup Log Analysis
No ratings yet
GameCenter Startup Log Analysis
6 pages
GameCenter Startup Process Logs
No ratings yet
GameCenter Startup Process Logs
22 pages
Ultimate Backend Development Course PDF
No ratings yet
Ultimate Backend Development Course PDF
42 pages
Web Designing Course Overview - ABES College
No ratings yet
Web Designing Course Overview - ABES College
223 pages
Understanding Vulnerability Scanning
No ratings yet
Understanding Vulnerability Scanning
20 pages
HTML Basics Quiz and Concepts
No ratings yet
HTML Basics Quiz and Concepts
7 pages
GameCenterBizApplication Startup Log
No ratings yet
GameCenterBizApplication Startup Log
19 pages
Network Automation and Data Formats
No ratings yet
Network Automation and Data Formats
44 pages
Sednit Espionage Toolkit Overview
No ratings yet
Sednit Espionage Toolkit Overview
52 pages
SharePoint Download Log for Mihael Berger
No ratings yet
SharePoint Download Log for Mihael Berger
7 pages