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.media;
20  
21  import javax.faces.component.UIComponentBase;
22  
23  /**
24   * 
25   * @JSFComponent
26   *   name = "s:media"
27   *   class = "org.apache.myfaces.custom.media.MediaComponent"
28   *   tagClass = "org.apache.myfaces.custom.media.MediaTag"
29   */
30  public abstract class AbstractMediaComponent extends UIComponentBase {
31  
32      public static String COMPONENT_TYPE = "org.apache.myfaces.media";
33      public static String DEFAULT_RENDERER_TYPE = "org.apache.myfaces.media";
34      public static String COMPONENT_FAMILY = "org.apache.myfaces.media";
35      
36      // Value binding constants
37      public static final String ATTRIBUTE_WIDTH = "width";
38      public static final String ATTRIBUTE_HEIGHT = "height";
39      public static final String ATTRIBUTE_SOURCE = "source";
40      public static final String ATTRIBUTE_CONTENT_TYPE = "contentType";    
41      
42      /**
43       * Integer to indicate the media weight.
44       * 
45       * @JSFProperty
46       */
47      public abstract String getWidth();
48  
49      /**
50       * Integer to indicate the media height.
51       * 
52       * @JSFProperty
53       */
54      public abstract String getHeight();
55      
56      /**
57       * Determines the media content type.
58       * 
59       * @JSFProperty
60       */
61      public abstract String getContentType();
62      
63      /**
64       * Determines the path of the media file.
65       * 
66       * @JSFProperty
67       */
68      public abstract String getSource();
69      
70  }