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
017/**
018 * Interface that allows an enclosing {@link org.apache.tapestry5.corelib.components.AjaxFormLoop} to work with enclosed
019 * components such as {@link org.apache.tapestry5.corelib.components.AddRowLink} or
020 * {@link org.apache.tapestry5.corelib.components.RemoveRowLink}.
021 */
022public interface AjaxFormLoopContext
023{
024    /**
025     * Returns the {@linkplain org.apache.tapestry5.ValueEncoder encoded} version of the data for the current row.
026     *
027     * @return current row's value, encoded and ready to store in an element attribute
028     * @since 5.4
029     */
030    String encodedRowValue();
031}