Package org.apache.myfaces.tobago.component

Class UIObject

  • All Implemented Interfaces:
    EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, Visual
    @Generated("component.stg")
public class UIObject
extends AbstractUIObject
implements javax.faces.component.behavior.ClientBehaviorHolder
    Show external content inside of an application. This will typically renders an iframe tag. UIComponent class, generated from template component.stg with class ObjectTagDeclaration.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String COMPONENT_FAMILY  
      static String COMPONENT_TYPE  

      • Fields inherited from class javax.faces.component.UIComponent

        BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY

    • Constructor Summary

      Constructors 
      Constructor Description
      UIObject()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      CustomClass getCustomClass()
      Sets a CSS class in its parent, if the parent supports it.
      String getFamily()  
      Markup getMarkup()  
      String getName()
      Name of the element.
      String getSandbox()
      Value of the iframe sandbox attribute.
      String getSrc()
      URI to object source
      void restoreState​(javax.faces.context.FacesContext context, Object state)  
      void setCustomClass​(CustomClass customClass)  
      void setMarkup​(Markup markup)  
      void setName​(String name)  
      void setSandbox​(String sandbox)  
      void setSrc​(String src)  

      • Methods inherited from class javax.faces.component.UIOutput

        clearInitialState, getConverter, getLocalValue, getValue, markInitialState, saveState, setConverter, setValue

      • Methods inherited from class javax.faces.component.UIComponentBase

        addClientBehavior, addFacesListener, broadcast, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTree

      • Methods inherited from class javax.faces.component.UIComponent

        getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent

      • Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

        addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNames

    • Constructor Detail

      • UIObject

        public UIObject()

    • Method Detail

      • getFamily

        public String getFamily()
        Overrides:
        getFamily in class javax.faces.component.UIOutput

      • setSrc

        public void setSrc​(String src)

      • getName

        public String getName()
        Name of the element. If not set the id will be used as name. The id in JSF normally contains colons. This doesn't work in Internet Explorer 9 and lower when using window.open(src, target).
        Specified by:
        getName in class AbstractUIObject

      • setName

        public void setName​(String name)

      • setSandbox

        public void setSandbox​(String sandbox)

      • getCustomClass

        public CustomClass getCustomClass()
        Sets a CSS class in its parent, if the parent supports it. Which this feature it is possible to put a CSS class name into a component with the <tc:style> tag. Example: 
           <tc:in>
     <tc:style customClass="my-emphasized"/>
   </tc:in>
        One capability is, to used external CSS libs.
        This feature should not be used imprudent. Because it might be unstable against changes in the renderered HTML code.
        Specified by:
        getCustomClass in interface Visual

      • restoreState

        public void restoreState​(javax.faces.context.FacesContext context,
                         Object state)
        Specified by:
        restoreState in interface javax.faces.component.StateHolder
        Overrides:
        restoreState in class javax.faces.component.UIOutput