Summary: Field | Method | Constr Detail: Field | Method | Constr

org.zenmagick.rp.uip.themes.ZMThemeInfo

Class ZMThemeInfo

ZMObject
  |
  +--ZMThemeInfo

public class ZMThemeInfo
extends ZMObject

Theme info base class.

If a parent is set, configuration, layout and a few other settings will be merged.

Author:: DerManoMann
Version:: $Id: ZMThemeInfo.php 2167 2009-04-17 04:52:43Z dermanomann $

Fields inherited from org.zenmagick.ZMObject
properties_

Constructor Summary
ZMThemeInfo(ZMThemeInfo parent) Create new instance.

Constructor Summary

ZMThemeInfo(ZMThemeInfo parent)

Create new instance.

Method Summary
string	getAuthor() Get the theme author.
string	getDefaultLayout() Get the default layout.
string	getDescription() Get the theme description.
string	getErrorPage() Get the error page.
string	getLayoutFor(string page) Get the layout filename for the given page.
string	getName() Get the theme name.
string	getPageEventHandler(string event, string page) Get an event handler for a page.
int	getThemeId() Get the theme id.
string	getVersion() Get the theme version.
string	getViewsDir() Get the views directory.
boolean	hasDefaultLayout() Check if the theme has a default layout.
string	hasPageEventHandler(mixed event, string page, string even) Check if a event handler exists for the given event and page.
void	setAuthor(string author) Set the theme author.
void	setDefaultLayout(string name) Set the default layout.
void	setDefaultPageEventHandler(string event, string handler) Set the default page event handler.
void	setDescription(string description) Set the theme description.
void	setErrorPage(string name) Set the error page.
void	setLayout(string page, string name) Set the layout for the given page.
void	setName(string name) Set the theme name.
void	setPageEventHandler(string event, string page, string handler) Set an event handler for a particular page.
void	setParent(ZMThemeInfo parent) Set a parent theme info.
void	setThemeId(int themeId) Set the theme id.
void	setVersion(string version) Set the theme version.
void	setViewsDir(string dir) Set the views directory.

Methods inherited from org.zenmagick.ZMObject
attachMethod, get, getAttachedMethods, getPropertyNames, set, singleton

Constructor Detail

ZMThemeInfo

public ZMThemeInfo(ZMThemeInfo parent)

Create new instance.

Parameters:: parent - Optional parent theme info instance.

Method Detail

getAuthor

public string getAuthor()

Get the theme author.

Returns:: The theme author.

getDefaultLayout

public string getDefaultLayout()

Get the default layout.

Returns:: The default layout name.

getDescription

public string getDescription()

Get the theme description.

Returns:: The theme description.

getErrorPage

public string getErrorPage()

Get the error page.

Returns:: The error page.

getLayoutFor

public string getLayoutFor(string page)

Get the layout filename for the given page.

Parameters:: page - The page.
Returns:: The layout name.

getName

public string getName()

Get the theme name.

Returns:: The theme name.

getPageEventHandler

public string getPageEventHandler(string event, string page)

Get an event handler for a page.

Parameters:: event - The event.; page - The page.
Returns:: The handler name or null.
Deprecated.

getThemeId

public int getThemeId()

Get the theme id.

Returns:: The theme id.

getVersion

public string getVersion()

Get the theme version.

Returns:: The theme version.

getViewsDir

public string getViewsDir()

Get the views directory.

Returns:: The views directory name.
Deprecated:: use ZMTheme::getViewsDir() instead

hasDefaultLayout

public boolean hasDefaultLayout()

Check if the theme has a default layout.

Returns:: true if a default layout exists, false if not.

hasPageEventHandler

public string hasPageEventHandler(mixed event, string page, string even)

Check if a event handler exists for the given event and page.

Parameters:: even - The event.; page - The page.
Returns:: The handler name or null.
Deprecated.

setAuthor

public void setAuthor(string author)

Set the theme author.

Parameters:: author - The theme author.

setDefaultLayout

public void setDefaultLayout(string name)

Set the default layout.

Parameters:: name - The default layout name.

setDefaultPageEventHandler

public void setDefaultPageEventHandler(string event, string handler)

Set the default page event handler.

Parameters:: event - The event.; handler - The handler name.
Deprecated.

setDescription

public void setDescription(string description)

Set the theme description.

Parameters:: description - The theme description.

setErrorPage

public void setErrorPage(string name)

Set the error page.

Parameters:: name - The error page.

setLayout

public void setLayout(string page, string name)

Set the layout for the given page.

Parameters:: page - The page name.; name - The layout name.

setName

public void setName(string name)

Set the theme name.

Parameters:: name - The theme name.

setPageEventHandler

public void setPageEventHandler(string event, string page, string handler)

Set an event handler for a particular page.

Parameters:: event - The event.; page - The page to configure.; handler - The event handler.
Deprecated.

setParent

public void setParent(ZMThemeInfo parent)

Set a parent theme info.

This is to allow to use the default theme info configuration.

Parameters:: parent - An optional parent theme info.

setThemeId

public void setThemeId(int themeId)

Set the theme id.

Parameters:: themeId - The new theme id.

setVersion

public void setVersion(string version)

Set the theme version.

Parameters:: version - The theme version.

setViewsDir

public void setViewsDir(string dir)

Set the views directory.

Parameters:: dir - The views directory name.
Deprecated:: no replacement

Frames No frames