com.sapportals.wcm.rendering.screenflow.os

Class ConfirmComponent

java.lang.Object
  extended byBaseCompositeComponent
      extended bycom.sapportals.wcm.rendering.screenflow.os.OneStepComponent
          extended bycom.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".
See Also:
Serialized Form

Field Summary
static int OK_CANCEL
           
static String RES_BTN_CANCEL
           
static String RES_BTN_NO
           
static String RES_BTN_OK
           
static 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, Locale locale, Component comp)
           
ConfirmComponent(int mode, Locale locale, Component title, Component body, GroupDesign design)
           
 
Method Summary
protected  Component buildContent()
           
protected  void initFromPageContextImpl(IPageContext pc, String baseId)
           
static IRenderingEvent onCancel(Event event, Locale locale)
           
 Event onClick(Event event)
           
static IRenderingEvent onNo(Event event, Locale locale)
           
 void setActiontarget(String string)
           
 void setRendererID(String string)
           
 
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
See Also:
Constant Field Values

YES_NO

public static final int YES_NO
See Also:
Constant Field Values

OK_CANCEL

public static final int OK_CANCEL
See Also:
Constant Field Values

RES_BTN_CANCEL

public static final String RES_BTN_CANCEL
See Also:
Constant Field Values

RES_BTN_NO

public static final String RES_BTN_NO
See Also:
Constant Field Values

RES_BTN_YES

public static final String RES_BTN_YES
See Also:
Constant Field Values

RES_BTN_OK

public static final String RES_BTN_OK
See Also:
Constant Field Values
Constructor Detail

ConfirmComponent

public ConfirmComponent()
default constructor needed for the htmlb-framework. Must not be used otherwise


ConfirmComponent

public ConfirmComponent(int mode,
                        Locale locale,
                        Component title,
                        Component body,
                        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,
                        Locale locale,
                        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 Component buildContent()

onClick

public Event onClick(Event event)
Parameters:
event - received from the htmlb-framework
Returns:
a new instance of the ConfirmEvent

initFromPageContextImpl

protected void initFromPageContextImpl(IPageContext pc,
                                       String baseId)

setActiontarget

public void setActiontarget(String string)
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)
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(Event event,
                                   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(Event event,
                                       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


Copyright 2006 SAP AG. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Microsoft, Windows, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. Oracle is a registered trademark of Oracle Corporation. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc. HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C, World Wide Web Consortium, Massachusetts Institute of Technology. Java is a registered trademark of Sun Microsystems, Inc. JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape. MaxDB is a trademark of MySQL AB, Sweden. SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary. These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.