Docs For Class ToolPortlet

Description

This portlets shows the Application Links in a List.

The default CSS class is "toolPortlet".

author: Kevin Papst
version: $Id: ToolPortlet.php,v 1.7 2007/04/23 13:03:12 kpapst Exp $
copyright: Copyright (C) Kevin Papst
license: GNU Public License

Portlet
   |
   --TranslatedPortlet
      |
      --ToolPortlet

Method Summary

ToolPortlet ToolPortlet ()

void getCSS ()

void getHomeID ()

void getHtml ()

void getIdentifier ()

void getJavascript ()

void getParameterType ( $key)

void getShowLogin ()

void getTitle ()

void needsJavascript ()

void setCSS ([ $css = ''])

void setHomeID ( $id)

void setShowLogin ([boolean $show = true])

void setTitle ( $title)

Methods

Constructor ToolPortlet (line 63)

ToolPortlet ToolPortlet ()

getCSS (line 163)

void getCSS ()

getHomeID (line 152)

void getHomeID ()

getHtml (line 103)

void getHtml ()

Redefinition of:

Portlet::getHtml(): REQIURED TO BE OVERWRITEN!
Return the HTML snippet that this Portlet represents.

getIdentifier (line 85)

void getIdentifier ()

Redefinition of:

Portlet::getIdentifier(): Get the Identifier for this Portlet.

getJavascript (line 119)

void getJavascript ()

Redefinition of:

Portlet::getJavascript(): OPTIONAL TO BE OVERWRITEN!
Overwrite if your Portlet needs a Javascript snippet to work.

getParameterType (line 124)

void getParameterType ( $key)

$key

Redefinition of:

Portlet::getParameterType(): REQIURED TO BE OVERWRITEN!
Returns the PortletType for the given Key.

getShowLogin (line 140)

void getShowLogin ()

getTitle (line 99)

Returns the Title of this Portlet.

void getTitle ()

Redefinition of:

Portlet::getTitle(): REQIURED TO BE OVERWRITEN!
Return the Title for this Portlet.

needsJavascript (line 115)

void needsJavascript ()

Redefinition of:

Portlet::needsJavascript(): OPTIONAL TO BE OVERWRITEN!
This method defines if the Portlet needs a Javascript block to work.

setCSS (line 170)

Set the CSS Class for the used List.

void setCSS ([ $css = ''])

$css

setHomeID (line 159)

Set the Home ID if different from

_BIGACE_TOP_LEVEL

.

void setHomeID ( $id)

$id

setShowLogin (line 148)

Decide if the Link to the Login Formular should be displayed.

void setShowLogin ([boolean $show = true])

boolean $show: show TRUE if you want to see the Link, otherwise false

setTitle (line 92)

Set the Title of this Portlet.

void setTitle ( $title)

$title

Inherited Methods

Inherited From TranslatedPortlet

TranslatedPortlet::getParameterName()
TranslatedPortlet::getTranslation()
TranslatedPortlet::loadBundle()

Inherited From Portlet

Portlet::Portlet()
Portlet::displayPortlet()
Portlet::getAllParameter()
Portlet::getHtml()
Portlet::getIdentifier()
Portlet::getJavascript()
Portlet::getParameter()
Portlet::getParameterName()
Portlet::getParameterType()
Portlet::getTitle()
Portlet::needsJavascript()
Portlet::setParameter()