001    package org.gwtbootstrap3.client.ui.base;
002    
003    /*
004     * #%L
005     * GwtBootstrap3
006     * %%
007     * Copyright (C) 2013 GwtBootstrap3
008     * %%
009     * Licensed under the Apache License, Version 2.0 (the "License");
010     * you may not use this file except in compliance with the License.
011     * You may obtain a copy of the License at
012     * 
013     *      http://www.apache.org/licenses/LICENSE-2.0
014     * 
015     * Unless required by applicable law or agreed to in writing, software
016     * distributed under the License is distributed on an "AS IS" BASIS,
017     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
018     * See the License for the specific language governing permissions and
019     * limitations under the License.
020     * #L%
021     */
022    
023    import org.gwtbootstrap3.client.ui.constants.ContextualBackground;
024    
025    /**
026     * An object that implements this interface has contextual background, which can be set and
027     * retrieved using these methods.
028     *
029     * @author David Buhler
030     */
031    public interface HasContextualBackground {
032        /**
033         * Sets the object's contextual background.
034         *
035         * @param contextualBackground the object's new contextual background
036         */
037        void setContextualBackground(ContextualBackground contextualBackground);
038    
039        /**
040         * Get the object's contextual background.
041         *
042         * @return the object's contextual background
043         */
044        ContextualBackground getContextualBackground();
045    }