com.webmethods.portal.mech.storage.page

Class PageData

java.lang.Object

com.webmethods.portal.mech.storage.page.PageData

public class PageData
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	m_canEdit
protected ColumnData	m_floaters
protected ColumnData	m_hobos
protected Map<String,String>	m_layout
protected List<RowData>	m_rows
protected IURI	m_uri

Constructor Summary

Constructors

Constructor and Description
PageData()
PageData(IURI page)
PageData(PageData page)

Method Summary

Modifier and Type	Method and Description
void	addFloater(PortletData hobo)
void	addHobo(PortletData hobo)
void	addLayoutProperties(Map<String,String> props)
void	addLayoutProperty(String name, String value)
void	addRow(RowData row)
void	addRow(RowData row, int index)
static String	escapeXML(String s) Escapes XML.
PortletData	findPortlet(IURI uri) Returns portlet data or null.
boolean	getCanEdit()
ColumnData	getFloatersColumn() Internal use only.
List<PortletData>	getFloatersTyped()
List	getHobos() Deprecated. use getHobosTyped() List of PortletData hobo portlets.
ColumnData	getHobosColumn() Internal use only.
List<PortletData>	getHobosTyped()
Map<String,String>	getLayoutProperties()
String	getLayoutProperty(String name)
List	getRows() Deprecated. use getRowsTyped() List of RowData rows.
List<RowData>	getRowsTyped()
IURI	getUri()
boolean	hasFloater(PortletData hobo)
boolean	hasHobo(PortletData hobo)
boolean	hasLayoutProperty(String name)
boolean	hasRow(RowData row)
boolean	hasRows(RowData row) Deprecated. use hasRow(RowData)
Iterator	listPortlets() Deprecated. use listPortlets(List) Lists all portlets from all rows, columns, and hobos.
List<PortletData>	listPortlets(List<PortletData> portlets) Returns list of contained portlets or empty list.
void	print(Writer out, int tabs)
static void	printLayout(Map<String,String> properties, Writer out, int tabs)
void	removeAllLayoutProperites()
boolean	removeFloater(PortletData hobo)
boolean	removeHobo(PortletData hobo)
void	removeLayoutProperty(String name)
void	removeRow(int index)
boolean	removeRow(RowData row)
void	setCanEdit(boolean canEdit)
void	setFloatersColumn(ColumnData floaters) Internal use only.
void	setHobosColumn(ColumnData hobos) Internal use only.
String	setLayoutProperty(String name, String value)
void	setUri(IURI uri)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

m_uri

protected IURI m_uri

m_rows

protected List<RowData> m_rows

m_hobos

protected ColumnData m_hobos

m_floaters

protected ColumnData m_floaters

m_layout

protected Map<String,String> m_layout

m_canEdit

protected boolean m_canEdit

Constructor Detail

PageData

public PageData()

PageData

public PageData(IURI page)

PageData

public PageData(PageData page)

Method Detail

escapeXML

public static String escapeXML(String s)

Escapes XML.

Returns:

Escaped string. Never null.

printLayout

public static void printLayout(Map<String,String> properties,
                               Writer out,
                               int tabs)
                        throws IOException

Throws:

IOException

getUri

public IURI getUri()

setUri

public void setUri(IURI uri)

getRows

public List getRows()

Deprecated. use getRowsTyped() List of RowData rows.

getRowsTyped

public List<RowData> getRowsTyped()

hasRows

public boolean hasRows(RowData row)

Deprecated. use hasRow(RowData)

hasRow

public boolean hasRow(RowData row)

addRow

public void addRow(RowData row)

addRow

public void addRow(RowData row,
                   int index)

removeRow

public boolean removeRow(RowData row)

removeRow

public void removeRow(int index)

getHobosColumn

public ColumnData getHobosColumn()

Internal use only.

setHobosColumn

public void setHobosColumn(ColumnData hobos)

Internal use only.

getHobos

public List getHobos()

Deprecated. use getHobosTyped() List of PortletData hobo portlets.

getHobosTyped

public List<PortletData> getHobosTyped()

hasHobo

public boolean hasHobo(PortletData hobo)

addHobo

public void addHobo(PortletData hobo)

removeHobo

public boolean removeHobo(PortletData hobo)

getFloatersColumn

public ColumnData getFloatersColumn()

Internal use only.

setFloatersColumn

public void setFloatersColumn(ColumnData floaters)

Internal use only.

getFloatersTyped

public List<PortletData> getFloatersTyped()

hasFloater

public boolean hasFloater(PortletData hobo)

addFloater

public void addFloater(PortletData hobo)

removeFloater

public boolean removeFloater(PortletData hobo)

toString

public String toString()

Overrides:

toString in class Object

print

public void print(Writer out,
                  int tabs)
           throws IOException

Throws:

IOException

findPortlet

public PortletData findPortlet(IURI uri)

Returns portlet data or null.

listPortlets

public Iterator listPortlets()

Deprecated. use listPortlets(List) Lists all portlets from all rows, columns, and hobos.

listPortlets

public List<PortletData> listPortlets(List<PortletData> portlets)

Returns list of contained portlets or empty list.

Parameters:

portlets - Optionally add to this list.

Returns:

List of contained portlets or empty list.

getLayoutProperties

public Map<String,String> getLayoutProperties()

hasLayoutProperty

public boolean hasLayoutProperty(String name)

getLayoutProperty

public String getLayoutProperty(String name)

setLayoutProperty

public String setLayoutProperty(String name,
                                String value)

addLayoutProperty

public void addLayoutProperty(String name,
                              String value)

addLayoutProperties

public void addLayoutProperties(Map<String,String> props)

removeLayoutProperty

public void removeLayoutProperty(String name)

removeAllLayoutProperites

public void removeAllLayoutProperites()

getCanEdit

public boolean getCanEdit()

setCanEdit

public void setCanEdit(boolean canEdit)