com.sapportals.htmlb

Class Timer

java.lang.Object
  com.sapportals.htmlb.Component
      com.sapportals.htmlb.EventValidationComponent
          com.sapportals.htmlb.Timer

All Implemented Interfaces:

IEventValidationComponent, com.sapportals.htmlb.IJavascriptComponent

public class Timer

extends EventValidationComponent

Title: Timer Description: Fires a server or client event after a specific timeout

Copyright 2004 SAP AG

Field Summary

static String

UI_ID

Constructor Summary

Timer(String name)
Creates a Timer

Method Summary

String	getClientEvent()
String	getServerEventName()
int	getTimeOut() Returns the timeout if the timer
String	getUI() get a identification String for the renderer that is unique across all supported components.
void	setClientEvent(String clientEvent) set a Javascript fragment that is executed when timer reaches timeout
void	setServerEventName(String serverEventName) set the event name that is fired when timer reaches the timer
void	setTimeOut(int timeOut) Sets the timeout of the timer in milliseconds

Methods inherited from class com.sapportals.htmlb.EventValidationComponent

getAllValidators, getClientEvent, getClientEventMap, getErrorText, getServerEvent, getServerEventMap, getValidator, isDisabled, isEnabled, isRequiresValidation, renderJavascriptInterface, setClientEvent, setDisabled, setEnabled, setErrorText, setRequiresValidation, setServerEvent, setValidator

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

Timer

public Timer(String name)

Creates a Timer

Method Detail

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

getTimeOut

public int getTimeOut()

Returns the timeout if the timer

Returns:

timeout of timer

setTimeOut

public void setTimeOut(int timeOut)

Sets the timeout of the timer in milliseconds

Parameters:

timeOut - timeout in milliseconds

getServerEventName

public String getServerEventName()

setServerEventName

public void setServerEventName(String serverEventName)

set the event name that is fired when timer reaches the timer

Parameters:

serverEventName - the name of the event

getClientEvent

public String getClientEvent()

setClientEvent

public void setClientEvent(String clientEvent)

set a Javascript fragment that is executed when timer reaches timeout