001    /*
002     * Copyright 2002-2004 the original author or authors.
003     * 
004     * Licensed under the Apache License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     * 
008     *      http://www.apache.org/licenses/LICENSE-2.0
009     * 
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    package org.springframework.richclient.command.config;
017    
018    import javax.swing.AbstractButton;
019    
020    import org.springframework.richclient.command.AbstractCommand;
021    
022    /**
023     * A configurer for Swing buttons that have an associated command.
024     * 
025     * @author Keith Donald
026     */
027    public interface CommandButtonConfigurer {
028        
029        /**
030         * Configures the given button and optional command object with the properties of the given 
031         * descriptor. 
032         *
033         * @param button The button to be configured. Must not be null.
034         * @param command The command to be configured. May be null.
035         * @param faceDescriptor The object describing the visual properties of the command button.
036         * Must not be null.
037         * 
038         * @throws IllegalArgumentException if {@code button} or {@code faceDescriptor} are null.
039         */
040        public void configure(AbstractButton button, AbstractCommand command, CommandFaceDescriptor faceDescriptor);
041        
042    }