org.zkoss.zul

Class Rating

java.lang.Object

org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zul.Rating

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Component, Disable, Readonly, Scope, ComponentCtrl

public class Rating
extends HtmlBasedComponent
implements Disable, Readonly

A rating component provides a icon based rating input. The default icon is Unicode ★ star icon. Icons could be set to unicode icons by specifying Unicode. (for example: ☎) Or even Font Awesome icons with the prefix z-icon. (for example: z-icon-home) The selectedIndex decides the rating input of this component.

Default HtmlBasedComponent.getZclass(): z-rating.

Since:

8.6.0

Author:

wenninghsu

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.zkoss.zk.ui.HtmlBasedComponent

HtmlBasedComponent.ExtraCtrl

Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent

AbstractComponent.Children

Field Summary

Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent

_zclass

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

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

Constructor Summary

Constructors

Constructor and Description
Rating()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getIconSclass() Returns the iconSclass name of this rating.
int	getMax() Returns the max rating of this rating component.
java.lang.String	getOrient() Returns the orientation of this rating component.
int	getRating() Returns the rating.
boolean	isCancelable() Returns whether this rating component is cancelable.
boolean	isDisabled() Returns if this rating component is disabled.
boolean	isReadonly() Returns if this rating component is readonly.
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	setCancelable(boolean cancelable) Sets whether to enable the cancel feature.
void	setDisabled(boolean disabled) Sets whether this component is disabled, means the rating is not changeable.
void	setIconSclass(java.lang.String iconSclass) Sets the iconSclass name of this rating.
void	setMax(int max) Sets the max rate of this rating component.
void	setOrient(java.lang.String orient) Sets the orientation of this rating component.
void	setRating(int rating) Sets the rating.
void	setReadonly(boolean readonly) Sets whether this component is readonly.

Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent

addSclass, clone, evalCSSFlex, focus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getPropertyAccess, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZindex, getZIndex, removeSclass, removeSclass, setAction, setClass, setDraggable, setDroppable, setFocus, setHeight, setHeight0, setHeightDirectly, setHflex, setHflex0, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTabindex, setTabindex, setTooltiptext, setTop, setTopDirectly, setVflex, setVflex0, setVflexDirectly, setWidth, setWidth0, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly

Methods inherited from class org.zkoss.zk.ui.AbstractComponent

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, 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, invalidatePartial, isChildable, isInitialized, 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

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl

invalidatePartial

Constructor Detail

Rating

public Rating()

Method Detail

getIconSclass

public java.lang.String getIconSclass()

Returns the iconSclass name of this rating.

Returns:

the iconSclass name

setIconSclass

public void setIconSclass(java.lang.String iconSclass)

Sets the iconSclass name of this rating.

Parameters:

iconSclass - String

getOrient

public java.lang.String getOrient()

Returns the orientation of this rating component. Default: horizontal if not specified.

Returns:

vertical or horizontal.

setOrient

public void setOrient(java.lang.String orient)

Sets the orientation of this rating component. Default: horizontal if not specified.

Parameters:

orient - vertical or horizontal.

getRating

public int getRating()

Returns the rating.

Returns:

the rating input

setRating

public void setRating(int rating)

Sets the rating.

Parameters:

rating -

isCancelable

public boolean isCancelable()

Returns whether this rating component is cancelable. If true, the rating could be cancel by clicking the rated rating again. Default: true

Returns:

true if enabled

setCancelable

public void setCancelable(boolean cancelable)

Sets whether to enable the cancel feature. If true, the rating could be cancel by clicking the rated rating again. Default: true

Parameters:

cancelable -

getMax

public int getMax()

Returns the max rating of this rating component. Default: 5

Returns:

max rate

setMax

public void setMax(int max)

Sets the max rate of this rating component. Default: 5

Parameters:

max -

isDisabled

public boolean isDisabled()

Returns if this rating component is disabled.

Specified by:

isDisabled in interface Disable

Returns:

boolean

setDisabled

public void setDisabled(boolean disabled)

Sets whether this component is disabled, means the rating is not changeable.

Specified by:

setDisabled in interface Disable

Parameters:

disabled -

isReadonly

public boolean isReadonly()

Returns if this rating component is readonly.

Specified by:

isReadonly in interface Readonly

Returns:

boolean

setReadonly

public void setReadonly(boolean readonly)

Sets whether this component is readonly.

Specified by:

setReadonly in interface Readonly

Parameters:

readonly -

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 ZK Client-side Reference: Property Rendering

Overrides:

renderProperties in class HtmlBasedComponent

Throws:

java.io.IOException

service

public void service(AuRequest request,
                    boolean everError)

Description copied from class: HtmlBasedComponent

Processes an AU request.

Default: it handles onClick, onDoubleClick, onRightClick onMove, onSize, onZIndex.

Specified by:

service in interface ComponentCtrl

Overrides:

service in class HtmlBasedComponent

everError - whether any error ever occurred before processing this request.

See Also:

AbstractComponent.setAuService(org.zkoss.zk.au.AuService)