Package com.webmethods.portal.mech.storage.page

Class PortletData

java.lang.Object

com.webmethods.portal.mech.storage.page.PortletData

All Implemented Interfaces:

IColumnItem, Comparable<PortletData>

public class PortletData
extends Object
implements Comparable<PortletData>, IColumnItem

Comparable by uri.

Field Summary

Fields

Modifier and Type	Field	Description
protected ColumnData	m_column
protected boolean	m_forceThisWiring
protected Map<String,String>	m_layout
protected PageData	m_page
protected Map<String,Object>	m_properties
protected IURI	m_uri
protected Map<String,WiredProperty>	m_wiredProperties
static final String	PROP_ATTRIBUTES
static final String	PROP_BG_IMAGE
static final String	PROP_BORDER
static final String	PROP_CSS_CLASS
static final String	PROP_CSS_STYLE
static final String	PROP_HEIGHT
static final String	PROP_LEFT
static final String	PROP_TITLEBAR
static final String	PROP_TOP
static final String	PROP_WIDTH

Constructor Summary

Constructors

Constructor	Description
PortletData()
PortletData(PortletData portlet)
PortletData(IURI portlet)

Method Summary

Modifier and Type	Method	Description
void	addLayoutProperties(Map<String,String> props)
void	addLayoutProperty(String name, String value)
void	addProperties(Map properties)	Deprecated. use addPropertiesTyped(Map) Add map of String property names to String values.
void	addPropertiesTyped(Map<String,Object> properties)
void	addProperty(String name, Object value)
void	addWiredProperties(Map properties)	Deprecated. addWiredPropertiesTyped(Map) Add map of String property names to WiredProperty values.
void	addWiredPropertiesTyped(Map<String,WiredProperty> properties)
void	addWiredProperty(String name, WiredProperty property)
int	compareTo(PortletData pd)
boolean	equals(Object o)
PageData	findPage()	Deprecated. use getPage()
String	getBgImage()
String	getBorder()
ColumnData	getColumn()
String	getCssClass()
String	getCssStyle()
String	getHeight()
int	getIndexInColumn()	Returns portlet's (zero-based) index in column or -1 if not in a column.
Map<String,String>	getLayoutProperties()
String	getLayoutProperty(String name)
PageData	getPage()
Map	getProperties()	Deprecated. use getPropertiesTyped() Map of String property names to String values.
Map<String,Object>	getPropertiesTyped()
Object	getProperty(String name)
String	getTitlebar()
IURI	getUri()
String	getWidth()
Map	getWiredProperties()	Deprecated. getWiredPropertiesTyped() Map of String property names to WiredProperty values.
Map<String,WiredProperty>	getWiredPropertiesTyped()
WiredProperty	getWiredProperty(String name)
int	hashCode()
boolean	hasLayoutProperty(String name)
boolean	isForceThisWiring()
void	print(Writer out, int tabs)
void	removeAllLayoutProperites()
void	removeLayoutProperty(String name)
Object	removeProperty(String name)
WiredProperty	removeWiredProperty(String name)
void	setBgImage(String bgImage)
void	setBorder(String border)
void	setColumn(ColumnData column)
void	setCssClass(String cssClass)
void	setCssStyle(String cssStyle)
void	setForceThisWiring(boolean forceThisWiring)
void	setHeight(String height)
String	setLayoutProperty(String name, String value)
void	setPage(PageData page)
void	setTitlebar(String titlebar)
void	setUri(IURI x)
void	setWidth(String width)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

PROP_ATTRIBUTES

public static final String PROP_ATTRIBUTES

See Also:

• Constant Field Values

PROP_TITLEBAR

public static final String PROP_TITLEBAR

See Also:

• Constant Field Values

PROP_BORDER

public static final String PROP_BORDER

See Also:

• Constant Field Values

PROP_TOP

public static final String PROP_TOP

See Also:

• Constant Field Values

PROP_LEFT

public static final String PROP_LEFT

See Also:

• Constant Field Values

PROP_WIDTH

public static final String PROP_WIDTH

See Also:

• Constant Field Values

PROP_HEIGHT

public static final String PROP_HEIGHT

See Also:

• Constant Field Values

PROP_CSS_CLASS

public static final String PROP_CSS_CLASS

See Also:

• Constant Field Values

PROP_CSS_STYLE

public static final String PROP_CSS_STYLE

See Also:

• Constant Field Values

PROP_BG_IMAGE

public static final String PROP_BG_IMAGE

See Also:

• Constant Field Values

m_page

protected PageData m_page

m_column

protected ColumnData m_column

m_uri

protected IURI m_uri

m_wiredProperties

protected Map<String,WiredProperty> m_wiredProperties

m_properties

protected Map<String,Object> m_properties

m_layout

protected Map<String,String> m_layout

m_forceThisWiring

protected boolean m_forceThisWiring

Constructor Details

PortletData

public PortletData()

PortletData

public PortletData(IURI portlet)

PortletData

public PortletData(PortletData portlet)

Method Details

findPage

public PageData findPage()

Deprecated.

use getPage()

getPage

public PageData getPage()

Specified by:

getPage in interface IColumnItem

setPage

public void setPage(PageData page)

Specified by:

setPage in interface IColumnItem

getColumn

public ColumnData getColumn()

Specified by:

getColumn in interface IColumnItem

setColumn

public void setColumn(ColumnData column)

Specified by:

setColumn in interface IColumnItem

getIndexInColumn

public int getIndexInColumn()

Returns portlet's (zero-based) index in column or -1 if not in a column.

Specified by:

getIndexInColumn in interface IColumnItem

print

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

Specified by:

print in interface IColumnItem

Throws:

IOException

getUri

public IURI getUri()

setUri

public void setUri(IURI x)

getWiredProperties

public Map getWiredProperties()

Deprecated.

getWiredPropertiesTyped() Map of String property names to WiredProperty values.

getWiredPropertiesTyped

public Map<String,WiredProperty> getWiredPropertiesTyped()

getWiredProperty

public WiredProperty getWiredProperty(String name)

addWiredProperty

public void addWiredProperty(String name,
 WiredProperty property)

addWiredProperties

public void addWiredProperties(Map properties)

Deprecated.

addWiredPropertiesTyped(Map) Add map of String property names to WiredProperty values.

addWiredPropertiesTyped

public void addWiredPropertiesTyped(Map<String,WiredProperty> properties)

removeWiredProperty

public WiredProperty removeWiredProperty(String name)

getProperties

public Map getProperties()

Deprecated.

use getPropertiesTyped() Map of String property names to String values.

getPropertiesTyped

public Map<String,Object> getPropertiesTyped()

getProperty

public Object getProperty(String name)

addProperty

public void addProperty(String name,
 Object value)

addProperties

public void addProperties(Map properties)

Deprecated.

use addPropertiesTyped(Map) Add map of String property names to String values.

addPropertiesTyped

public void addPropertiesTyped(Map<String,Object> properties)

removeProperty

public Object removeProperty(String name)

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()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(PortletData pd)

Specified by:

compareTo in interface Comparable<PortletData>

getTitlebar

public String getTitlebar()

setTitlebar

public void setTitlebar(String titlebar)

getBorder

public String getBorder()

setBorder

public void setBorder(String border)

getWidth

public String getWidth()

setWidth

public void setWidth(String width)

getHeight

public String getHeight()

setHeight

public void setHeight(String height)

getCssClass

public String getCssClass()

setCssClass

public void setCssClass(String cssClass)

getCssStyle

public String getCssStyle()

setCssStyle

public void setCssStyle(String cssStyle)

getBgImage

public String getBgImage()

setBgImage

public void setBgImage(String bgImage)

isForceThisWiring

public boolean isForceThisWiring()

setForceThisWiring

public void setForceThisWiring(boolean forceThisWiring)