com.sapportals.htmlb

Class Group

java.lang.Object
  com.sapportals.htmlb.Component
      com.sapportals.htmlb.Container
          com.sapportals.htmlb.Group

public class Group

extends Container

A frame that is used to visually indicate elements that belong together

Copyright 2004 SAP AG

Field Summary

static String	UI_ID
static int	VAR_BEGIN
static int	VAR_END

Fields inherited from class com.sapportals.htmlb.Container

elements

Constructor Summary

Group()
create a new Group with default values, i.e.

Method Summary

GroupDesign	getDesign() get the design to be used for rendering this group.
Component	getHeaderComponent() get the header Component for this group.
String	getHeight() get the height of this group.
String	getTitle() get the title of this group
String	getTooltip()
String	getUI() get a identification String for the renderer that is unique across all supported components.
String	getWidth() get the width of this group.
boolean	isHeaderVisible() Get the header title visibility status
boolean	requiresForm() Determines if this Group requires to be placed in form.
void	setDesign(GroupDesign design) set the design to be used for rendering this group.
void	setHeaderComponent(Component headerComponent) set the header Component for this group.
void	setHeaderVisible(boolean visible) Get the header title visibility status
void	setHeight(String height) set the height of this group.
void	setTitle(String title) set the title of this group
void	setTooltip(String tooltip)
void	setWidth(String width) set the width of this group.

Methods inherited from class com.sapportals.htmlb.Container

addComponent, addRawText, addText, getChildCount, iterator, preRender, removeComponent, render

Methods inherited from class com.sapportals.htmlb.Component

getEncodedIdForForm, getId, getParent, initFromPageContext, initFromShortId, initializeFromId, isJsObjectNeeded, render, renderAsString, setId, setJsObjectNeeded, setParent

Methods inherited from class java.lang.Object

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

Field Detail

UI_ID

public static final String UI_ID

See Also:

Constant Field Values

VAR_BEGIN

public static final int VAR_BEGIN

See Also:

Constant Field Values

VAR_END

public static final int VAR_END

See Also:

Constant Field Values

Constructor Detail

Group

public Group()

create a new Group with default values, i.e. design SAPCOLOR, width 100% and no title.

Method Detail

getDesign

public GroupDesign getDesign()

get the design to be used for rendering this group.

Returns:

the design for this group

setDesign

public void setDesign(GroupDesign design)

set the design to be used for rendering this group.

Parameters:

design - the design for this group

getTooltip

public String getTooltip()

setTooltip

public void setTooltip(String tooltip)

getWidth

public String getWidth()

get the width of this group.

Returns:

the width of this group

setWidth

public void setWidth(String width)

set the width of this group.

Parameters:

width - the width of this group

getHeight

public String getHeight()

get the height of this group.

Returns:

the height of this group

setHeight

public void setHeight(String height)

set the height of this group.

Parameters:

height - the height of this group

getTitle

public String getTitle()

get the title of this group

Returns:

the title of this group

setTitle

public void setTitle(String title)

set the title of this group

Parameters:

title - the title of this group

getHeaderComponent

public Component getHeaderComponent()

get the header Component for this group. The component is rendered to the right of the title

Returns:

the Component or null if there is no header component

setHeaderComponent

public void setHeaderComponent(Component headerComponent)

set the header Component for this group. The component is rendered to the right of the title

Parameters:

headerComponent - the Component or null if there is no header component

getUI

public String getUI()

Description copied from class: Component

get a identification String for the renderer that is unique across all supported components. E.g. you could simply return the class name of the component class. The reason for using a separate method and not some internal reflection method is that you can more easily extend the functionality or your Component class without having to rewrite the view class.

Specified by:

getUI in class Component

Returns:

a unique identification string for this Component

requiresForm

public boolean requiresForm()

Determines if this Group requires to be placed in form. Always returns false.

Overrides:

requiresForm in class Component

Returns:

false: a Group doesn't require a form.

isHeaderVisible

public boolean isHeaderVisible()

Get the header title visibility status

Returns:

true if the header title is visible, else false

setHeaderVisible

public void setHeaderVisible(boolean visible)

Get the header title visibility status

Returns: