com.sapportals.wcm.rendering.screenflow.os
Class ConfirmComponent

[contained in: com.sap.km.cm.ui.flex.par - km.shared.ui.flex.screenflow_api.jar]

com.sapportals.wcm.rendering.screenflow.os.OneStepComponent
  |
  +--com.sapportals.wcm.rendering.screenflow.os.ConfirmComponent

public final class ConfirmComponent

extends OneStepComponent

Since:

NW04, SPS4 this is a ready-to-use component that renders a set of buttons underneath a Component that is provided as a parameter. The component also offers static methods to retrieve an IRenderingEvent that holds a message stating that the user canceled the operation or clicked "No".

Field Summary

static int	OK_CANCEL
static java.lang.String	RES_BTN_CANCEL
static java.lang.String	RES_BTN_NO
static java.lang.String	RES_BTN_OK
static java.lang.String	RES_BTN_YES
static int	YES_NO
static int	YES_NO_CANCEL

Constructor Summary

ConfirmComponent()
default constructor needed for the htmlb-framework.

ConfirmComponent(int mode, java.util.Locale locale, com.sapportals.htmlb.Component comp)

ConfirmComponent(int mode, java.util.Locale locale, com.sapportals.htmlb.Component title, com.sapportals.htmlb.Component body, com.sapportals.htmlb.enum.GroupDesign design)

Method Summary

protected com.sapportals.htmlb.Component	buildContent()
protected void	initFromPageContextImpl(com.sapportals.htmlb.rendering.IPageContext pc, java.lang.String baseId)
static IRenderingEvent	onCancel(com.sapportals.htmlb.event.Event event, java.util.Locale locale)
com.sapportals.htmlb.event.Event	onClick(com.sapportals.htmlb.event.Event event)
static IRenderingEvent	onNo(com.sapportals.htmlb.event.Event event, java.util.Locale locale)
void	setActiontarget(java.lang.String string)
void	setRendererID(java.lang.String string)

Field Detail

YES_NO_CANCEL

public static final int YES_NO_CANCEL

YES_NO

public static final int YES_NO

OK_CANCEL

public static final int OK_CANCEL

RES_BTN_CANCEL

public static final java.lang.String RES_BTN_CANCEL

RES_BTN_NO

public static final java.lang.String RES_BTN_NO

RES_BTN_YES

public static final java.lang.String RES_BTN_YES

RES_BTN_OK

public static final java.lang.String RES_BTN_OK

Constructor Detail

ConfirmComponent

public ConfirmComponent()

default constructor needed for the htmlb-framework. Must not be used otherwise

ConfirmComponent

public ConfirmComponent(int mode,
                        java.util.Locale locale,
                        com.sapportals.htmlb.Component title,
                        com.sapportals.htmlb.Component body,
                        com.sapportals.htmlb.enum.GroupDesign design)

Parameters:

mode - - the mode stating what set of buttons should be used. Use the int-constants provided in this class.

locale - - the locale of the user. Must not be null

title - the title component for the screen. If it is null, the complete dialog will be rendered without a GroupBox around it

body - the component describing what the user has to confirm. Must not be null

design - the design for the groupbox, if it is rendered. Might be null

ConfirmComponent

public ConfirmComponent(int mode,
                        java.util.Locale locale,
                        com.sapportals.htmlb.Component comp)

Parameters:

mode - - the mode stating what set of buttons should be used. Use the int-constants provided in this class.

locale - - the locale of the user. Must not be null

comp - the component describing what the user has to confirm. Must not be null

Method Detail

buildContent

protected com.sapportals.htmlb.Component buildContent()

onClick

public com.sapportals.htmlb.event.Event onClick(com.sapportals.htmlb.event.Event event)

Parameters:

event - received from the htmlb-framework

Returns:

a new instance of the ConfirmEvent

initFromPageContextImpl

protected void initFromPageContextImpl(com.sapportals.htmlb.rendering.IPageContext pc,
                                       java.lang.String baseId)

setActiontarget

public void setActiontarget(java.lang.String string)

Overrides:

setActiontarget in class OneStepComponent

Following copied from class: com.sapportals.wcm.rendering.screenflow.os.OneStepComponent

Parameters:

actiontarget - the action to be taken when a link has been clicked. Method is called by the control that renders this component. It is the components job to persist this information so it can be retrieved after the user has clicked a link in this class.

setRendererID

public void setRendererID(java.lang.String string)

Overrides:

setRendererID in class OneStepComponent

Following copied from class: com.sapportals.wcm.rendering.screenflow.os.OneStepComponent

Parameters:

renderer - the receiver of the fired event. Method is called by the control that renders this component. It is the components job to persist this information so it can be retrieved after the user has clicked a link in this class.

onNo

public static IRenderingEvent onNo(com.sapportals.htmlb.event.Event event,
                                   java.util.Locale locale)

Parameters:

event - currently not evaluated

locale - the locale of the user, must not be null

Returns:

a new instance of the InfoEvent. It holds the translated text to be displayed when a user clicked the cancel-button

onCancel

public static IRenderingEvent onCancel(com.sapportals.htmlb.event.Event event,
                                       java.util.Locale locale)

Parameters:

event - currently not evaluated

locale - the locale of the user, must not be null

Returns:

a new instance of the InfoEvent. It holds the translated text to be displayed when a user clicked the cancel-button