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.ValueHolder,javax.faces.event.ComponentSystemEventListener,javax.faces.event.FacesListener,javax.faces.event.SystemEventListenerHolder,SupportFieldId,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 Summary
FieldsFields inherited from class javax.faces.component.UIInput
CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAMEFields inherited from class javax.faces.component.UIComponent
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionThe access key of this control.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.Displays a short text in the input field, that describes the meaning of this field.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) voidsetCustomClass(CustomClass customClass) voidsetDisabled(boolean disabled) voidsetFocus(boolean focus) voidvoidvoidsetLabelLayout(LabelLayout labelLayout) voidvoidsetMultiple(boolean multiple) voidsetPlaceholder(String placeholder) voidsetReadonly(boolean readonly) voidsetTabIndex(Integer tabIndex) voidMethods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIFile
getFieldId, isLabelLayoutSkip, validateMethods inherited from class javax.faces.component.UIInput
addValidator, 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.UIOutput
getConverter, getLocalValue, setConverterMethods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTreeMethods inherited from class javax.faces.component.UIComponent
getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEventMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviorsMethods inherited from interface javax.faces.component.ValueHolder
getConverter, getLocalValue, setConverterMethods inherited from interface org.apache.myfaces.tobago.component.Visual
getRendererType, isPlain
-
Field Details
-
COMPONENT_TYPE
-
COMPONENT_FAMILY
- See Also:
-
-
Constructor Details
-
UIFile
public UIFile()
-
-
Method Details
-
getEventNames
- Specified by:
getEventNamesin interfacejavax.faces.component.behavior.ClientBehaviorHolder- Overrides:
getEventNamesin classjavax.faces.component.UIComponentBase
-
getDefaultEventName
- Specified by:
getDefaultEventNamein interfacejavax.faces.component.behavior.ClientBehaviorHolder- Overrides:
getDefaultEventNamein classjavax.faces.component.UIComponentBase
-
getFamily
- Overrides:
getFamilyin classjavax.faces.component.UIInput
-
getMarkup
-
setMarkup
-
getLabelLayout
Defines 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
-
isMultiple
public boolean isMultiple()- Specified by:
isMultiplein classAbstractUIFile
-
setMultiple
public void setMultiple(boolean multiple) -
isFocus
public boolean isFocus()Flag indicating this component should receive the focus.
Default:false -
setFocus
public void setFocus(boolean focus) -
getTabIndex
Controls 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 classAbstractUIFile
-
setTabIndex
-
getLabel
A localized user presentable label for this component. -
setLabel
-
getHelp
Text value to display as a help. -
setHelp
-
isReadonly
public boolean isReadonly()Flag indicating that this component will prohibit changes by the user.
Default:false- Specified by:
isReadonlyin classAbstractUIFile
-
setReadonly
public void setReadonly(boolean readonly) -
getAccessKey
The access key of this control. -
setAccessKey
-
getCustomClass
Sets 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
-
isDisabled
public boolean isDisabled()Flag indicating that this element is disabled.
Default:false- Specified by:
isDisabledin classAbstractUIFile
-
setDisabled
public void setDisabled(boolean disabled) -
getTip
Text value to display as tooltip. -
setTip
-
getPlaceholder
Displays a short text in the input field, that describes the meaning of this field. This is part of HTML 5, the theme should emulate the behaviour, when the browser doesn't support it.
The text will not be displayed, when the input field is readonly or disabled.
- Specified by:
getPlaceholderin classAbstractUIFile
-
setPlaceholder
-
restoreState
- Specified by:
restoreStatein interfacejavax.faces.component.StateHolder- Overrides:
restoreStatein classjavax.faces.component.UIInput
-