View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.myfaces.custom.graphicimagedynamic;
20  
21  import org.apache.myfaces.custom.dynamicResources.ResourceRenderer;
22  
23  /**
24   * The ImageRenderer is used to render the binary data for a html img tag
25   * Implementions must have a default constructor
26   * 
27   * @author Mathias Broekelmann
28   * @version $Revision: 673833 $ $Date: 2008-07-03 16:58:05 -0500 (Thu, 03 Jul 2008) $
29   */
30  public interface ImageRenderer extends ResourceRenderer
31  {
32      /**
33       * This method will be called first, to set the contexts.
34       * 
35       * @param facesContext the faces context
36       * @param imageContext the image context width aditional image parameters
37       *
38      void setContext(FacesContext facesContext, ImageContext imageContext) throws Exception;
39      */
40      /**
41       * Called to render the image to the given outputstream.
42       * 
43       * @param out the outputstream which is used to write the binary data of the image
44       *  
45       * @throws IOException
46       *
47      void renderImage(ResponseStream out) throws IOException;
48      */
49  }