当前页面: 在线文档首页 > JBOSS Portal 2.2 API 英文版文档

PortalThemeImpl - JBOSS Portal 2.2 API 英文版文档

Overview  Package   Class  Tree  Deprecated  Index  Help
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.jboss.portal.theme.impl
Class PortalThemeImpl

java.lang.Object
  org.jboss.portal.theme.metadata.ServerRegistrationMetaData
      org.jboss.portal.theme.metadata.ThemeRegistrationMetaData
          org.jboss.portal.theme.impl.PortalThemeImpl

All Implemented Interfaces:

PortalTheme

---

public class PortalThemeImpl

extends ThemeRegistrationMetaData

implements PortalTheme

Implementation of a Theme.

See Also:

PortalTheme

---

Constructor Summary

PortalThemeImpl(ServerRegistrationID id, javax.servlet.ServletContext context, java.lang.String contextPath, java.lang.String appID, java.lang.String name)

 

Method Summary
void	addElement(ThemeElement themeElement)           Add an element of this theme.
void	addLink(ThemeLink themeLink)           Add a link element to this theme
void	addScript(ThemeScript themeScript)           Add a script element to this theme
java.lang.String	getAppID()           Get the application name of the WAR that contains this theme
java.lang.String	getContextPath()           Get the context path of the servlet context in which the theme is contained.
java.util.List	getElements()           Get all elements of this theme.
java.util.List	getLinks()           Get all link elements that are defined as part of this theme
java.lang.String	getName()           Get the name of this theme.
java.util.List	getScripts()           Get all script elements that are defined as part of this layout
javax.servlet.ServletContext	getServletContext()           Get the servlet context in which the theme is defined
java.lang.String	toString()

 

Methods inherited from class org.jboss.portal.theme.metadata.ServerRegistrationMetaData

getRegistrationID

 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Constructor Detail

PortalThemeImpl

public PortalThemeImpl(ServerRegistrationID id,
                       javax.servlet.ServletContext context,
                       java.lang.String contextPath,
                       java.lang.String appID,
                       java.lang.String name)

Method Detail

getServletContext

public javax.servlet.ServletContext getServletContext()

Description copied from interface: PortalTheme

Get the servlet context in which the theme is defined

Specified by:

getServletContext in interface PortalTheme

Returns:

the servlet context that contains the theme resources

See Also:

PortalTheme.getServletContext()

---

getContextPath

public java.lang.String getContextPath()

Description copied from interface: PortalTheme

Get the context path of the servlet context in which the theme is contained.

Specified by:

getContextPath in interface PortalTheme

Returns:

the context path of the WAR that contains this theme

See Also:

PortalTheme.getContextPath()

---

getAppID

public java.lang.String getAppID()

Description copied from interface: PortalTheme

Get the application name of the WAR that contains this theme

Specified by:

getAppID in interface PortalTheme

Returns:

the application name of the WAR that contains this theme

See Also:

PortalTheme.getAppID()

---

getName

public java.lang.String getName()

Description copied from interface: PortalTheme

Get the name of this theme.

Specified by:

getName in interface PortalTheme

Returns:

the name of this theme

See Also:

PortalTheme.getName()

---

getScripts

public java.util.List getScripts()

Description copied from interface: PortalTheme

Get all script elements that are defined as part of this layout

Specified by:

getScripts in interface PortalTheme

Returns:

a java.util.List of script elements that are defined as part of this theme

See Also:

PortalTheme.getScripts()

---

getLinks

public java.util.List getLinks()

Description copied from interface: PortalTheme

Get all link elements that are defined as part of this theme

Specified by:

getLinks in interface PortalTheme

Returns:

a java.util.List of link elements that are defined as part of this theme

See Also:

PortalTheme.getLinks()

---

getElements

public java.util.List getElements()

Description copied from interface: PortalTheme

Get all elements of this theme.

Elements of a theme are all the child nodes in the HEAD tag that are part of this theme. A theme can currently have script and link tags

Specified by:

getElements in interface PortalTheme

Returns:

a java.util.List of all elements of the theme

See Also:

PortalTheme.getElements()

---

addLink

public void addLink(ThemeLink themeLink)

Description copied from interface: PortalTheme

Add a link element to this theme

Specified by:

addLink in interface PortalTheme

Parameters:

themeLink - the link element to add

See Also:

PortalTheme.addLink(org.jboss.portal.theme.ThemeLink)

---

addScript

public void addScript(ThemeScript themeScript)

Description copied from interface: PortalTheme

Add a script element to this theme

Specified by:

addScript in interface PortalTheme

Parameters:

themeScript - the script to add

See Also:

PortalTheme.addScript(org.jboss.portal.theme.ThemeScript)

---

addElement

public void addElement(ThemeElement themeElement)

Description copied from interface: PortalTheme

Add an element of this theme. The element can be a script of a link tag

Specified by:

addElement in interface PortalTheme

Parameters:

themeElement - the element to add to the theme

See Also:

ThemeElement

---

toString

public java.lang.String toString()

See Also:

Object.toString()

---

Overview  Package   Class  Tree  Deprecated  Index  Help
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---