Drupal 6 JavaScript and jQuery - Ebook-Cours.com

var PrinterTool = {};
PrinterTool.windowSettings = 'toolbar=no,location=no,' +
'status=no,menu=no,scrollbars=yes,width=650,height=400';
[ 37 ]
Chapter 2
The first line is a comment with the $Id$ tag required by the coding standards. If this
file were checked into CVS, the line would be replaced with something like this:
// $Id: print_tools.js,v 1.0 2008/07/11 08:39 mbutcher Exp $
As you can see, CVS will add some information about the version of the file. This
information includes the name of the file, its version number, when it was checked
in, and who checked it in.
Directly beneath the ID comment is the file-wide documentation block.
Documentation blocks use a special comment style beginning with a slash and
two asterisks: /**. Automated documentation tools can later scan the file and pick
out the documentation blocks, automatically generating API documentation for
your script.
The role of the file-wide documentation block is to explain what the code in the file
does. The first line should be a single-sentence description of the file. Additional
paragraphs may be added.
In the following line, we define our PrinterTool object:
var PrinterTool = {};
This code is declaring the PrinterTool variable and assigning it an empty object literal
({}). This line plays an interesting role in the structure of our application, and we will
see constructs like this both within Drupal and in the later chapters of this book.
An object literal is a notation for defining an object by using its
symbolic delimiters, rather than by using a new constructor. That is,
instead of calling the new Object() constructor, we use the symbolic
representation of an empty object, {}, to declare an empty un-prototyped
object. We will use this method frequently in this book.
The role of the PrinterTool object is to serve as a namespace for our application.
A namespace is an organizational tool that allows the software developer to collect
various resources together . This is done without having to worry that these
resources will be in conflict with those created by other developers.
Objects that function as namespaces should always begin with an initial
capital letter, such as Drupal or PrinterTools.
This material is copyright and is licensed for the sole use by Richard Ostheimer on 18th June 2009
2205 hilda ave., , missoula, , 59801