Class UIFile
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.AbstractUIFile
org.apache.myfaces.tobago.component.UIFile
- 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,- SupportsAutoSpacing,- SupportsDecorationPosition,- SupportsHelp,- SupportsLabelLayout,- Visual
Renders a file input field.
For content constraints please use tc:validateFileItem.
UIComponent class, generated from templatecomponent.stg with class
 FileTagDeclaration.- 
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.The id of the HTMLElement in the Browser to drop the file.getHelp()Text value to display as a help.Defines the position and the appearance of a help message on a component.getLabel()A localized user presentable label for this component.Defines the position of the label relative to the field.Defines the position and the appearance of additional faces messages (like error message or help message) on a component.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.booleanbooleanFlag 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) voidsetDropZone(String dropZone) voidsetFocus(boolean focus) voidvoidsetHelpPosition(DecorationPosition helpPosition) voidvoidsetLabelLayout(LabelLayout labelLayout) voidvoidsetMessagePosition(DecorationPosition messagePosition) voidsetMultiple(boolean multiple) voidsetReadonly(boolean readonly) voidsetTabIndex(Integer tabIndex) voidMethods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIFilegetFieldId, isNextToRenderIsLabel, setNextToRenderIsLabel, validateMethods 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, 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, processEvent, 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- 
UIFilepublic UIFile()
 
- 
- 
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
 
- 
getDropZoneThe id of the HTMLElement in the Browser to drop the file.- Specified by:
- getDropZonein class- AbstractUIFile
 
- 
setDropZone
- 
getMarkup
- 
setMarkup
- 
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
- 
getMessagePositionDefines the position and the appearance of additional faces messages (like error message or help message) on a component. The default is popoverRight.
- 
setMessagePosition
- 
isMultiplepublic boolean isMultiple()- Specified by:
- isMultiplein class- AbstractUIFile
 
- 
setMultiplepublic void setMultiple(boolean multiple) 
- 
isFocuspublic boolean isFocus()Flag indicating this component should receive the focus.
 Default:false
- 
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- AbstractUIFile
 
- 
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- AbstractUIFile
 
- 
setReadonlypublic void setReadonly(boolean readonly) 
- 
getHelpPositionDefines the position and the appearance of a help message on a component. The default is popoverRight.
- 
setHelpPosition
- 
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- AbstractUIFile
 
- 
setDisabledpublic void setDisabled(boolean disabled) 
- 
getTipText value to display as tooltip.
- 
setTip
- 
restoreState- Specified by:
- restoreStatein interface- javax.faces.component.StateHolder
- Overrides:
- restoreStatein class- javax.faces.component.UIInput
 
 
-