PHP Classes

File: awfDialog/docs/index.php

Recommend this page to a friend!
  Classes of AW Ford   awfDialog Wizard   awfDialog/docs/index.php   Download  
File: awfDialog/docs/index.php
Role: Documentation
Content type: text/plain
Description: About and Feature List
Class: awfDialog Wizard
Generate wizard-like Web user interface using AJAX
Author: By
Last change: v 1.2 update
Date: 16 years ago
Size: 6,341 bytes
 

Contents

Class file image Download
<?php //Version 1.2 (final) include('../lib/awfDialog.php'); ?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <title>awfDialog Class :: About / Features</title> <link rel="stylesheet" href="style.css" type="text/css" media="screen" /> </head> <body> <div class="header"> <img src="images/testlab2.jpg" align=right><img src="images/testlabhead.jpg"> </div> <div class="content"> <table width="100%" cellpadding="2" cellspacing="1" border="0"> <tr> <td width="100%" valign="top"> <font size="1">awfDialog :: AJAX Enabled Dynamic Dialog Wizard Class :: Documentation</font> <center> <div id='container'> <?php $str1=""; $m1 = new awfDialog('D1','awfDialog Class About',$str1, ICON_INFO,false,'85%'); $m1->SetVAlign(BODY_TOP); $m1->SetImagePath("../lib/images/"); $m1->SetHAlign(BODY_LEFT); $m1->SetIconSize(ICON_SIZE_LG); $m1->SetGradient('224e15','c3f60a'); $m1->SetImagePHPURL('../lib/image2.php'); $m1->SetWizMode('false'); $m1->DisableWizImage(); $m1->SetGradientDirection(GRADIENT_V); $m1->SetBodyBGColor('#efffca'); $m1->AddOutput("<br>"); $m1->AddOutput("<div style='margin:5px 15px;font-size:10pt'>This class is designed to provide PHP developers with a highly configurable User Interface \"dialog box\" component that supports both a rich graphic interface and a great deal of functionality as well. It can be used to easily render a simple display box (such as this one), or a fully AJAX enabled wizard that allows you to dynamically render multiple screens of information. (See the Gradient Builder example for a Wizard-style dialog demonstration.)</div>"); $m1->AddOutput("<div style='margin:5px 15px;font-size:10pt'><b>Developer's Note:</b> I'm a long-time classic ASP developer, and have only recently made the switch to PHP. This is my first real PHP project from the ground up. While I've tested this class extensively and it functions very well, I'm certain there are lots of PHP architecture best practices that could be used to streamline the underlying code. I welcome any feedback or suggestions you might have.<br><br> - <b>A.W. Ford</b>, flooredmusic AT gmail.com</div>"); $m1->Render(); $m1->Clear(); $m1->SetID("D2"); $m1->SetTitle("awfDialog Class Features"); $m1->SetIconType(ICON_CONFIG); $m1->AddOutput("<br>"); $m1->AddOutput("<div style='margin:5px 15px;font-size:10pt'><dl><b>Modal Forms:</b><li>Dialog box can be rendered modal, meaning it cannot be closed, or non-modal, in which case the Exit button is enabled.</li></dl></div>"); $m1->AddOutput("<div style='margin:5px 15px;font-size:10pt'><dl><b>Form Icons:</b><li>Just like in Windows forms, each control can be assigned an icon to help make it's function more intuitive. awfDialog comes preloaded with 17 icon types, or you can insert your own via the ICON_CSS icon-type constant and the SetIcon() function. See the Usage Guide for a table of included icon types and their equivalent constants.</li></dl></div>"); $m1->AddOutput("<div style='margin:5px 15px;font-size:10pt'><dl><b>Icon Sizes:</b><li>Icons can be rendered in standard Windows 32x32 size, or smaller at approximately 20x20. This is set using the ICON_SIZE_SM or ICON_SIZE_LG constant with the SetIconSize() method.</li></dl></div>"); $m1->AddOutput("<div style='margin:5px 15px;font-size:10pt'><dl><b>Wizard Display Mode:</b><li>Enabling Wizard Mode causes the form content region to render in two side-by-side panes. Just like MS Office wizards or installer MSI files, you can set an image to display in the left pane or use the default, while the remainder of your content gets written to the right-hand pane.</li></dl></div>"); $m1->AddOutput("<div style='margin:5px 15px;font-size:10pt'><dl><b>AJAX Wizard Buttons:</b><li>Enabling Wizard Mode also makes a standard set of AJAX enabled buttons available to you. These include:<br> - Previous<br> - Cancel<br> - Next<br><br>Each of these buttons can be hidden or shown as needed and linked to any AJAX or other javascript method you desire. See the Gradient Builder example source files to understand how easy it is to build an entire wizard-style application using a relatively small amount of code.</li></dl></div>"); $m1->AddOutput("<div style='margin:5px 15px;font-size:10pt'><dl><b>Help Pane:</b><li>Enabling the Ajax Help button in the title bar adds a hidden help panel inside the Body Pane. When users click the Help button any content you've added to the dialog's help buffer is displayed here by default. Or you can override the Help button behavior using any Ajax method you choose.</li></dl></div>"); $m1->AddOutput("<div style='margin:5px 15px;font-size:10pt'><dl><b>Dynamic Gradient Support:</b><li>Jazzing up your dialog box with a nice gradient color image is as simple as setting two hexidecimal color values. And just to make it easier, you can use the Gradient Builder example to preview all those possible color combinations - find one you like and grab the hex codes.</li></dl></div>"); $m1->AddOutput("<div style='margin:5px 15px;font-size:10pt'><dl><b>Total Control of Look and Feel:</b><li>Each component element within an awfDialog object receives a unique, yet structure id derived from the ID you assign the dialog when instatiating the class. This means you can give each dialog you use on a page it's own individual look and feel via CSS, or dynamically load CSS styles from a database or other storage method you devise. I plan on adding an even more extensible theme definition structure and associated methods in the very near future.</li></dl></div>"); $m1->Render(); $m1->Clear(); ?> </div> </center> </td> <td width="120px" bgcolor="#efffca" valign="top" class="quick"> <?php include('docmenu.php');?> </td> </tr> </table> </div> <div class="footer"> <img src="images/KLNminilogo.jpg"><br><font color="white"> TestLab is an internal-use only production of <a href="http://knowledgelinknetwork.net">Knowledge Link Network</a></font><br> </div> </body> </html>