|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.zkoss.zk.ui.AbstractComponent
org.zkoss.zk.ui.HtmlBasedComponent
org.zkoss.zul.Iframe
public class 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).
Include
,
Serialized FormNested 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 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.ext.Scope |
---|
addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute |
Constructor Detail |
---|
public Iframe()
public Iframe(java.lang.String src)
Method Detail |
---|
public void setScrolling(java.lang.String scrolling)
setScrolling
in interface Iframe
scrolling
- "true", "false", "yes" or "no" or "auto", "auto" by default
If null, "auto" is assumed.public java.lang.String getScrolling()
Defalut: "auto"
getScrolling
in interface Iframe
public java.lang.String getAlign()
Default: null (use browser default).
getAlign
in interface Iframe
public void setAlign(java.lang.String align)
setAlign
in interface Iframe
public java.lang.String getName()
Default: null (use browser default).
getName
in interface Iframe
public void setName(java.lang.String name)
setName
in interface Iframe
public boolean isAutohide()
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
public void setAutohide(boolean autohide)
setAutohide
in interface Iframe
public java.lang.String getSrc()
Default: null.
getSrc
in interface Iframe
public void setSrc(java.lang.String 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.
setSrc
in interface Iframe
src
- the source URL. If null or empty, nothing is included.setContent(org.zkoss.util.media.Media)
protected java.lang.String getEncodedSrc()
getSrc()
).
public void setContent(Media media)
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.
setContent
in interface Iframe
media
- the media for this inline frame.setSrc(java.lang.String)
public Media getContent()
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)
.
getContent
in interface Iframe
protected void renderProperties(ContentRenderer renderer) throws java.io.IOException
HtmlBasedComponent
See also Render Special Properties
renderProperties
in class HtmlBasedComponent
java.io.IOException
public void service(AuRequest request, boolean everError)
Default: in addition to what are handled by HtmlBasedComponent.service(org.zkoss.zk.au.AuRequest, boolean)
,
it also handles onURIChange.
service
in interface ComponentCtrl
service
in class HtmlBasedComponent
everError
- whether any error ever occured before
processing this request.AbstractComponent.setAuService(org.zkoss.zk.au.AuService)
protected boolean isChildable()
isChildable
in class AbstractComponent
protected java.lang.Object newExtraCtrl()
HtmlBasedComponent
AbstractComponent.getExtraCtrl()
to create a client control.
It is used only by component developers.
Defaut: creates an instance of HtmlBasedComponent.ExtraCtrl
.
newExtraCtrl
in class HtmlBasedComponent
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |