public abstract class HtmlBasedComponent extends AbstractComponent
Events:
onClick, onDoubleClick, onRightClick, onDrop,
onMouseOver, onMouseOut, onOK, onCacnel, onCtrlKey and onSwipe.
It supports
Modifier and Type | Class and Description |
---|---|
protected class |
HtmlBasedComponent.ExtraCtrl
A utility class to implement
getExtraCtrl() . |
AbstractComponent.Children
Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
_zclass
The ZK CSS class.
|
APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE
AFTER_CHILD_ADDED, AFTER_CHILD_REMOVED, AFTER_PAGE_ATTACHED, AFTER_PAGE_DETACHED, CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE
Modifier | Constructor and Description |
---|---|
protected |
HtmlBasedComponent() |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone()
Clones the component.
|
void |
focus()
Sets focus to this element.
|
java.lang.String |
getAction()
Returns the client-side action (CSA).
|
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.Object |
getExtraCtrl()
Returns the client control for this component.
|
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.
|
PropertyAccess |
getPropertyAccess(java.lang.String prop)
Returns the corresponding property access object from the given property
name, if any.
|
int |
getRenderdefer()
Returns the number of milliseconds before rendering this component
at the client.
|
java.lang.String |
getSclass()
Returns the CSS class.
|
java.lang.String |
getStyle()
Returns the CSS style.
|
int |
getTabindex()
Returns the tab order of this component.
|
java.lang.Integer |
getTabindexInteger()
Returns null if not set.
|
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 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 |
setAction(java.lang.String action)
Sets the client-side action (CSA).
|
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 dropped to this component.
|
void |
setFocus(boolean focus)
Sets focus to this element.
|
void |
setHeight(java.lang.String height)
Sets the height.
|
protected void |
setHeight0(java.lang.String height)
Internal Use Only.
|
protected void |
setHeightDirectly(java.lang.String height)
Sets the height directly without sending back the result
(smart update) to the client
|
void |
setHflex(java.lang.String flex)
Sets horizontal flex hint of this component.
|
protected void |
setHflex0(java.lang.String flex)
Internal Use Only.
|
protected void |
setHflexDirectly(java.lang.String hflex)
Sets the hflex directly without sending back the result
(smart update) to the client
|
void |
setLeft(java.lang.String left)
Sets the left position.
|
protected void |
setLeftDirectly(java.lang.String left)
Sets the left directly without sending back the result
(smart update) to the client
|
void |
setRenderdefer(int ms)
Sets the number of milliseconds before rendering this component
at the client.
|
void |
setSclass(java.lang.String sclass)
Sets the CSS class.
|
void |
setStyle(java.lang.String style)
Sets the CSS style.
|
void |
setTabindex(int tabindex)
Sets the tab order of this component.
|
void |
setTabindex(java.lang.Integer tabindex)
Sets the tab order of this component.
|
void |
setTooltiptext(java.lang.String tooltiptext)
Sets the text as the tooltip.
|
void |
setTop(java.lang.String top)
Sets the top position.
|
protected void |
setTopDirectly(java.lang.String top)
Sets the top directly without sending back the result
(smart update) to the client
|
void |
setVflex(java.lang.String flex)
Sets vertical flexibility hint of this component.
|
protected void |
setVflex0(java.lang.String flex)
Internal Use Only.
|
protected void |
setVflexDirectly(java.lang.String vflex)
Sets the vflex directly without sending back the result
(smart update) to the client
|
void |
setWidth(java.lang.String width)
Sets the width.
|
protected void |
setWidth0(java.lang.String width)
Internal Use Only.
|
protected void |
setWidthDirectly(java.lang.String width)
Sets the width directly without sending back the result
(smart update) to the client
|
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.
|
protected void |
setZIndexDirectly(int zIndex)
Sets the z-index directly without sending back the result
(smart update) to the client
|
addAnnotation, addAnnotation, addCallback, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, beforeParentChanged, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, enableBindingAnnotation, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getCallback, getChildren, getClientAttribute, getClientDataAttribute, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRedrawCallback, getRoot, getShadowFellowIfAny, getShadowRoots, getShadowVariable, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, insertBefore, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeCallback, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, replace, response, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setSubBindingAnnotationCount, setTemplate, setVisible, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, updateSubBindingAnnotationCount, willPassivate, willPassivate, willSerialize, willSerialize
public java.lang.String getLeft()
public void setLeft(java.lang.String left)
If you want to specify right
, use setStyle(java.lang.String)
instead.
For example, setStyle("right: 0px");
left
- the left position. Remember to specify px
, pt
or %
.public java.lang.String getTop()
public void setTop(java.lang.String top)
If you want to specify bottom
, use setStyle(java.lang.String)
instead.
For example, setStyle("bottom: 0px");
top
- the top position. Remember to specify px
, pt
or %
.public int getZIndex()
Default: -1 (means system default;
public void setZIndex(int zIndex)
public int getZindex()
getZIndex()
.public void setZindex(int zIndex)
setZIndex(int)
.public java.lang.String getHeight()
Default: null.
public void setHeight(java.lang.String height)
protected void setHeight0(java.lang.String height)
public java.lang.String getWidth()
Default: null.
public void setWidth(java.lang.String width)
protected void setWidth0(java.lang.String width)
protected void setWidthDirectly(java.lang.String width)
protected void setHeightDirectly(java.lang.String height)
protected void setLeftDirectly(java.lang.String left)
protected void setTopDirectly(java.lang.String top)
protected void setZIndexDirectly(int zIndex)
protected void setHflexDirectly(java.lang.String hflex)
protected void setVflexDirectly(java.lang.String vflex)
public java.lang.String getTooltiptext()
Default: null.
public void setTooltiptext(java.lang.String tooltiptext)
public java.lang.String getZclass()
AbstractComponent.getMold()
).
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.
getSclass()
public void setZclass(java.lang.String zclass)
AbstractComponent.getMold()
).zclass
- the style class used to apply to the whole 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.
getZclass()
public void setSclass(java.lang.String sclass)
setZclass(java.lang.String)
public void setClass(java.lang.String sclass)
setSclass(java.lang.String)
.public java.lang.String getStyle()
Default: null.
public void setStyle(java.lang.String style)
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.
draggable
- "false", "" or null to denote non-draggable; "true" for draggable
with anonymous identifier; others for an identifier of draggable.DragControl
and draggable is null,
then it means 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.
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()
public void setFocus(boolean focus)
focus()
, but used to allow ZUML to set focus
to particular component.
<textbox focus="true"/>
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()
protected void setVflex0(java.lang.String flex)
public java.lang.String getVflex()
Default: null
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()
protected void setHflex0(java.lang.String flex)
public java.lang.String getHflex()
Default: null
setHflex(java.lang.String)
public int getRenderdefer()
Default: -1 (don't wait).
public void setRenderdefer(int ms)
Default: -1 (don't wait).
This method is useful if you have a sophisticated page that takes
long to render at a slow client. You can specify a non-negative value
as the render-defer delay such that the other part of the UI can appear
earlier. The styling of the render-deferred widget is controlled by
a CSS class called z-renderdefer
.
Notice that it has no effect if the component has been rendered at the client.
ms
- time to wait in milliseconds before rendering.
Notice: 0 also implies deferring the rendering (just right after
all others are rendered).public java.lang.String getAction()
Default: null (no CSA at all)
public void setAction(java.lang.String action)
Default: null (no CSA at all)
The format:
action1: action-effect1; action2: action-effect2
Currently, only two actions are show
and hide
.
They are called when the widget is becoming visible (show) and invisible (hide).
The action effect (action-effect1
) is the name of a method
defined in zk.eff.Actions,
such as
show: slideDown; hide: slideUp
You could specify the effects as follows:
show: slideDown({duration:1000})
Security Tips: the action is not encoded and it is OK to embed JavaScript, so, if you want to allow users to specify the action, you have to encode it.
Note for developers upgraded from ZK 3:
CSA's format is different and limited.
In additions, it is part of HtmlBasedComponent
.
public int getTabindex()
Default: 0
public java.lang.Integer getTabindexInteger()
public void setTabindex(int tabindex) throws WrongValueException
WrongValueException
public void setTabindex(java.lang.Integer tabindex)
tabindex
- protected void renderProperties(ContentRenderer renderer) throws java.io.IOException
renderProperties
in class AbstractComponent
java.io.IOException
public PropertyAccess getPropertyAccess(java.lang.String prop)
ComponentCtrl
getPropertyAccess
in interface ComponentCtrl
getPropertyAccess
in class AbstractComponent
prop
- the name of the propertypublic 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 occurred before
processing this request.AbstractComponent.setAuService(org.zkoss.zk.au.AuService)
public java.lang.Object getExtraCtrl()
Default: creates an instance of HtmlBasedComponent.ExtraCtrl
.
getExtraCtrl
in interface ComponentCtrl
getExtraCtrl
in class AbstractComponent
Cropper
.ComponentCtrl.getExtraCtrl()
public java.lang.Object clone()
Component
clone
in interface Component
clone
in class AbstractComponent
Copyright © 2005-2018 Potix Corporation. All Rights Reserved.