Class UIStars
java.lang.Object
javax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIOutput
javax.faces.component.UIInput
org.apache.myfaces.tobago.internal.component.AbstractUIInput
org.apache.myfaces.tobago.internal.component.AbstractUIStars
org.apache.myfaces.tobago.component.UIStars
- All Implemented Interfaces:
- EventListener,- javax.faces.component.behavior.ClientBehaviorHolder,- javax.faces.component.EditableValueHolder,- javax.faces.component.PartialStateHolder,- javax.faces.component.StateHolder,- javax.faces.component.TransientStateHolder,- javax.faces.component.ValueHolder,- javax.faces.event.ComponentSystemEventListener,- javax.faces.event.FacesListener,- javax.faces.event.SystemEventListenerHolder,- SupportFieldId,- SupportsAccessKey,- SupportsAutoSpacing,- SupportsHelp,- SupportsLabelLayout,- Visual
Renders a star rating component.
 UIComponent class, generated from template 
component.stg with class
 StarsTagDeclaration.- 
Field SummaryFieldsFields inherited from class javax.faces.component.UIInputALWAYS_PERFORM_VALIDATION_WHEN_REQUIRED_IS_TRUE, CONVERSION_MESSAGE_ID, EMPTY_STRING_AS_NULL_PARAM_NAME, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAMEFields inherited from class javax.faces.component.UIComponentATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionThe access key of this control.Automatically add spacing (margins/paddings) to the component for better positioning.Sets a CSS class in its parent, if the parent supports it.getHelp()Text value to display as a help.getLabel()A localized user presentable label for this component.Defines the position of the label relative to the field.getMax()The maximum value must be > '0'.The placeholder value is displayed if no star is set by the user.Controls the navigation of the focus through the input controls on a page with the Tab-Key.getTip()Text value to display as tooltip.booleanFlag indicating that this element is disabled.booleanisFocus()Flag indicating this component should receive the focus.booleanFlag indicating that this component will prohibit changes by the user.voidrestoreState(javax.faces.context.FacesContext context, Object state) voidsetAccessKey(Character accessKey) voidsetAutoSpacing(Boolean autoSpacing) voidsetCustomClass(CustomClass customClass) voidsetDisabled(boolean disabled) voidsetFocus(boolean focus) voidvoidvoidsetLabelLayout(LabelLayout labelLayout) voidvoidvoidsetPlaceholder(Double placeholder) voidsetReadonly(boolean readonly) voidsetTabIndex(Integer tabIndex) voidMethods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIStarsgetRangeMax, getRangeValue, processEventMethods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIInputgetFieldId, isError, isNextToRenderIsLabel, setNextToRenderIsLabelMethods inherited from class javax.faces.component.UIInputaddValidator, addValueChangeListener, broadcast, clearInitialState, compareValues, decode, getConvertedValue, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValue, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, markInitialState, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, saveState, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel, validate, validateValueMethods inherited from class javax.faces.component.UIOutputgetConverter, getLocalValue, setConverterMethods inherited from class javax.faces.component.UIComponentBaseaddClientBehavior, addFacesListener, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTreeMethods inherited from class javax.faces.component.UIComponentgetClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEventMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface javax.faces.component.behavior.ClientBehaviorHolderaddClientBehavior, getClientBehaviorsMethods inherited from interface org.apache.myfaces.tobago.component.SupportsAutoSpacinggetAutoSpacingMethods inherited from interface javax.faces.component.ValueHoldergetConverter, getLocalValue, setConverterMethods inherited from interface org.apache.myfaces.tobago.component.VisualgetRendererType, isPlain
- 
Field Details- 
COMPONENT_TYPE
- 
COMPONENT_FAMILY- See Also:
 
 
- 
- 
Constructor Details- 
UIStarspublic UIStars()
 
- 
- 
Method Details- 
getEventNames- Specified by:
- getEventNamesin interface- javax.faces.component.behavior.ClientBehaviorHolder
- Overrides:
- getEventNamesin class- javax.faces.component.UIComponentBase
 
- 
getDefaultEventName- Specified by:
- getDefaultEventNamein interface- javax.faces.component.behavior.ClientBehaviorHolder
- Overrides:
- getDefaultEventNamein class- javax.faces.component.UIComponentBase
 
- 
getFamily- Overrides:
- getFamilyin class- javax.faces.component.UIInput
 
- 
getMarkup
- 
setMarkup
- 
getMaxThe maximum value must be > '0'. Default is '5'. To split stars, set a higher maximum value. E.g. set '10' for half stars, set '20' for quarter stars.- Specified by:
- getMaxin class- AbstractUIStars
 
- 
setMax
- 
getLabelLayoutDefines the position of the label relative to the field. The default is flexLeft, if the label is set, or none, if the label isn't set. Set to 'skip' to avoid surrounding label container. Hint for tc:out: set also compact=true to render only text (without html tags).
- 
setLabelLayout
- 
isFocuspublic boolean isFocus()Flag indicating this component should receive the focus.
 Default:false- Specified by:
- isFocusin class- AbstractUIInput
 
- 
setFocuspublic void setFocus(boolean focus) 
- 
getTabIndexControls the navigation of the focus through the input controls on a page with the Tab-Key. The navigation starts from the element with the lowest tabIndex value to the element with the highest value. Elements that have identical tabIndex values should be navigated in the order they appear in the character stream Elements that are disabled or with a negative tabIndex do not participate in the tabbing order.- Specified by:
- getTabIndexin class- AbstractUIInput
 
- 
setTabIndex
- 
getLabelA localized user presentable label for this component.
- 
setLabel
- 
getHelpText value to display as a help.
- 
setHelp
- 
getAutoSpacingAutomatically add spacing (margins/paddings) to the component for better positioning. Default is 'true' except the component is inside a: - header - footer - bar - sheet - tree - link group - button group - before facet - after facet - label facet - bar facet
- 
setAutoSpacing
- 
isReadonlypublic boolean isReadonly()Flag indicating that this component will prohibit changes by the user.
 Default:false- Specified by:
- isReadonlyin class- AbstractUIInput
 
- 
setReadonlypublic void setReadonly(boolean readonly) 
- 
getAccessKeyThe access key of this control.
- 
setAccessKey
- 
getCustomClassSets a CSS class in its parent, if the parent supports it. Which this feature it is possible to put a CSS class name into a component with the <tc:style> tag. Example:<tc:in> <tc:style customClass="my-emphasized"/> </tc:in>One capability is, to used external CSS libs.
 This feature should not be used imprudent. Because it might be unstable against changes in the renderered HTML code.
- 
setCustomClass
- 
isDisabledpublic boolean isDisabled()Flag indicating that this element is disabled.
 Default:false- Specified by:
- isDisabledin class- AbstractUIInput
 
- 
setDisabledpublic void setDisabled(boolean disabled) 
- 
getTipText value to display as tooltip.
- 
setTip
- 
getPlaceholderThe placeholder value is displayed if no star is set by the user. Value must be between '0' and '5'. The placeholder can show values which are not selectable by the user. E.g. if only full stars are available for the user, the placeholder can show a 4.6 star rating.- Specified by:
- getPlaceholderin class- AbstractUIStars
 
- 
setPlaceholder
- 
restoreState- Specified by:
- restoreStatein interface- javax.faces.component.StateHolder
- Overrides:
- restoreStatein class- javax.faces.component.UIInput
 
 
-