[class tree: bigace-classes] [index: bigace-classes] [all elements]

Class: ToolPortlet

Source Location: /CORE/system/classes/portlets/ToolPortlet.php

Class ToolPortlet

Class Overview

This portlets shows the Application Links in a List.

The default CSS class is "toolPortlet".

Located in /CORE/system/classes/portlets/ToolPortlet.php [line 57]

Portlet
   |
   --TranslatedPortlet
      |
      --ToolPortlet

Author(s):

Kevin Papst

Information Tags:

Version:	$Id: ToolPortlet.php,v 1.8 2008/09/22 16:42:41 kpapst Exp $
Copyright:	Copyright (C) Kevin Papst
License:	GNU Public License

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From TranslatedPortlet

TranslatedPortlet::getParameterName()

TranslatedPortlet::getTranslation()

Gets the Translation fo the given key.

TranslatedPortlet::loadBundle()

Loads the given ResourceBundle for this Portlet.

Inherited From Portlet

Portlet::Portlet()

Portlet::displayPortlet()

OPTIONAL TO BE OVERWRITEN!
Return if this Portlet should be displayed or not.

Portlet::getAllParameter()

Gets all configured Portlet Parameter.

Portlet::getHtml()

REQIURED TO BE OVERWRITEN!
Return the HTML snippet that this Portlet represents.

Portlet::getIdentifier()

Get the Identifier for this Portlet.

Portlet::getJavascript()

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

Portlet::getParameter()

Gets a Portlet Parameter.

Portlet::getParameterName()

Returns the Name of the given Parameter.

Portlet::getParameterType()

REQIURED TO BE OVERWRITEN!
Returns the PortletType for the given Key.

Portlet::getTitle()

REQIURED TO BE OVERWRITEN!
Return the Title for this Portlet.

Portlet::needsJavascript()

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

Portlet::setParameter()

Sets a Portlet Parameter.

[ Top ]

Method Summary

ToolPortlet	ToolPortlet()
void	getCSS()
void	getHomeID()
void	getHtml()
void	getIdentifier()
void	getJavascript()
void	getParameterType()
void	getShowLogin()
void	getTitle()	Returns the Title of this Portlet.
void	needsJavascript()
void	setCSS()	Set the CSS Class for the used List.
void	setHomeID()	Set the Home ID if different from _BIGACE_TOP_LEVEL .
void	setShowLogin()	Decide if the Link to the Login Formular should be displayed.
void	setTitle()	Set the Title of this Portlet.

[ Top ]

Methods

Constructor ToolPortlet [line 61]

ToolPortlet ToolPortlet(
)

[ Top ]

getCSS [line 158]

void getCSS(
)

[ Top ]

getHomeID [line 147]

void getHomeID(
)

[ Top ]

getHtml [line 98]

void getHtml(
)

Redefinition of:

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

[ Top ]

getIdentifier [line 80]

void getIdentifier(
)

Redefinition of:

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

[ Top ]

getJavascript [line 114]

void getJavascript(
)

Redefinition of:

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

[ Top ]

getParameterType [line 119]

void getParameterType(

$key 
)

Parameters:

$key:

Redefinition of:

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

[ Top ]

getShowLogin [line 135]

void getShowLogin(
)

[ Top ]

getTitle [line 94]

void getTitle(
)

Returns the Title of this Portlet.

Redefinition of:

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

[ Top ]

needsJavascript [line 110]

void needsJavascript(
)

Redefinition of:

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

[ Top ]

setCSS [line 165]

void setCSS(
[
$css = ''] 
)

Set the CSS Class for the used List.

Parameters:

$css:

[ Top ]

setHomeID [line 154]

void setHomeID(

$id 
)

Set the Home ID if different from

_BIGACE_TOP_LEVEL

Parameters:

$id:

[ Top ]

setShowLogin [line 143]

void setShowLogin(
[boolean
$show = true] 
)

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

Parameters:

boolean

$show:

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

[ Top ]

setTitle [line 87]

void setTitle(

$title 
)

Set the Title of this Portlet.

Parameters:

$title:

[ Top ]