Class: ComponentImage

Source Location: /components/image/ComponentImage.inc.php

Class Overview

XmlObject
   |
   --Component
      |
      --ComponentImage

Represents an image component. Also manages image upload and management

Methods

Inherited Methods

Class: Component

Component::__construct(): Construct a new component
Component::createNewDatabaseFieldIfRequested()
Component::doActionToUrlRedirections()
Component::getComponentCode(): Returns PHP code generated by the component which implements the component's functionality.
Component::getComponentCodeBeforeHtmlTag(): Returns PHP code generated by the component which implements the component's functionality.
Component::getComponentIdExpandedDefault(): Returns whether or not the input field for the component Id should be shown expanded by default or not (ie. collapsed). This function may be overwritten by individual components
Component::getHtmlEditorCustomization(): Returns javascript code to put a drop down in the HTML Editor tool bar for adding input fields and database field directly into the HTML text without typing it in. This function can be overridden if special buttons or dropdowns need to be added to the HTML Editor toolbar.
Component::getId(): Returns the component's Id from the XML
Component::getParentApp(): Returns the parent Application of this component
Component::getParentPage(): Returns the parent Page of this object
Component::getType(): Returns the type of the component as text.
Component::getX(): Returns the component's X-screen coordinate from the XML
Component::getY(): Returns the component's Y-screen coordinate from the XML
Component::getZ(): Returns the component's Z-screen coordinate (the depth) from the XML
Component::handlePropertiesUi(): Responds to user input from the edit component screen, performs input validation and stores input values until they are saved or discarded.
Component::isActive(): Returns TRUE if this component is currently marked active
Component::isComplete(): Returns true if complete functionality of the component has been defined, otherwise false
Component::printComponentHelp(): This function is a wrapper which calls the global printHelp from common.inc.php
Component::printHtmlEditorUi(): Prints the UI for an HTML editor
Component::printJavaScriptOnChangeFunction(): This function puts a javscript function in the edit component dialog box that handles the component id change. whenever the component id changes we add this new id into the list of options for the field it is associated to in a database.
Component::printLinkToDatabaseFieldUi(): Prints the UI for linking a component to a database field
Component::printPropertiesUi(): Outputs the User Interface for editing the components properties.
Component::printSubmitFormFunction()
Component::rewriteLinksForEditMode(): This function rewrites all HTML links '<a href="something">' to '<a href="something?editMode=1">'
Component::setActive(): Makes this component active
Component::setId(): Sets the component's Id in the XML
Component::setX(): Sets the component's X-screen coordinate in the XML
Component::setY(): Sets the component's Y-screen coordinate in the XML
Component::setZ(): Sets the component's Z-screen coordinate in the XML
Component::unsetActive(): Makes this component inactive

Class: XmlObject

XmlObject::__construct()
XmlObject::getDom(): Returns a refernce to the DOMDocument that is at the root of this XML object
XmlObject::getFirstChildNodeByTagName(): Returns a reference to the first child XML node with a particular name
XmlObject::getOrCreateChildNodeByTagName(): Returns a reference to the first child XML node with a particular name.
XmlObject::getXmlNode(): Returns a reference to the DOMNode of this XML object
XmlObject::removeAllChildNodesByTagName(): Deletes all child nodes that have a particular name
XmlObject::setXmlNode(): Sets a refernce to the DOMNode.

Class Details

[line 6]
Represents an image component. Also manages image upload and management

[ Top ]

Class Methods

method getComponentCode [line 164]

string getComponentCode(
)

Returns the code that is required to render the image on the screen.

Tags:

return:	code to render the component in PHP. (will be changed later to output code in various other server-side languages.)
access:	public

Overrides Component::getComponentCode() (Returns PHP code generated by the component which implements the component's functionality.)

[ Top ]

method getImageName [line 173]

string getImageName(
)

Returns the image name

Tags:

return:	Image name
access:	public

[ Top ]

method getType [line 14]

string getType(
)

Returns the type of the component i.e. image

Tags:

return:	image
access:	public

Overrides Component::getType() (Returns the type of the component as text.)

[ Top ]

method handlePropertiesUi [line 120]

boolean handlePropertiesUi(
mixed
$bInputErrorsSoFar)

Responds to user input from the edit component screen, performs input validation and stores input values until they are saved or discarded

Tags:

return:	TRUE if no user input error occurred, FALSE otherwise
access:	public

Overrides Component::handlePropertiesUi() (Responds to user input from the edit component screen, performs input validation and stores input values until they are saved or discarded.)

[ Top ]

method printBoxPickImageFromLibrary [line 38]

void printBoxPickImageFromLibrary(
)

Prints on the dialog box screen for image component creation, the pick image from

interface to allow th user to pick up an image that was already uploaded into the app library

Tags:

access:

public

[ Top ]

method printBoxUploadImage [line 22]

void printBoxUploadImage(
)

Prints on the dialog box screen for image component creation, the image upload

interface for the user to upload an image onto the application library

Tags:

access:

public

[ Top ]

method printPropertiesUi [line 108]

void printPropertiesUi(
)

This is the main function that creates the image component creation dialog box

and calls printBoxUploadImage() and printBoxPickImageFromLibrary() to render these specific pieces

Tags:

access:

public

Overrides Component::printPropertiesUi() (Outputs the User Interface for editing the components properties.)

[ Top ]

method setImageName [line 182]

void setImageName(
string
$sImageName)

Sets the image name

Tags:

access:

public

Parameters:

string

$sImageName

Image name

[ Top ]

Documentation generated on Wed, 12 Jan 2005 17:51:02 -0500 by phpDocumentor 1.3.0RC3