001// Copyright 2011 The Apache Software Foundation
002//
003// Licensed under the Apache License, Version 2.0 (the "License");
004// you may not use this file except in compliance with the License.
005// You may obtain a copy of the License at
006//
007// http://www.apache.org/licenses/LICENSE-2.0
008//
009// Unless required by applicable law or agreed to in writing, software
010// distributed under the License is distributed on an "AS IS" BASIS,
011// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012// See the License for the specific language governing permissions and
013// limitations under the License.
014
015package org.apache.tapestry5.services.ajax;
016
017import org.apache.tapestry5.services.javascript.JavaScriptSupport;
018
019/**
020 * A callback used with {@link AjaxResponseRenderer#addCallback(JavaScriptCallback)}.
021 *
022 * @since 5.3
023 */
024public interface JavaScriptCallback
025{
026    /**
027     * Perform some work with the support object, which is typically to invoke {@link JavaScriptSupport#addInitializerCall(String, org.apache.tapestry5.json.JSONObject)} to setup some
028     * client-side behavior.
029     *
030     * @param javascriptSupport the JavaScriptSupport environmental object, passed as a convenience.
031     */
032    void run(JavaScriptSupport javascriptSupport);
033}