com.sapportals.wcm.rendering.screenflow.os

Class ConfirmComponent

java.lang.Object

com.sapportals.htmlb.Component

com.sapportals.htmlb.AbstractCompositeComponent

com.sapportals.wcm.control.util.components.base.BaseCompositeComponent

com.sapportals.wcm.rendering.screenflow.os.OneStepComponent

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

Deprecated.

As of NetWeaver 7.1

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

Fields

Modifier and Type	Field and Description
static int	OK_CANCEL Deprecated.
static int	OK_CANCEL_CBX Deprecated.
static String	RES_BTN_CANCEL Deprecated.
static String	RES_BTN_NO Deprecated.
static String	RES_BTN_OK Deprecated.
static String	RES_BTN_YES Deprecated.
static int	YES_NO Deprecated.
static int	YES_NO_CANCEL Deprecated.
static int	YES_NO_CANCEL_CBX Deprecated.
static int	YES_NO_CBX Deprecated.

Fields inherited from class com.sapportals.wcm.control.util.components.base.BaseCompositeComponent

request

Fields inherited from class com.sapportals.htmlb.AbstractCompositeComponent

container

Constructor Summary

Constructors

Constructor and Description
ConfirmComponent() Deprecated. As of NetWeaver 7.1
ConfirmComponent(int mode, Locale locale, com.sapportals.htmlb.Component comp) Deprecated. As of NetWeaver 7.1
ConfirmComponent(int mode, Locale locale, com.sapportals.htmlb.Component title, com.sapportals.htmlb.Component body, com.sapportals.htmlb.enums.GroupDesign design) Deprecated. As of NetWeaver 7.1
ConfirmComponent(int mode, Locale locale, com.sapportals.htmlb.Component title, com.sapportals.htmlb.Component body, com.sapportals.htmlb.enums.GroupDesign design, String checkText, boolean checkStatus) Deprecated. As of NetWeaver 7.1

Method Summary

Modifier and Type	Method and Description
protected com.sapportals.htmlb.Component	buildContent() Deprecated. As of NetWeaver 7.1
protected void	initFromPageContextImpl(com.sapportals.htmlb.rendering.IPageContext pc, String baseId) Deprecated. As of NetWeaver 7.1
static IRenderingEvent	onCancel(com.sapportals.htmlb.event.Event event, Locale locale) Deprecated. As of NetWeaver 7.1
com.sapportals.htmlb.event.Event	onClick(com.sapportals.htmlb.event.Event event) Deprecated. As of NetWeaver 7.1
static IRenderingEvent	onNo(com.sapportals.htmlb.event.Event event, Locale locale) Deprecated. As of NetWeaver 7.1
void	setActiontarget(String string) Deprecated. As of NetWeaver 7.1
void	setRendererID(String string) Deprecated. As of NetWeaver 7.1

Methods inherited from class com.sapportals.wcm.control.util.components.base.BaseCompositeComponent

buildComposition, buildIntoForm, createContextFactory, createModel, createState, getBaseBundleName, getBundles, getBundleString, getBundleString, getBundleString, getComponentForId, getCompositeModel, getDataForComponentId, getDataForComponentId, getDefaultButton, getHTTPServletRequest, getImage, getImagePath, getLocale, getModelPersistenceID, getOnClick, getOnPopupReturn, getPaddingBottom, getPaddingTop, getPageContext, getPopup_height, getPopup_width, getPopupCloseParameter, getPopupUrl, getRequest, getRequestParameter, getRequestParameters, getResourceContext, getState, getUI, initFromPageContext, is508, isCloseScript, isEnabled, isPersistent, onPopupClose, render, renderIntoForm, setCloseScript, setCompositeModel, setDefaultButton, setEnabled, setOnClick, setOnPopupReturn, setPaddingBottom, setPaddingTop, setPersistent, setPopup_height, setPopup_width, setPopupOpenButton, setRequest, setRequestPageContext, setState

Methods inherited from class com.sapportals.htmlb.AbstractCompositeComponent

createCompositeComponentId, preRender, unEscape

Methods inherited from class com.sapportals.htmlb.Component

getEncodedIdForForm, getId, getParent, initFromShortId, initializeFromId, isJsObjectNeeded, 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

YES_NO_CANCEL

public static final int YES_NO_CANCEL

Deprecated.

See Also:

Constant Field Values

YES_NO

public static final int YES_NO

Deprecated.

See Also:

Constant Field Values

OK_CANCEL

public static final int OK_CANCEL

Deprecated.

See Also:

Constant Field Values

YES_NO_CANCEL_CBX

public static final int YES_NO_CANCEL_CBX

Deprecated.

See Also:

Constant Field Values

YES_NO_CBX

public static final int YES_NO_CBX

Deprecated.

See Also:

Constant Field Values

OK_CANCEL_CBX

public static final int OK_CANCEL_CBX

Deprecated.

See Also:

Constant Field Values

RES_BTN_CANCEL

public static final String RES_BTN_CANCEL

Deprecated.

See Also:

Constant Field Values

RES_BTN_NO

public static final String RES_BTN_NO

Deprecated.

See Also:

Constant Field Values

RES_BTN_YES

public static final String RES_BTN_YES

Deprecated.

See Also:

Constant Field Values

RES_BTN_OK

public static final String RES_BTN_OK

Deprecated.

See Also:

Constant Field Values

Constructor Detail

ConfirmComponent

public ConfirmComponent()

Deprecated. As of NetWeaver 7.1

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

ConfirmComponent

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

Deprecated. As of NetWeaver 7.1

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,
                        Locale locale,
                        com.sapportals.htmlb.Component title,
                        com.sapportals.htmlb.Component body,
                        com.sapportals.htmlb.enums.GroupDesign design,
                        String checkText,
                        boolean checkStatus)

Deprecated. As of NetWeaver 7.1

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

checkText - explaining text beside check box, in case CBX (additional check box) is enabled

checkStatus - initial value of check box

ConfirmComponent

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

Deprecated. As of NetWeaver 7.1

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()

Deprecated. As of NetWeaver 7.1

Description copied from class: BaseCompositeComponent

Overwrite this method to return the content of the composite component. When this method is called, the model is valid and can be used to get the data. method buildContent

Specified by:

buildContent in class BaseCompositeComponent

Returns:

the Component which renders the content of this composite

onClick

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

Deprecated. As of NetWeaver 7.1

Parameters:

event - received from the htmlb-framework

Returns:

a new instance of the ConfirmEvent

initFromPageContextImpl

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

Deprecated. As of NetWeaver 7.1

Description copied from class: BaseCompositeComponent

this method is called from the initFromPageContext method. Overwrite this method in order to do some own initializations. When this method is called, the model is fully recontructed and the resource context is set.

Specified by:

initFromPageContextImpl in class BaseCompositeComponent

setActiontarget

public void setActiontarget(String string)

Deprecated. As of NetWeaver 7.1

Specified by:

setActiontarget in class OneStepComponent

Parameters:

string - 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(String string)

Deprecated. As of NetWeaver 7.1

Specified by:

setRendererID in class OneStepComponent

Parameters:

string - 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,
                                   Locale locale)

Deprecated. As of NetWeaver 7.1

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,
                                       Locale locale)

Deprecated. As of NetWeaver 7.1

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