com.sapportals.htmlb

Class Bookmark

java.lang.Object
  com.sapportals.htmlb.Component
      com.sapportals.htmlb.Bookmark

public class Bookmark

extends Component

A local bookmark
Copyright (c) SAP AG, 2002

Field Summary

static String

UI_ID

Constructor Summary

Bookmark(String name)
create a new bookmark with a given name

Method Summary

String	getBookmark() get the text of this button
String	getUI() get a identification String for the renderer that is unique across all supported components.
void	setBookmark(String name) set the name of this bookmark

Methods inherited from class com.sapportals.htmlb.Component

getEncodedIdForForm, getId, getParent, initFromPageContext, initFromShortId, initializeFromId, isJsObjectNeeded, preRender, render, renderAsString, requiresForm, 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

Constructor Detail

Bookmark

public Bookmark(String name)

create a new bookmark with a given name

Parameters:

name - the name/bookmark

Method Detail

getUI

public String getUI()

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

getBookmark

public String getBookmark()

get the text of this button

Returns:

the text

setBookmark

public void setBookmark(String name)

set the name of this bookmark

Parameters:

name - the name for this bookmark