001// Copyright 2008, 2010 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.corelib.internal;
016
017import org.apache.tapestry5.services.javascript.JavaScriptSupport;
018
019/**
020 * Interface that allows an enclosing {@link org.apache.tapestry5.corelib.components.AjaxFormLoop} to work with enclosed
021 * components such as {@link org.apache.tapestry5.corelib.components.AddRowLink} or
022 * {@link org.apache.tapestry5.corelib.components.RemoveRowLink}.
023 */
024public interface AjaxFormLoopContext
025{
026    /**
027     * Adds a clientId to the list of client-side elements that trigger the addition of a new row.
028     * 
029     * @param clientId
030     *            unique id (typically via
031     *            {@link JavaScriptSupport#allocateClientId(org.apache.tapestry5.ComponentResources)})
032     */
033    void addAddRowTrigger(String clientId);
034
035    /**
036     * Used by {@link org.apache.tapestry5.corelib.components.RemoveRowLink} to
037     * 
038     * @param clientId
039     */
040    void addRemoveRowTrigger(String clientId);
041}