com.adobe.xfa.formcalc.DisplayHost Maven / Gradle / Ivy
Show all versions of aem-sdk-api Show documentation
/*
* ADOBE CONFIDENTIAL
*
* Copyright 2007 Adobe Systems Incorporated All Rights Reserved.
*
* NOTICE: All information contained herein is, and remains the property of
* Adobe Systems Incorporated and its suppliers, if any. The intellectual and
* technical concepts contained herein are proprietary to Adobe Systems
* Incorporated and its suppliers and may be covered by U.S. and Foreign
* Patents, patents in process, and are protected by trade secret or copyright
* law. Dissemination of this information or reproduction of this material
* is strictly forbidden unless prior written permission is obtained from
* Adobe Systems Incorporated.
*/
package com.adobe.xfa.formcalc;
/**
* Class DisplayHost defines the interface by which the
* {@link CalcParser} (FormCalc scripting engine)
* can display message boxes in
* some display host, in response to a MessageBox calc.
*
* In environments where this is possible and desired,
* applications will need to inform the FormCalc script engine
* that they are capable of supporting the DisplayHost
* interface by invoking the
* {@link CalcParser#setDisplayHost(DisplayHost)}
* method.
*
*
Environments that are not able to display message boxes
* need not define nor install a DisplayHost objects.
* Any MessageBox calc encountered by the FormCalc script engine
* will automatically return -1.
*
* @author Mike P. Tardif
*
* @exclude from published api.
*/
public interface DisplayHost {
/**
* Abstract method to display a modal message box dialog on some display
* host.
*
* @param nValue - the kind of message box command buttons to display
* in the message box. Possible values are:
*
*
* - 0
- OK button only.
* - 1
- OK and Cancel buttons.
* - 2
- Abort, Retry, and Ignore buttons.
* - 3
- Yes, No, and Cancel buttons.
* - 4
- Yes, and No buttons.
* - 5
- Retry, and Cancel buttons.
*
*
* @param sMessage the text to display in the message box.
* @param sTitle the title to display on the message box. If empty,
* some system derived title will be used instead.
* @return one of the following numeric values corresponding
* to the command button selected in the message box, or, -1 if the
* message box could be displayed:
*
*
* - 1
- for ok responses.
* - 2
- for cancel responses.
* - 3
- for abort responses.
* - 4
- for retry responses.
* - 5
- for ignore responses.
* - 6
- for yes responses.
* - 7
- for no responses.
*
*
*/
int messageBox(int nValue, String sMessage, String sTitle);
}