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

PortalLayoutMetaData - JBOSS Portal 2.6 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.metadata
Class PortalLayoutMetaData

java.lang.Object
  org.jboss.portal.theme.metadata.PortalLayoutMetaData

---

public final class PortalLayoutMetaData

extends java.lang.Object

Meta data describing a portal layout.

here is an example for a layout descriptor:

nodesk /nodesk/index.jsp generic /layouts/generic/index.jsp /layouts/generic/maximized.jsp

Version:

$Revision: 5448 $

Author:

Martin Holzner

---

Field Summary
private  java.lang.String	className
private  java.lang.String	name
private  java.util.List	regionNames
private  java.util.Map	stateURIMap
private  java.lang.String	uri

 

Constructor Summary

PortalLayoutMetaData()

 

Method Summary
java.lang.String	getClassName()
java.util.Map	getLayoutURIStateMap()
java.lang.String	getName()
java.util.List	getRegionNames()
java.lang.String	getURI()
void	setClassName(java.lang.String className)
void	setName(java.lang.String name)
void	setURI(java.lang.String URI)

 

Methods inherited from class java.lang.Object

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

 

Field Detail

name

private java.lang.String name

---

uri

private java.lang.String uri

---

stateURIMap

private java.util.Map stateURIMap

---

regionNames

private java.util.List regionNames

---

className

private java.lang.String className

Constructor Detail

PortalLayoutMetaData

public PortalLayoutMetaData()

Method Detail

getName

public java.lang.String getName()

Returns:

the name of this layout

---

setName

public void setName(java.lang.String name)

---

getURI

public java.lang.String getURI()

Returns:

the URI for this layout as defined in the descriptor (this is the uri without a state attribute)

---

setURI

public void setURI(java.lang.String URI)

---

getLayoutURIStateMap

public java.util.Map getLayoutURIStateMap()

Returns:

a map of layout URIs (String) keyed by layout state (String) as defined in the layout descriptor

---

getRegionNames

public java.util.List getRegionNames()

Returns:

a list of the region names (of type String) of this layout as defined in the layout meta data

---

getClassName

public java.lang.String getClassName()

Returns:

the class name of the layout implementation to use

---

setClassName

public void setClassName(java.lang.String className)

---

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

---