javax.faces.component.search.UntargetableComponent Maven / Gradle / Ivy

/*
 * Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package javax.faces.component.search;

/**
 * Components implementing this interface are ignored by the algorithm - 
 * especially in the implementation of @child(n), @next and @previous.
 * 
 * If you suppose this case, markup/literal components must implement {@link UntargetableComponent}:
 *  * <table>
 *      <tr>
 *          <td>
 *              <h:outputLabel for="@next" value="Name:" />
 *          </td>
 *          <td>
 *              <h:inputText id="input" value="#{bean.name} />
 *          </td>
 *      </tr>
 * </table>
 * 
 * 
 * @next would otherwise actually target the markup:
 * 
 *  *  </td>
 *  <td>
 * 
 * 
 * and not desired component: 
 *  *  <h:inputText id="input" value="#{bean.name} />
 * 
 * 
 *
 * @since 2.3
 */
public interface UntargetableComponent {

}