org.zkoss.zul
Class Iframe

java.lang.Object
  extended by org.zkoss.zk.ui.AbstractComponent
      extended by org.zkoss.zk.ui.HtmlBasedComponent
          extended by org.zkoss.zul.Iframe
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, HtmlBasedComponent, Component, Scope, ComponentCtrl, Iframe
Direct Known Subclasses:
Jasperreport

public class Iframe
extends HtmlBasedComponent
implements Iframe

Includes an inline frame.

Unlike HTML iframe, this component doesn't have the frameborder property. Rather, use the CSS style to customize the border (like any other components).

Author:
tomyeh
See Also:
Include, Serialized Form

Nested Class Summary
protected  class Iframe.ExtraCtrl
          A utility class to implement AbstractComponent.getExtraCtrl().
 
Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent
AbstractComponent.Children
 
Field Summary
 
Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent
_height, _left, _top, _width, _zclass
 
Fields inherited from class org.zkoss.zk.ui.AbstractComponent
_visible
 
Fields inherited from interface org.zkoss.zk.ui.Component
APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE
 
Fields inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl
CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE
 
Constructor Summary
Iframe()
           
Iframe(java.lang.String src)
           
 
Method Summary
 java.lang.String getAlign()
          Returns the alignment.
 Media getContent()
          Returns the content set by setContent(org.zkoss.util.media.Media).
protected  java.lang.String getEncodedSrc()
          Returns the encoded src (getSrc()).
 java.lang.String getName()
          Returns the frame name.
 java.lang.String getScrolling()
          Return the scroll bars.
 java.lang.String getSrc()
          Returns the src.
 boolean isAutohide()
          Returns whether to automatically hide this component if a popup or dropdown is overlapped with it.
protected  boolean isChildable()
          Default: not childable.
protected  java.lang.Object newExtraCtrl()
          Used by AbstractComponent.getExtraCtrl() to create a client control.
protected  void renderProperties(ContentRenderer renderer)
          Renders the content of this component, excluding the enclosing tags and children.
 void service(AuRequest request, boolean everError)
          Processes an AU request.
 void setAlign(java.lang.String align)
          Sets the alignment: one of top, middle, bottom, left, right and center.
 void setAutohide(boolean autohide)
          Sets whether to automatically hide this component if a popup or dropdown is overlapped with it.
 void setContent(Media media)
          Sets the content directly.
 void setName(java.lang.String name)
          Sets the frame name.
 void setScrolling(java.lang.String scrolling)
          Define scroll bars
 void setSrc(java.lang.String src)
          Sets the src.
 
Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent
focus, getDraggable, getDroppable, getHeight, getHflex, getLeft, getSclass, getStyle, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZindex, getZIndex, setClass, setDraggable, setDroppable, setFocus, setHeight, setHflex, setLeft, setSclass, setStyle, setTooltiptext, setTop, setVflex, setWidth, setZclass, setZindex, setZIndex
 
Methods inherited from class org.zkoss.zk.ui.AbstractComponent
addAnnotation, addAnnotation, addClientEvent, addEventHandler, addEventListener, addForward, addForward, addForward, addForward, addMoved, addScopeListener, addSharedAnnotationMap, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, beforeParentChanged, clone, containsVariable, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableClientUpdate, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getChildren, getClientEvents, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getExtraCtrl, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, newChildren, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, onWrongValue, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeScopeListener, render, render, render, response, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setVariable, setVisible, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, unsetVariable, updateByClient, willPassivate, willPassivate, willSerialize, willSerialize
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.zkoss.zk.ui.api.HtmlBasedComponent
focus, getHeight, getLeft, getSclass, getStyle, getTooltiptext, getTop, getWidth, getZclass, getZindex, getZIndex, setDraggable, setDroppable, setFocus, setHeight, setLeft, setSclass, setStyle, setTooltiptext, setTop, setWidth, setZclass, setZindex, setZIndex
 
Methods inherited from interface org.zkoss.zk.ui.Component
addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, clone, containsVariable, detach, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getChildren, getDefinition, getDesktop, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setAuService, setId, setMold, setPage, setPageBefore, setParent, setVariable, setVisible, setWidgetListener, setWidgetOverride, unsetVariable
 
Methods inherited from interface org.zkoss.zk.ui.ext.Scope
addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute
 

Constructor Detail

Iframe

public Iframe()

Iframe

public Iframe(java.lang.String src)
Method Detail

setScrolling

public void setScrolling(java.lang.String scrolling)
Define scroll bars

Specified by:
setScrolling in interface Iframe
Parameters:
scrolling - "true", "false", "yes" or "no" or "auto", "auto" by default If null, "auto" is assumed.
Since:
3.0.4

getScrolling

public java.lang.String getScrolling()
Return the scroll bars.

Defalut: "auto"

Specified by:
getScrolling in interface Iframe
Since:
3.0.4

getAlign

public java.lang.String getAlign()
Returns the alignment.

Default: null (use browser default).

Specified by:
getAlign in interface Iframe

setAlign

public void setAlign(java.lang.String align)
Sets the alignment: one of top, middle, bottom, left, right and center.

Specified by:
setAlign in interface Iframe

getName

public java.lang.String getName()
Returns the frame name.

Default: null (use browser default).

Specified by:
getName in interface Iframe

setName

public void setName(java.lang.String name)
Sets the frame name.

Specified by:
setName in interface Iframe

isAutohide

public boolean isAutohide()
Returns whether to automatically hide this component if a popup or dropdown is overlapped with it.

Default: false.

If an iframe contains PDF or other non-HTML resource, it is possible that it obscues the popup that shall be shown above it. To resolve this, you have to specify autohide="true" to this component, and specify the following in the page:

<script content="zk.useStack='auto';"?>
 

Refer to JavaScript Customization for more information.

Specified by:
isAutohide in interface Iframe

setAutohide

public void setAutohide(boolean autohide)
Sets whether to automatically hide this component if a popup or dropdown is overlapped with it.

Specified by:
setAutohide in interface Iframe

getSrc

public java.lang.String getSrc()
Returns the src.

Default: null.

Specified by:
getSrc in interface Iframe

setSrc

public void setSrc(java.lang.String src)
Sets the src.

Calling this method implies setContent(null). In other words, the last invocation of setSrc(java.lang.String) overrides the previous setContent(org.zkoss.util.media.Media), if any.

Specified by:
setSrc in interface Iframe
Parameters:
src - the source URL. If null or empty, nothing is included.
See Also:
setContent(org.zkoss.util.media.Media)

getEncodedSrc

protected java.lang.String getEncodedSrc()
Returns the encoded src (getSrc()).


setContent

public void setContent(Media media)
Sets the content directly. Default: null.

Calling this method implies setSrc(null). In other words, the last invocation of setContent(org.zkoss.util.media.Media) overrides the previous setSrc(java.lang.String), if any.

Specified by:
setContent in interface Iframe
Parameters:
media - the media for this inline frame.
See Also:
setSrc(java.lang.String)

getContent

public Media getContent()
Returns the content set by setContent(org.zkoss.util.media.Media).

Note: it won't fetch what is set thru by setSrc(java.lang.String). It simply returns what is passed to setContent(org.zkoss.util.media.Media).

Specified by:
getContent in interface Iframe

renderProperties

protected void renderProperties(ContentRenderer renderer)
                         throws java.io.IOException
Description copied from class: HtmlBasedComponent
Renders the content of this component, excluding the enclosing tags and children.

See also Render Special Properties

Overrides:
renderProperties in class HtmlBasedComponent
Throws:
java.io.IOException

service

public void service(AuRequest request,
                    boolean everError)
Processes an AU request.

Default: in addition to what are handled by HtmlBasedComponent.service(org.zkoss.zk.au.AuRequest, boolean), it also handles onURIChange.

Specified by:
service in interface ComponentCtrl
Overrides:
service in class HtmlBasedComponent
everError - whether any error ever occured before processing this request.
Since:
5.0.0
See Also:
AbstractComponent.setAuService(org.zkoss.zk.au.AuService)

isChildable

protected boolean isChildable()
Default: not childable.

Overrides:
isChildable in class AbstractComponent

newExtraCtrl

protected java.lang.Object newExtraCtrl()
Description copied from class: HtmlBasedComponent
Used by AbstractComponent.getExtraCtrl() to create a client control. It is used only by component developers.

Defaut: creates an instance of HtmlBasedComponent.ExtraCtrl.

Overrides:
newExtraCtrl in class HtmlBasedComponent


Copyright © 2005-2009 Potix Corporation. All Rights Reserved. SourceForge.net Logo