WACT_TAG
[ class tree: WACT_TAG ] [ index: WACT_TAG ] [ all elements ]

Class: CoreScriptTag

Source Location: /framework/template/tags/core/script.tag.php

InputAutoCompleteTag

http://wact.sourceforge.net/index.php/CoreScriptTag

http://www.juicystudio.com/tutorial/javascript/embedding.asp

Class Overview

CompilerComponent
   |
   --ServerComponentTag
      |
      --CoreScriptTag

Acts as a placeholder for writing JavaScript.

Variables

Methods


Inherited Variables

Inherited Methods

Class: ServerComponentTag

ServerComponentTag::generateConstructor()
Calls the parent getComponentRefCode() method and writes it to the
ServerComponentTag::getComponentRefCode()
Returns a string of PHP code identifying the component in the hierarchy.

Class: CompilerComponent

CompilerComponent::addChild()
Adds a child component, by reference, to the array of children
CompilerComponent::addChildAttribute()
Sets the XML attributes for this component (as extracted from the template)
CompilerComponent::CheckNestingLevel()
Used to perform some error checking on the source template, such as examining the tag hierarchy and triggering an error if a tag is incorrectly nested.
CompilerComponent::findChild()
Returns a child component, given it's ServerID
CompilerComponent::findChildByClass()
Returns a child component, given it's compile time component class
CompilerComponent::findChildrenByClass()
Returns an array of child components, given it's compile time component class
CompilerComponent::findImmediateChildByClass()
Returns a child component, given it's compile time component class
CompilerComponent::findParentByClass()
Returns a parent component, recursively searching parents by their compile time component class name
CompilerComponent::findSelfOrParentByClass()
Extends findParentByClass to begin search at the current component then moving on to its parent, if there's no match.
CompilerComponent::generate()
Calls the local preGenerate(), generateContents() and postGenerate() methods.
CompilerComponent::generateAttributeList()
CompilerComponent::generateConstructor()
Calls the generateConstructor() method of each child component
CompilerComponent::generateContents()
Calls the generate() method of each child component
CompilerComponent::generateDynamicAttributeList()
CompilerComponent::getAttribute()
Returns the value of an XML attribute (as extracted from template) or NULL if attribute not found
CompilerComponent::getAttributesAsArray()
Returns an array containing the attributes of this component that can be resolved at compile time.
CompilerComponent::getBoolAttribute()
Return the value of a boolean attribute as a boolean.
CompilerComponent::getClientId()
Get the value of the XML id attribute
CompilerComponent::getComponentRefCode()
Gets the component reference code of the parent.
CompilerComponent::getDataSource()
If a parent compile time component exists, returns the value of the parent's getDataSource() method, which will be a concrete implementation
CompilerComponent::getDataSourceRefCode()
Gets the DataSource reference code of the parent
CompilerComponent::getLastChild()
Returns the last child added to a component
CompilerComponent::getParentDataSource()
Gets the parent in the DataSource, if one exists
CompilerComponent::getProperty()
CompilerComponent::getRootDataSource()
Gets a root DataSource
CompilerComponent::getServerId()
Returns the identifying server ID.
CompilerComponent::hasAttribute()
Check to see whether a named attribute exists
CompilerComponent::isDataSource()
CompilerComponent::postGenerate()
Post generation method, calls the WrappingComponents generateWrapperPostfix() method if the component exists
CompilerComponent::preGenerate()
Pre generation method, calls the WrappingComponents generateWrapperPrefix() method if the component exists
CompilerComponent::prepare()
Calls the prepare method for each child component, which will override
CompilerComponent::preParse()
Provides instruction to the template parser, while parsing is in
CompilerComponent::registerProperty()
register a property with this component. Currently, this component must be a database to support properties.
CompilerComponent::registerWrapper()
Set a wrapping component for this component
CompilerComponent::removeAttribute()
Remove an attribute from the list
CompilerComponent::removeChild()
Removes a child component, given it's ServerID
CompilerComponent::setAttribute()
Sets an attribute

Class Details

Acts as a placeholder for writing JavaScript.

Allows JavaScript to be written both at compile time and runtime. Normally this tag would be placed inside the head tag of an HTML page but for other markups, e.g. XUL, it may appear otherwise. It is the responsibility of the template designer to place this tag correctly. When writing complile time Javascript to it, add the JavaScript using the components preParse() method. Within preParse use findParentByClass to get the root of the component tree then findChildByClass to find the CoreScriptTag.


Class Variables


$javascript =

Compile time JavaScript to write to template
access:  private
Type:   string

$runtimeComponentName = CoreScriptComponent

Name of runtime component class
access:  private
Type:   string

$runtimeIncludeFile = template/components/core/script.inc.php

File to include at runtime
var:  path to runtime component relative to WACT_ROOT
access:  private
Type:   string

Class Methods


method generateContents



void generateContents( CodeWriter &$code)

API Tags:

access:  protected
Overrides CompilerComponent::generateContents() (Calls the generate() method of each child component)

Parameters:

CodeWriter   &$code  

method writeJavaScript

Write some JavaScript into the container

void writeJavaScript( string $javascript)

API Tags:

access:  public

Parameters:

string   $javascript   JavaScript to write to compiled template
WACT: Copyright 2003 Procata, Inc. Released under the LGPL license (http://www.gnu.org/copyleft/lesser.html)
Documentation generated on Sun, 28 Nov 2004 19:49:40 -0800 by phpDocumentor 1.2.3