com.sapportals.htmlb

Class ScrollContainer

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

public class ScrollContainer

extends Container

An area of fixed size that scrolls if contents are bigger

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

ScrollContainer()
Scroll container

ScrollContainer(String id)

Method Summary

String	getAccessibilityDescription() get the semantical description of the component in it's applicationcontext used by screenreaders
String	getHeight() get the height of this scrollContainer.
int	getHorizontalScrollPosition() get the horizontal scrolling position of this scrollContainer.
String	getTooltip()
String	getUI() get a identification String for the renderer that is unique across all supported components.
int	getVerticalScrollPosition() get the vertical scrolling position of this scrollContainer.
String	getWidth() get the width of this group.
protected void	initFromPageContext(IPageContext pc, String baseId) internal use only.
boolean	isLayout()
boolean	requiresForm() Determines if this Group requires to be placed in form.
boolean	returnsScrollPosition() get the horizontal scrolling position of this scrollContainer.
void	setAccessibilityDescription(String accessibilityDescription) sets the sematical description for the component in it's applicationcontext used by screenreaders
void	setHeight(String height) set the height of this scrollContainer.
void	setHorizontalScrollPosition(int horizontalPosition) set the horizontal scrolling position of this scrollContainer.
void	setIsLayout(boolean layout)
void	setReturnsScrollPosition(boolean returnScrollPosition) enable the feature to return the scrolling position
void	setTooltip(String tooltip)
void	setVerticalScrollPosition(int verticalPosition) set the vertical scrolling position of this scrollContainer.
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, 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

ScrollContainer

public ScrollContainer()

Scroll container

ScrollContainer

public ScrollContainer(String id)

Method Detail

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 scrollContainer.

Returns:

the height of this scrollContainer

setHeight

public void setHeight(String height)

set the height of this scrollContainer.

Parameters:

height - the height of this scrollContainer

getVerticalScrollPosition

public int getVerticalScrollPosition()

get the vertical scrolling position of this scrollContainer.

Returns:

the vertical scrolling position of this scrollContainer

setVerticalScrollPosition

public void setVerticalScrollPosition(int verticalPosition)

set the vertical scrolling position of this scrollContainer.

Parameters:

verticalPosition - the vertical scrolling position of this scrollContainer

getHorizontalScrollPosition

public int getHorizontalScrollPosition()

get the horizontal scrolling position of this scrollContainer.

Returns:

the horizontal scrolling position of this scrollContainer

setHorizontalScrollPosition

public void setHorizontalScrollPosition(int horizontalPosition)

set the horizontal scrolling position of this scrollContainer.

Parameters:

horizontalPosition - the horizontal scrolling position of this scrollContainer

setReturnsScrollPosition

public void setReturnsScrollPosition(boolean returnScrollPosition)

enable the feature to return the scrolling position

Parameters:

returnScrollPosition - flag to specify if the scrollContainer returns it's scrolling position

returnsScrollPosition

public boolean returnsScrollPosition()

get the horizontal scrolling position of this scrollContainer.

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.

getAccessibilityDescription

public String getAccessibilityDescription()

get the semantical description of the component in it's applicationcontext used by screenreaders

Returns:

description text

setAccessibilityDescription

public void setAccessibilityDescription(String accessibilityDescription)

sets the sematical description for the component in it's applicationcontext used by screenreaders

Parameters:

accessibilityDescription - description text

Returns:

getTooltip

public String getTooltip()

setTooltip

public void setTooltip(String tooltip)

initFromPageContext

protected void initFromPageContext(IPageContext pc,
                                   String baseId)

Description copied from class: Component

internal use only. Components should override this method to analyse the parameters from the request object (via IPageContext) and set their internal data structures accordingly.

Overrides:

initFromPageContext in class Component

Parameters:

pc - the context, including the parameters

baseId - the prefix used for the component. (The result of a former RenderUtil.getIdForForm(rc, c);)

isLayout

public boolean isLayout()

Returns:

Returns the layout. Layout is true, then the ScrollContainer behaves like a layout. If IsLayout is false, then the ScrollContainer displays a group behavior.

setIsLayout

public void setIsLayout(boolean layout)

Parameters:

layout - The layout to set. Layout is true, then the ScrollContainer behaves like a layout. If IsLayout is false, then the ScrollContainer displays a group behavior.