com.sap.ip.collaboration.gw.api.ui

Interface IDateTimeComponent

public interface IDateTimeComponent

This is an interface for the htmlb composite control DateTimeControl. This interface facilitates the reuse of DataTimeControl class which is present in project coll.appl.ui.gw without the build and RT dependencies. Window>Preferences>Java>Code Generation>Code and Comments

Method Summary

Component	getComponent() Returns the Htmlb composite component for DateTimeComponent
InputField	getLabeledComponent()
Date	getTime() Returns the date and time of the component
String	getTimeLabel() Getter for the Time Field Label
void	setDateScript(String dateJs)
void	setEnabled(boolean bEnable) Enable or disable the DateTimeControl.
void	setIDScript(String componentId) This method is called to set the html form id of the actual DateTimeControl created.
void	setOnClientChange(String dateJs, String timeJs) Client side js methods to be executed on change of Date or Time field in DateTimeControl These methods has to be present in the Javascript includes of the component using the DateTimeControl.
void	setTime(Date date) Set the Date value to be displayed in the DateTimeControl
void	setTimeLabel(String timeLabelString) Use this to override the default value (language adjusted value "Time " ) of the Time Field Label text Note that the Label will not be visible until you set the value of bShowTimeLabel in showTimeLabel(boolean).
void	showDateAndTimeField(boolean bShowBothFields) Sets the flag for showing the date and time field.
void	showDateHelper(boolean bDateHelper) Show or hide the date picker
void	showTimeHelper(boolean bTimeHelper) Show or hide the time helper
void	showTimeLabel(boolean bShowTimeLabel) This allows one to Toggle ON/OFF the label associated with the Time Field.

Method Detail

setOnClientChange

public void setOnClientChange(String dateJs,
                              String timeJs)

Client side js methods to be executed on change of Date or Time field in DateTimeControl These methods has to be present in the Javascript includes of the component using the DateTimeControl.

Parameters:

dateJs -

timeJs -

setIDScript

public void setIDScript(String componentId)

This method is called to set the html form id of the actual DateTimeControl created.

Parameters:

componentId -

setDateScript

public void setDateScript(String dateJs)

Parameters:

dateJs -

setTime

public void setTime(Date date)

Set the Date value to be displayed in the DateTimeControl

getTime

public Date getTime()

Returns the date and time of the component

getComponent

public Component getComponent()

Returns the Htmlb composite component for DateTimeComponent

showDateAndTimeField

public void showDateAndTimeField(boolean bShowBothFields)

Sets the flag for showing the date and time field.

Parameters:

bShowBothFields -

showDateHelper

public void showDateHelper(boolean bDateHelper)

Show or hide the date picker

showTimeHelper

public void showTimeHelper(boolean bTimeHelper)

Show or hide the time helper

setEnabled

public void setEnabled(boolean bEnable)

Enable or disable the DateTimeControl.

getLabeledComponent

public InputField getLabeledComponent()

showTimeLabel

public void showTimeLabel(boolean bShowTimeLabel)

This allows one to Toggle ON/OFF the label associated with the Time Field.

NOTE: If this is set to true then the default value (language adjusted value "Time " ) of the Label Text is set. To override this please set the value of timeLabelString in setTimeLabel(String)

Parameters:

bShowTimeLabel - state of Time Label

setTimeLabel

public void setTimeLabel(String timeLabelString)

Use this to override the default value (language adjusted value "Time " ) of the Time Field Label text

Note that the Label will not be visible until you set the value of bShowTimeLabel in showTimeLabel(boolean).

NOTE: The timeLabelString should be language-adjusted already for internationalization issues.

Parameters:

timeLabelString - text of the Time Field Label

getTimeLabel

public String getTimeLabel()

Getter for the Time Field Label

Returns:

The text value of the Label