|
||||||||||
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
public abstract class HtmlBasedComponent
A skeletal implementation for HTML based components. It simplifies to implement methods common to HTML based components.
It supports
Nested Class Summary | |
---|---|
protected class |
HtmlBasedComponent.ExtraCtrl
A utility class to implement AbstractComponent.getExtraCtrl() . |
Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent |
---|
AbstractComponent.Children |
Field Summary | |
---|---|
protected java.lang.String |
_height
The height. |
protected java.lang.String |
_left
|
protected java.lang.String |
_top
|
protected java.lang.String |
_width
The width. |
protected java.lang.String |
_zclass
The ZK CSS class. |
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 | |
---|---|
protected |
HtmlBasedComponent()
|
Method Summary | |
---|---|
void |
focus()
Sets focus to this element. |
java.lang.String |
getDraggable()
Returns the identifier of a draggable type of objects, or "false" if not draggable (never null nor empty). |
java.lang.String |
getDroppable()
Returns the identifier, or a list of identifiers of a droppable type of objects, or "false" if not droppable (never null nor empty). |
java.lang.String |
getHeight()
Returns the height. |
java.lang.String |
getHflex()
Returns horizontal flex hint of this component. |
java.lang.String |
getLeft()
Returns the left position. |
java.lang.String |
getSclass()
Returns the CSS class. |
java.lang.String |
getStyle()
Returns the CSS style. |
java.lang.String |
getTooltiptext()
Returns the text as the tooltip. |
java.lang.String |
getTop()
Returns the top position. |
java.lang.String |
getVflex()
Return vertical flex hint of this component. |
java.lang.String |
getWidth()
Returns the width. |
java.lang.String |
getZclass()
Returns the ZK Cascading Style class(es) for this component. |
int |
getZindex()
Returns the Z index. |
int |
getZIndex()
Returns the Z index. |
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 |
setClass(java.lang.String sclass)
Sets the CSS class. |
void |
setDraggable(java.lang.String draggable)
Sets "true" or "false" to denote whether a component is draggable, or an identifier of a draggable type of objects. |
void |
setDroppable(java.lang.String droppable)
Sets "true" or "false" to denote whether a component is droppable, or a list of identifiers of draggable types of objects that could be droped to this component. |
void |
setFocus(boolean focus)
Sets focus to this element. |
void |
setHeight(java.lang.String height)
Sets the height. |
void |
setHflex(java.lang.String flex)
Sets horizontal flex hint of this component. |
void |
setLeft(java.lang.String left)
Sets the left position. |
void |
setSclass(java.lang.String sclass)
Sets the CSS class. |
void |
setStyle(java.lang.String style)
Sets the CSS style. |
void |
setTooltiptext(java.lang.String tooltiptext)
Sets the text as the tooltip. |
void |
setTop(java.lang.String top)
Sets the top position. |
void |
setVflex(java.lang.String flex)
Sets vertical flexibility hint of this component. |
void |
setWidth(java.lang.String width)
Sets the width. |
void |
setZclass(java.lang.String zclass)
Sets the ZK Cascading Style class(es) for this component. |
void |
setZindex(int zIndex)
Sets the Z index. |
void |
setZIndex(int zIndex)
Sets the Z index. |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.zkoss.zk.ui.ext.Scope |
---|
addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute |
Field Detail |
---|
protected java.lang.String _width
protected java.lang.String _height
protected java.lang.String _zclass
protected java.lang.String _left
protected java.lang.String _top
Constructor Detail |
---|
protected HtmlBasedComponent()
Method Detail |
---|
public java.lang.String getLeft()
getLeft
in interface HtmlBasedComponent
public void setLeft(java.lang.String left)
If you want to specify right
, use setStyle(java.lang.String)
instead.
For example, setStyle("right: 0px");
setLeft
in interface HtmlBasedComponent
left
- the left position. Remember to specify px
, pt
or %
.public java.lang.String getTop()
getTop
in interface HtmlBasedComponent
public void setTop(java.lang.String top)
If you want to specify bottom
, use setStyle(java.lang.String)
instead.
For example, setStyle("bottom: 0px");
setTop
in interface HtmlBasedComponent
top
- the top position. Remember to specify px
, pt
or %
.public int getZIndex()
Default: -1 (means system default;
getZIndex
in interface HtmlBasedComponent
public void setZIndex(int zIndex)
setZIndex
in interface HtmlBasedComponent
public int getZindex()
getZIndex()
.
getZindex
in interface HtmlBasedComponent
public void setZindex(int zIndex)
setZIndex(int)
.
setZindex
in interface HtmlBasedComponent
public java.lang.String getHeight()
Default: null.
getHeight
in interface HtmlBasedComponent
public void setHeight(java.lang.String height)
setHeight
in interface HtmlBasedComponent
public java.lang.String getWidth()
Default: null.
getWidth
in interface HtmlBasedComponent
public void setWidth(java.lang.String width)
setWidth
in interface HtmlBasedComponent
public java.lang.String getTooltiptext()
Default: null.
getTooltiptext
in interface HtmlBasedComponent
public void setTooltiptext(java.lang.String tooltiptext)
setTooltiptext
in interface HtmlBasedComponent
public java.lang.String getZclass()
Default: null (the default value depends on element).
setZclass(java.lang.String)
) will completely replace the default style
of a component. In other words, the default style of a component
is associated with the default value of getZclass()
.
Once it is changed, the default style won't be applied at all.
If you want to perform small adjustments, use setSclass(java.lang.String)
instead.
getZclass
in interface HtmlBasedComponent
getSclass()
public void setZclass(java.lang.String zclass)
setZclass
in interface HtmlBasedComponent
zclass
- the style class used to apply the whote widget.setSclass(java.lang.String)
,
getZclass()
public java.lang.String getSclass()
Default: null.
The default styles of ZK components doesn't depend on the value
of getSclass()
. Rather, setSclass(java.lang.String)
is provided to
perform small adjustment, e.g., only changing the font size.
In other words, the default style is still applied if you change
the value of getSclass()
, unless you override it.
To replace the default style completely, use
setZclass(java.lang.String)
instead.
getSclass
in interface HtmlBasedComponent
getZclass()
public void setSclass(java.lang.String sclass)
setSclass
in interface HtmlBasedComponent
setZclass(java.lang.String)
public void setClass(java.lang.String sclass)
setSclass(java.lang.String)
.
public java.lang.String getStyle()
Default: null.
getStyle
in interface HtmlBasedComponent
public void setStyle(java.lang.String style)
setStyle
in interface HtmlBasedComponent
public void setDraggable(java.lang.String draggable)
The simplest way to make a component draggable is to set this attribute to true. To disable it, set this to false.
If there are several types of draggable objects, you could assign an identifier for each type of draggable object. The identifier could be anything but empty.
setDraggable
in interface HtmlBasedComponent
draggable
- "false", null or "" to denote non-draggable; "true" for draggable
with anonymous identifier; others for an identifier of draggable.public java.lang.String getDraggable()
public void setDroppable(java.lang.String droppable)
The simplest way to make a component droppable is to set this attribute to true. To disable it, set this to false.
If there are several types of draggable objects and this component accepts only some of them, you could assign a list of identifiers that this component accepts, separated by comma. For example, if this component accepts dg1 and dg2, then assign "dg1, dg2" to this attribute.
setDroppable
in interface HtmlBasedComponent
droppable
- "false", null or "" to denote not-droppable;
"true" for accepting any draggable types; a list of identifiers,
separated by comma for identifiers of draggables this component
accept (to be dropped in).public java.lang.String getDroppable()
public void focus()
focus
in interface HtmlBasedComponent
public void setFocus(boolean focus)
focus()
, but used to allow ZUML to set focus
to particular component.
<textbox focus="true"/>
setFocus
in interface HtmlBasedComponent
focus
- whether to set focus. If false, this method has no effect.public void setVflex(java.lang.String flex)
Number flex indicates how this component's container distributes remaining empty space among its children vertically. Flexible component grow and shrink to fit their given space. Flexible components with larger flex values will be made larger than components with lower flex values, at the ratio determined by all flexible components. The actual flex value is not relevant unless there are other flexible components within the same container. Once the default sizes of components in a container are calculated, the remaining space in the container is divided among the flexible components, according to their flex ratios.
Specify a flex value of negative value, 0, or "false" has the same effect as leaving the flex attribute out entirely. Specify a flex value of "true" has the same effect as a flex value of 1.
Special flex hint, "min", indicates that the minimum space shall be given to this flexible component to enclose all of its children components. That is, the flexible component grow and shrink to fit its children components.
flex
- the vertical flex hint.setHflex(java.lang.String)
,
getVflex()
public java.lang.String getVflex()
setVflex(java.lang.String)
public void setHflex(java.lang.String flex)
Number flex indicates how this component's container distributes remaining empty space among its children horizontally. Flexible component grow and shrink to fit their given space. Flexible components with larger flex values will be made larger than components with lower flex values, at the ratio determined by all flexible components. The actual flex value is not relevant unless there are other flexible components within the same container. Once the default sizes of components in a container are calculated, the remaining space in the container is divided among the flexible components, according to their flex ratios.
Specify a flex value of negative value, 0, or "false" has the same effect as leaving the flex attribute out entirely. Specify a flex value of "true" has the same effect as a flex value of 1.
Special flex hint, "min", indicates that the minimum space shall be given to this flexible component to enclose all of its children components. That is, the flexible component grow and shrink to fit its children components.
flex
- horizontal flex hint of this component.setVflex(java.lang.String)
,
getHflex()
public java.lang.String getHflex()
setHflex(java.lang.String)
protected void renderProperties(ContentRenderer renderer) throws java.io.IOException
See also Render Special Properties
renderProperties
in class AbstractComponent
java.io.IOException
public void service(AuRequest request, boolean everError)
Default: it handles onClick, onDoubleClick, onRightClick onMove, onSize, onZIndex.
service
in interface ComponentCtrl
service
in class AbstractComponent
everError
- whether any error ever occured before
processing this request.AbstractComponent.setAuService(org.zkoss.zk.au.AuService)
protected java.lang.Object newExtraCtrl()
AbstractComponent.getExtraCtrl()
to create a client control.
It is used only by component developers.
Defaut: creates an instance of HtmlBasedComponent.ExtraCtrl
.
newExtraCtrl
in class AbstractComponent
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |