Class: SWFObject

Source Location: /html/SWFObject.class.php

Class Overview

ABSTObject
   |
   --ABSTHTMLTag
      |
      --HTMLLayer
         |
         --SWFObject

Author(s):

Daniel Plücken <daniel@debakel.net>

Version:

0.1.12

Copyright:

Copyright (C) 2006 Daniel Plücken <daniel@debakel.net>
This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License.
This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Variables

Methods

Inherited Variables

Class: HTMLLayer

HTMLLayer::$bgcolor
HTMLLayer::$body
HTMLLayer::$height
HTMLLayer::$left
HTMLLayer::$noformat
HTMLLayer::$position
HTMLLayer::$top
HTMLLayer::$visible
HTMLLayer::$width
HTMLLayer::$z_index

Class: ABSTHTMLTag

ABSTHTMLTag::$blur
ABSTHTMLTag::$click
ABSTHTMLTag::$focus
ABSTHTMLTag::$freestyle
ABSTHTMLTag::$id
ABSTHTMLTag::$mousemove
ABSTHTMLTag::$mouseout
ABSTHTMLTag::$mouseover
ABSTHTMLTag::$mouseup
ABSTHTMLTag::$name
ABSTHTMLTag::$no_format
ABSTHTMLTag::$other_attributes
ABSTHTMLTag::$style_class

Inherited Methods

Class: HTMLLayer

HTMLLayer::HTMLLayer(): Constructor.
HTMLLayer::get(): Returns a generated string based on the attributes of this HTML-Object.
HTMLLayer::setBGColor(): Sets the background color of this layer.
HTMLLayer::setBody(): Sets the content of this layer.
HTMLLayer::setHeight(): Sets the height of this layer.
HTMLLayer::setInvisible(): Sets the visibility of this layer to visible.
HTMLLayer::setLeft(): Sets the left-position of this layer.
HTMLLayer::setPosition(): Sets the behaviour of the position of this layer.
HTMLLayer::setTop(): Sets the top-position of this layer.
HTMLLayer::setVisible(): Sets the visibility of this layer to visible.
HTMLLayer::setWidth(): Sets the width of this layer.
HTMLLayer::setZIndex(): Sets the depth of this layer.

Class: ABSTHTMLTag

ABSTHTMLTag::getId(): Returns the value of this tag's "id"-attribute.
ABSTHTMLTag::getName(): Returns the value of this tag's "name"-attribute.
ABSTHTMLTag::HTMLTag(): The Constructor let the script die, cause this is an abstract class!
ABSTHTMLTag::idExists(): Stores all used ids and makes sure that every id in the document is unique. It should called in every get method of classes in the packages forms and html.
ABSTHTMLTag::setAttributes(): This method allows to set the attributes of the tag that are not handled by other methods.
ABSTHTMLTag::setFreeStyle(): Set the value of style definitions that are not handled by implemented methods.
ABSTHTMLTag::setId(): Stores the value of this item's "id"-attribute.
ABSTHTMLTag::setName(): Stores the value of this tag's "name"-attribute.
ABSTHTMLTag::setNoFormat(): Stores that the HTML-elements should not format by "\r\n" in the source.
ABSTHTMLTag::setOnBlur(): Sets the value of the blur-attribute of this html-tag.
ABSTHTMLTag::setOnClick(): Sets the value of the click-attribute of this html-tag.
ABSTHTMLTag::setOnFocus(): Sets the value of the focus-attribute of this html-tag.
ABSTHTMLTag::setOnMouseMove(): Sets the value of the mousemove-attribute of this html-tag.
ABSTHTMLTag::setOnMouseOut(): Sets the value of the mouseout-attribute of this html-tag.
ABSTHTMLTag::setOnMouseOver(): Sets the value of the mouseover-attribute of this html-tag.
ABSTHTMLTag::setOnMouseUp(): Sets the value of the mouseup-attribute of this html-tag.
ABSTHTMLTag::setStyle(): Set the value of the class-attribute of this tag.

Class: ABSTObject

ABSTObject::printComplexData(): Prints out the more complex data by the given array.
ABSTObject::printPrimitiveData(): Prints out the primitive data by the given arrays.
ABSTObject::printStructure(): Prints out the Structure of this Object.
ABSTObject::same(): Checks whether the passed object reference points to this object.
ABSTObject::sameReferences(): Compares two references whether they points to the same object

Class Details

[line 40]

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	0.1.12
copyright:	Copyright (C) 2006 Daniel Plücken <daniel@debakel.net> This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
since:	0.9.0.8
license:	GNU Lesser General Public License

[ Top ]

Class Variables

$delay = 0

[line 76]

Stores the delay to write the object in the html-container.

Tags:

access:

private

Type:

array

[ Top ]

$flash_version = "8"

[line 55]

The path to the swf object.

Tags:

access:

public

Type:

string

[ Top ]

$param_arr = array()

[line 62]

Stores the parameters that should put into the swf.

Tags:

access:

private

Type:

array

[ Top ]

$path = ""

[line 48]

The path to the swf object.

Tags:

access:

public

Type:

string

[ Top ]

$variable_arr = array()

[line 69]

Stores the variables that should put into the swf.

Tags:

access:

private

Type:

array

[ Top ]

Class Methods

constructor SWFObject [line 91]

void SWFObject(
$path
$path, [$id
$id = "flashcontent"])

Constructor.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	0.1.0
access:	public

Parameters:

$path	$path
$id	$id	The value of the name- and id-attribute of this layer.

[ Top ]

method addParam [line 174]

void addParam(
string
$name, string
$value)

Adds an parameter to this swf object.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	0.1.0
access:	public

Parameters:

string	$name
string	$value

[ Top ]

method addVariable [line 190]

void addVariable(
string
$name, string
$value)

Adds an variable to this swf object.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	0.1.1
access:	public

Parameters:

string	$name
string	$value

[ Top ]

method get [line 234]

string get(
)

Returns a generated string based on the attributes of this HTML-Object.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.2
since:	0.1.0
access:	public

Overrides HTMLLayer::get() (Returns a generated string based on the attributes of this HTML-Object.)

[ Top ]

method getJSIncludeForSWFObject [line 204]

string getJSIncludeForSWFObject(
)

Returns a javascript to generate a swf object.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	0.1.0
access:	public

[ Top ]

method setAlternative [line 158]

void setAlternative(
string
$string)

This function is an alias for setBody.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	0.1.0
access:	public

Parameters:

string

$string

[ Top ]

method setDelay [line 112]

void setDelay(
integer
$int)

Sets a delay for writing the object into the html-container. This can be used if a browser have problems with the display on a site refresh.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	0.1.12
access:	public

Parameters:

integer

$int

[ Top ]

method setFlashVersion [line 143]

void setFlashVersion(
integer
$int)

This function sets the required version of the flash player. This method is an alias for setVersion( $int ).

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	0.1.1
access:	public

Parameters:

integer

$int

[ Top ]

method setVersion [line 127]

void setVersion(
integer
$int)

This function sets the required version of the flash player.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	0.1.1
access:	public

Parameters:

integer

$int

[ Top ]

Documentation generated on Thu, 05 Jun 2008 19:15:15 +0200 by phpDocumentor 1.4.1