View Javadoc

1   /*
2    * Copyright 2002-2004 the original author or authors.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.springframework.richclient.command.config;
17  
18  import javax.swing.AbstractButton;
19  
20  import org.springframework.richclient.command.AbstractCommand;
21  
22  /**
23   * A configurer for Swing buttons that have an associated command.
24   * 
25   * @author Keith Donald
26   */
27  public interface CommandButtonConfigurer {
28      
29      /**
30       * Configures the given button and optional command object with the properties of the given 
31       * descriptor. 
32       *
33       * @param button The button to be configured. Must not be null.
34       * @param command The command to be configured. May be null.
35       * @param faceDescriptor The object describing the visual properties of the command button.
36       * Must not be null.
37       * 
38       * @throws IllegalArgumentException if {@code button} or {@code faceDescriptor} are null.
39       */
40      public void configure(AbstractButton button, AbstractCommand command, CommandFaceDescriptor faceDescriptor);
41      
42  }