ColumnData (server-common-api)

java.lang.Object
- com.webmethods.portal.mech.storage.page.ColumnData

```
public class ColumnData
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<IColumnItem>`	`m_items`
`protected Map<String,String>`	`m_layout`
`protected PageData`	`m_page`
`protected RowData`	`m_row`
`protected String`	`m_type`
`static String`	`PROP_ALIGN`
`static String`	`PROP_ATTRIBUTES`
`static String`	`PROP_BG_IMAGE`
`static String`	`PROP_CSS_CLASS`
`static String`	`PROP_CSS_STYLE`
`static String`	`PROP_VALIGN`
`static String`	`PROP_WIDTH`
`static String`	`PROP_WRAP`
`static String`	`TYPE_COLUMN`
`static String`	`TYPE_FLOATERS`
`static String`	`TYPE_HOBOS`

Constructor Summary

Constructors
Constructor and Description

ColumnData()

ColumnData(ColumnData column)

ColumnData(String width)

ColumnData(String width, List<String> attributes)

Constructors
Constructor and Description
`ColumnData()`
`ColumnData(ColumnData column)`
`ColumnData(String width)`
`ColumnData(String width, List<String> attributes)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addAttribute(String attr)`
`void`	`addAttributes(List attrs)` Deprecated. use `addAttributesTyped(List)` Add list of `String` attributes.
`void`	`addAttributesTyped(List<String> attrs)`
`void`	`addItem(IColumnItem item)`
`void`	`addItem(IColumnItem item, int index)`
`void`	`addLayoutProperties(Map<String,String> props)`
`void`	`addLayoutProperty(String name, String value)`
`void`	`addPortlet(PortletData portlet)`
`void`	`addPortlet(PortletData portlet, int index)`
`PortletData`	`findPortlet(IURI uri)` Returns contained portlet with specified uri or null.
`String`	`getAlign()`
`List`	`getAttributes()` Deprecated. use `getAttributesTyped()` List of `String` attributes.
`List<String>`	`getAttributesTyped()`
`String`	`getBgImage()`
`String`	`getCssClass()`
`String`	`getCssStyle()`
`int`	`getIndexInRow()` Returns column's (zero-based) index in row or -1 if not in a row.
`List<IColumnItem>`	`getItemsTyped()`
`Map<String,String>`	`getLayoutProperties()`
`String`	`getLayoutProperty(String name)`
`PageData`	`getPage()`
`List`	`getPortlets()` Deprecated. use `getPortletsTyped()` List of `PortletData` portlets.
`List<PortletData>`	`getPortletsTyped()`
`RowData`	`getRow()`
`List<RowData>`	`getRowsTyped()`
`String`	`getType()`
`String`	`getValign()`
`String`	`getWidth()`
`String`	`getWrap()`
`boolean`	`hasAttribute(String attr)`
`boolean`	`hasItem(IColumnItem item)`
`boolean`	`hasLayoutProperty(String name)`
`boolean`	`hasPortlet(PortletData portlet)`
`List<PortletData>`	`listPortlets(List<PortletData> portlets)` Returns list of contained portlets or empty list.
`void`	`print(Writer out, int tabs)`
`void`	`printAttributes(Writer out)`
`void`	`removeAllAttributes()`
`void`	`removeAllItems()`
`void`	`removeAllLayoutProperites()`
`void`	`removeAllPortlets()`
`boolean`	`removeAttribute(String attr)`
`boolean`	`removeItem(IColumnItem item)`
`void`	`removeItem(int index)`
`void`	`removeLayoutProperty(String name)`
`void`	`removePortlet(int index)`
`boolean`	`removePortlet(PortletData portlet)`
`void`	`setAlign(String align)`
`void`	`setBgImage(String bgImage)`
`void`	`setCssClass(String cssClass)`
`void`	`setCssStyle(String cssStyle)`
`String`	`setLayoutProperty(String name, String value)`
`void`	`setPage(PageData page)`
`void`	`setRow(RowData row)`
`void`	`setType(String type)`
`void`	`setValign(String valign)`
`void`	`setWidth(String width)`
`void`	`setWrap(String wrap)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PROP_ATTRIBUTES

public static final String PROP_ATTRIBUTES

See Also:: Constant Field Values

PROP_WIDTH
```
public static final String PROP_WIDTH
```
See Also:

Constant Field Values

PROP_WRAP
```
public static final String PROP_WRAP
```
See Also:

Constant Field Values

PROP_ALIGN
```
public static final String PROP_ALIGN
```
See Also:

Constant Field Values

PROP_VALIGN
```
public static final String PROP_VALIGN
```
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

TYPE_COLUMN
```
public static final String TYPE_COLUMN
```
See Also:

Constant Field Values

TYPE_HOBOS
```
public static final String TYPE_HOBOS
```
See Also:

Constant Field Values

TYPE_FLOATERS

public static final String TYPE_FLOATERS

See Also:: Constant Field Values

m_page
```
protected PageData m_page
```

m_row
```
protected RowData m_row
```

m_items
```
protected List<IColumnItem> m_items
```

m_layout
```
protected Map<String,String> m_layout
```

m_type
```
protected String m_type
```

Constructor Detail

ColumnData
```
public ColumnData()
```

ColumnData
```
public ColumnData(String width)
```

ColumnData

public ColumnData(String width,
                  List<String> attributes)

ColumnData
```
public ColumnData(ColumnData column)
```

Method Detail

getPage
```
public PageData getPage()
```

setPage
```
public void setPage(PageData page)
```

getRow
```
public RowData getRow()
```

setRow
```
public void setRow(RowData row)
```

getType
```
public String getType()
```

setType
```
public void setType(String type)
```

getIndexInRow
```
public int getIndexInRow()
```
Returns column's (zero-based) index in row or -1 if not in a row.

print

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

Throws:: IOException

toString
```
public String toString()
```
Overrides:

toString in class Object

findPortlet
```
public PortletData findPortlet(IURI uri)
```
Returns contained portlet with specified uri or null.

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.

getAttributes
```
public List getAttributes()
```
Deprecated. use getAttributesTyped() List of String attributes.

getAttributesTyped

public List<String> getAttributesTyped()

hasAttribute

public boolean hasAttribute(String attr)

addAttribute

public void addAttribute(String attr)

addAttributes
```
public void addAttributes(List attrs)
```
Deprecated. use addAttributesTyped(List) Add list of String attributes.

addAttributesTyped

public void addAttributesTyped(List<String> attrs)

removeAttribute

public boolean removeAttribute(String attr)

removeAllAttributes
```
public void removeAllAttributes()
```

printAttributes

public void printAttributes(Writer out)
                     throws IOException

Throws:: IOException

getPortlets
```
public List getPortlets()
```
Deprecated. use getPortletsTyped() List of PortletData portlets.

getPortletsTyped

public List<PortletData> getPortletsTyped()

hasPortlet

public boolean hasPortlet(PortletData portlet)

addPortlet

public void addPortlet(PortletData portlet)

addPortlet

public void addPortlet(PortletData portlet,
                       int index)

removePortlet

public boolean removePortlet(PortletData portlet)

removePortlet
```
public void removePortlet(int index)
```

removeAllPortlets
```
public void removeAllPortlets()
```

getRowsTyped
```
public List<RowData> getRowsTyped()
```

getItemsTyped

public List<IColumnItem> getItemsTyped()

hasItem

public boolean hasItem(IColumnItem item)

addItem

public void addItem(IColumnItem item)

addItem

public void addItem(IColumnItem item,
                    int index)

removeItem

public boolean removeItem(IColumnItem item)

removeItem
```
public void removeItem(int index)
```

removeAllItems
```
public void removeAllItems()
```

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

getWidth
```
public String getWidth()
```

setWidth
```
public void setWidth(String width)
```

getWrap
```
public String getWrap()
```

setWrap
```
public void setWrap(String wrap)
```

getAlign
```
public String getAlign()
```

setAlign
```
public void setAlign(String align)
```

getValign
```
public String getValign()
```

setValign
```
public void setValign(String valign)
```

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)

Class ColumnData

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROP_ATTRIBUTES

PROP_WIDTH

PROP_WRAP

PROP_ALIGN

PROP_VALIGN

PROP_CSS_CLASS

PROP_CSS_STYLE

PROP_BG_IMAGE

TYPE_COLUMN

TYPE_HOBOS

TYPE_FLOATERS

m_page

m_row

m_items

m_layout

m_type

Constructor Detail

ColumnData

ColumnData

ColumnData

ColumnData

Method Detail

getPage

setPage

getRow

setRow

getType

setType

getIndexInRow

print

toString

findPortlet

listPortlets

getAttributes

getAttributesTyped

hasAttribute

addAttribute

addAttributes

addAttributesTyped

removeAttribute

removeAllAttributes

printAttributes

getPortlets

getPortletsTyped

hasPortlet

addPortlet

addPortlet

removePortlet

removePortlet

removeAllPortlets

getRowsTyped

getItemsTyped

hasItem

addItem

addItem

removeItem

removeItem

removeAllItems

getLayoutProperties

hasLayoutProperty

getLayoutProperty

setLayoutProperty

addLayoutProperty

addLayoutProperties

removeLayoutProperty

removeAllLayoutProperites

getWidth

setWidth

getWrap

setWrap

getAlign

setAlign

getValign

setValign