001    /*
002     * Created on Apr 10, 2007
003     * 
004     * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
005     * in compliance with the License. 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 distributed under the License
010     * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
011     * or implied. See the License for the specific language governing permissions and limitations under
012     * the License.
013     * 
014     * Copyright @2007-2010 the original author or authors.
015     */
016    package org.fest.swing.fixture;
017    
018    import java.awt.Component;
019    
020    /**
021     * Understands simulation of user events on GUI components that accept text input from the user.
022     * 
023     * @author Alex Ruiz
024     */
025    public interface TextInputFixture extends TextDisplayFixture, EditableComponentFixture {
026    
027      /**
028       * Simulates a user entering the given text in the <code>{@link Component}</code> managed by this fixture.
029       * @param text the text to enter.
030       * @return this fixture.
031       */
032      TextInputFixture enterText(String text);
033    
034      /**
035       * Simulates a user deleting all the text in the <code>{@link Component}</code> managed by this fixture.
036       * @return this fixture.
037       */
038      TextInputFixture deleteText();
039      
040      /**
041       * Simulates a user selecting all the text contained in the <code>{@link Component}</code> managed by this fixture. 
042       * @return this fixture.
043       */
044      TextInputFixture selectAll();
045    
046      /**
047       * Simulates a user selecting a portion of the text contained in the <code>{@link Component}</code> managed by this
048       * fixture.
049       * @param start index where selection should start.
050       * @param end index where selection should end.
051       * @return this fixture.
052       */
053      TextInputFixture selectText(int start, int end);
054      
055      /**
056       * Simulates a user selecting the given text contained in the <code>{@link Component}</code> managed by this fixture.
057       * @param text the text to select.
058       * @return this fixture.
059       */
060      TextInputFixture select(String text);
061    }