001    /*
002     * Created on Jul 8, 2008
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 @2008-2010 the original author or authors.
015     */
016    package org.fest.swing.fixture;
017    
018    import org.fest.swing.exception.WaitTimedOutError;
019    import org.fest.swing.timing.Timeout;
020    
021    /**
022     * Understands state verification of a GUI component.
023     *
024     * @author Alex Ruiz
025     */
026    public interface StateVerificationFixture {
027    
028      /**
029       * Asserts that this fixture's GUI component is disabled.
030       * @return this fixture.
031       * @throws AssertionError if this fixture's GUI component is enabled.
032       */
033      StateVerificationFixture requireDisabled();
034    
035      /**
036       * Asserts that this fixture's GUI component is enabled.
037       * @return this fixture.
038       * @throws AssertionError if this fixture's GUI component is disabled.
039       */
040      StateVerificationFixture requireEnabled();
041    
042      /**
043       * Asserts that this fixture's GUI component is enabled.
044       * @param timeout the time this fixture will wait for the component to be enabled.
045       * @return this fixture.
046       * @throws WaitTimedOutError if this fixture's GUI component is never enabled.
047       */
048      StateVerificationFixture requireEnabled(Timeout timeout);
049    
050      /**
051       * Asserts that this fixture's GUI component is not visible.
052       * @return this fixture.
053       * @throws AssertionError if this fixture's GUI component is visible.
054       */
055      StateVerificationFixture requireNotVisible();
056    
057      /**
058       * Asserts that this fixture's GUI component is visible.
059       * @return this fixture.
060       * @throws AssertionError if this fixture's GUI component is not visible.
061       */
062      StateVerificationFixture requireVisible();
063    }