com.cc.framework.ui.painter
Interface Frame

All Known Implementing Classes:

TableFrame

public interface Frame

A Frame is a complex HTML element with the following properties:

• A Frame consists of multiple sections
• A Frame has at least one section
• A Section can have its own title
• Every Section of a frame has its own body

Version:

$Revision: 1.8 $

Author:

Harald Schulz

Method Summary

Frame	addBodyElement(org.apache.ecs.Element element) Adds an element to the frames body region.
Frame	addSection(org.apache.ecs.Element title) Adds a new section to the frame.
org.apache.ecs.ConcreteElement	createElement() Creates a ECS Element from this Frame
Frame	setBodyContainer(CompositeElement body) Sets the frames body container.
Frame	setClass(java.lang.String styleClass) Set the CLASS attribute.
Frame	setHeight(java.lang.String height) Set the HEIGHT attribute.
Frame	setID(java.lang.String id) Set the ID attribute.
Frame	setSectionContainer(CompositeElement container) Sets the frames section container.
Frame	setStyle(java.lang.String style) Set the STYLE attribute.
Frame	setSummary(java.lang.String summary) Set the SUMMARY attribute.
Frame	setWidth(java.lang.String width) Set the WIDTH attribute.

Method Detail

addSection

public Frame addSection(org.apache.ecs.Element title)

Adds a new section to the frame.

Parameters:

title - The section title element, or null if this section has no title

Returns:

The Frame

setSectionContainer

public Frame setSectionContainer(CompositeElement container)

Sets the frames section container. That is the element where all sections will be added

Parameters:

container - Section container

Returns:

Frame

addBodyElement

public Frame addBodyElement(org.apache.ecs.Element element)

Adds an element to the frames body region. It is up to the Frame how multiple elements are arranged in the frames body

Parameters:

element - The element to add

Returns:

The Frame

setBodyContainer

public Frame setBodyContainer(CompositeElement body)

Sets the frames body container. Thats where all body content will be added

Parameters:

body - sets the frames body element

Returns:

Frame

setID

public Frame setID(java.lang.String id)

Set the ID attribute.

Parameters:

id - sets the ID attribute.

Returns:

The Frame

setStyle

public Frame setStyle(java.lang.String style)

Set the STYLE attribute.

Parameters:

style - sets the STYLE attribute.

Returns:

The Frame

setClass

public Frame setClass(java.lang.String styleClass)

Set the CLASS attribute.

Parameters:

styleClass - sets the CLASS attribute.

Returns:

The Frame

setWidth

public Frame setWidth(java.lang.String width)

Set the WIDTH attribute.

Parameters:

width - sets the WIDTH attribute.

Returns:

The Frame

setHeight

public Frame setHeight(java.lang.String height)

Set the HEIGHT attribute.

Parameters:

height - sets the HEIGHT attribute.

Returns:

The Frame

setSummary

public Frame setSummary(java.lang.String summary)

Set the SUMMARY attribute.

Parameters:

summary - sets the SUMMARY attribute.

Returns:

The Frame

createElement

public org.apache.ecs.ConcreteElement createElement()

Creates a ECS Element from this Frame

Returns:

Element