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  
20  package org.apache.myfaces.tobago.internal.taglib.component;
21  
22  import org.apache.myfaces.tobago.apt.annotation.Tag;
23  import org.apache.myfaces.tobago.apt.annotation.TagAttribute;
24  import org.apache.myfaces.tobago.apt.annotation.UIComponentTag;
25  import org.apache.myfaces.tobago.apt.annotation.UIComponentTagAttribute;
26  import org.apache.myfaces.tobago.component.RendererTypes;
27  import org.apache.myfaces.tobago.internal.taglib.declaration.HasCurrentMarkup;
28  import org.apache.myfaces.tobago.internal.taglib.declaration.HasIdBindingAndRendered;
29  import org.apache.myfaces.tobago.internal.taglib.declaration.HasMarkup;
30  import org.apache.myfaces.tobago.internal.taglib.declaration.IsGridLayoutComponent;
31  
32  import javax.faces.component.UIOutput;
33  
34  /**
35   * Show external content inside of an application.
36   * This will typically renders an iframe tag.
37   */
38  @Tag(name = "object")
39  @UIComponentTag(
40      uiComponent = "org.apache.myfaces.tobago.component.UIObject",
41      uiComponentBaseClass = "org.apache.myfaces.tobago.internal.component.AbstractUIOut",
42      uiComponentFacesClass = "javax.faces.component.UIOutput",
43      componentFamily = UIOutput.COMPONENT_FAMILY,
44      rendererType = RendererTypes.OBJECT,
45      allowedChildComponenents = "NONE")
46  public interface ObjectTagDeclaration extends HasIdBindingAndRendered, IsGridLayoutComponent, HasMarkup,
47      HasCurrentMarkup {
48  
49    /**
50     * URI to object source
51     */
52    @TagAttribute
53    @UIComponentTagAttribute
54    void setSrc(String src);
55  
56    /**
57     * Name of the element.
58     * If not set the id will be used as name. The id in JSF normally contains colons.
59     * This doesn't work in Internet Explorer 9 and lower when using window.open(src, target).
60     */
61    @TagAttribute
62    @UIComponentTagAttribute
63    void setName(String name);
64  }