org.zkoss.zul.api
Interface Iframe

All Superinterfaces:
java.lang.Cloneable, Component, HtmlBasedComponent, Scope, java.io.Serializable
All Known Subinterfaces:
Jasperreport
All Known Implementing Classes:
Iframe, Jasperreport

public interface Iframe
extends HtmlBasedComponent

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).

Since:
3.5.2
Author:
tomyeh
See Also:
Include

Field Summary
 
Fields inherited from interface org.zkoss.zk.ui.Component
APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE
 
Method Summary
 java.lang.String getAlign()
          Returns the alignment.
 Media getContent()
          Returns the content set by setContent(org.zkoss.util.media.Media).
 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.
 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 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
 

Method Detail

setScrolling

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

Parameters:
scrolling - "true", "false", "yes" or "no" or "auto", "auto" by default If null, "auto" is assumed.

getScrolling

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

Defalut: "auto"


getAlign

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

Default: null (use browser default).


setAlign

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


getName

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

Default: null (use browser default).


setName

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


isAutohide

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 embeds, it will be placed on top of other components. It may then make popups and dropdowns obscure. In this case, you have to specify autohide="true" to ask ZK to hide the iframe when popups or dropdowns is overlapped with the iframe.


setAutohide

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


getSrc

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

Default: null.


setSrc

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.

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

setContent

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.

Parameters:
media - the media for this inline frame.
See Also:
setSrc(java.lang.String)

getContent

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).



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