com.ibm.xsp.component
Class UIFileuploadEx

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIOutput
              javax.faces.component.UIInput
                  com.ibm.xsp.component.UIFileuploadEx

All Implemented Interfaces:

FacesAttrsObject, FacesInputComponent, ThemeControl, javax.faces.component.EditableValueHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder

Direct Known Subclasses:

XspFileUpload

public class UIFileuploadEx
extends javax.faces.component.UIInput
implements FacesInputComponent, ThemeControl, FacesAttrsObject

Abstract File Upload Component Not intended to be subclassed.

Nested Class Summary

static class

UIFileuploadEx.UploadedFile

Nested classes/interfaces inherited from class javax.faces.component.UIComponentBase

javax.faces.component.UIComponentBase.AggregatedIterator, javax.faces.component.UIComponentBase.UnmodifiableIterator

Nested classes/interfaces inherited from class javax.faces.component.UIComponent

javax.faces.component.UIComponent.StateMap, javax.faces.component.UIComponent.StateMapEntry

Field Summary

static java.lang.String	ACCEPT_ATTR
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	EXCLUDE_ATTR
static java.lang.String	RENDERER_TYPE

Fields inherited from class javax.faces.component.UIInput

CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID

Fields inherited from class javax.faces.component.UIComponentBase

EMPTY_ITERATOR

Fields inherited from class javax.faces.component.UIComponent

_xspStateId

Constructor Summary

UIFileuploadEx()

Method Summary

void	addAttr(Attr attr) Add an Attr, to appear as an attribute in the HTML output of this control or object tag.
java.util.List<Attr>	getAttrs() The extra attributes to be output on the base element at the root of this control or object tag.
java.lang.String	getFamily()
java.lang.String	getFilename()
java.lang.String	getMimetype()
boolean	getRendersChildren() Returns a flag indicating whether this component is responsible for rendering its child components.
java.lang.String	getRequiredMessage()
java.lang.String	getStyleKitFamily() The styleKitFamily is basically the default themeId, to use if the "themeId" property is not set on this control instance in the XPage source.
boolean	isDisableClientSideValidation() Check if client side validation is disabled.
boolean	isDisableModifiedFlag() The modified support is the mechanism in the Notes Client where if an input control contains a value and the user closes the XPage tab, they will be prompted like: The XPage has been modified, Save, Discard, Cancel? As part of that mechanism, each input control has a "disableModifiedFlag" property to allow that control to opt-out of the modified support, so for example if you have a search field, where you don't normally save the searched text to a document, you would exclude that search field from the modified support, so a value in that search field will not cause the Save/Discard dialog to appear.
boolean	isDisableValidators() Check if the validators should be disabled for this control.
boolean	isRequired()
boolean	isShowReadonlyAsDisabled()
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
java.lang.Object	saveState(javax.faces.context.FacesContext context)
void	setAttrs(java.util.List<Attr> attrs) This method is not used by the XPage generated .java file - instead the addAttr(Attr) method is used to add attributes to the list.
void	setDisableClientSideValidation(boolean disableClientSideValidation)
void	setDisableModifiedFlag(boolean disableModifiedFlag)
void	setDisableValidators(boolean disableValidators)
void	setRequired(boolean required)
void	setShowReadonlyAsDisabled(boolean showReadonlyAsDisabled)
void	updateModel(javax.faces.context.FacesContext context)
void	validate(javax.faces.context.FacesContext context)
protected void	validateValue(javax.faces.context.FacesContext context, java.lang.Object newValue)

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, broadcast, compareValues, decode, getConvertedValue, getSubmittedValue, getValidator, getValidators, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, setImmediate, setLocalValueSet, setSubmittedValue, setValid, setValidator, setValue, setValueChangeListener

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, getValue, setConverter

Methods inherited from class javax.faces.component.UIComponentBase

_xspCleanTransientData, _xspGetReadOnlyObj, _xspGetRendererData, _xspRemoveReadOnlyObj, _xspRemoveRendererData, _xspSetIdUnchecked, _xspSetReadOnlyObj, _xspSetRendererData, addFacesListener, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class javax.faces.component.UIComponent

_xspGetStateId, _xspGetStateMap, _xspRestoreAttribute, _xspRestoreState, _xspSaveState, invokeOnComponent, isVisitable, markInitialState, setControlState, visitTree

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, getLocalValue, getValue, setConverter

Field Detail

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE

See Also:

Constant Field Values

EXCLUDE_ATTR

public static final java.lang.String EXCLUDE_ATTR

See Also:

Constant Field Values

ACCEPT_ATTR

public static final java.lang.String ACCEPT_ATTR

See Also:

Constant Field Values

Constructor Detail

UIFileuploadEx

public UIFileuploadEx()

Method Detail

getStyleKitFamily

public java.lang.String getStyleKitFamily()

Description copied from interface: ThemeControl

The styleKitFamily is basically the default themeId, to use if the "themeId" property is not set on this control instance in the XPage source. For example, "InputField.EditBox" is used for most Edit Box controls. See Domino/xsp/nsf/themes/webstandard.theme for more examples.

The implementation may return different values depending on the configuration of the current control, for example the Button control returns a different value and looks different when it is configured as a cancel button.

Specified by:

getStyleKitFamily in interface ThemeControl

Returns:

a non-null themeId corresponding to the configuration for this type of control in a theme file.

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class javax.faces.component.UIInput

getFilename

public java.lang.String getFilename()

getMimetype

public java.lang.String getMimetype()

isDisableModifiedFlag

public boolean isDisableModifiedFlag()

Description copied from interface: FacesInputComponent

The modified support is the mechanism in the Notes Client where if an input control contains a value and the user closes the XPage tab, they will be prompted like: The XPage has been modified, Save, Discard, Cancel? As part of that mechanism, each input control has a "disableModifiedFlag" property to allow that control to opt-out of the modified support, so for example if you have a search field, where you don't normally save the searched text to a document, you would exclude that search field from the modified support, so a value in that search field will not cause the Save/Discard dialog to appear. This method checks the value of that input control property in the XPage, and also, if the value is not set for the individual input control, checks the property on the XPage root control UIViewRootEx.isEnableModifiedFlag().

Specified by:

isDisableModifiedFlag in interface FacesInputComponent

Returns:

setDisableModifiedFlag

public void setDisableModifiedFlag(boolean disableModifiedFlag)

isDisableClientSideValidation

public boolean isDisableClientSideValidation()

Description copied from interface: FacesInputComponent

Check if client side validation is disabled.

Specified by:

isDisableClientSideValidation in interface FacesInputComponent

Returns:

setDisableClientSideValidation

public void setDisableClientSideValidation(boolean disableClientSideValidation)

isDisableValidators

public boolean isDisableValidators()

Description copied from interface: FacesInputComponent

Check if the validators should be disabled for this control.

Specified by:

isDisableValidators in interface FacesInputComponent

Returns:

setDisableValidators

public void setDisableValidators(boolean disableValidators)

isShowReadonlyAsDisabled

public boolean isShowReadonlyAsDisabled()

setShowReadonlyAsDisabled

public void setShowReadonlyAsDisabled(boolean showReadonlyAsDisabled)

getAttrs

public java.util.List<Attr> getAttrs()

The extra attributes to be output on the base element at the root of this control or object tag. This should only be used when none of the properties in the All Properties pane correspond to the desired attribute. This may return null. The addAttr(Attr) method should be used to add an Attr.

Specified by:

getAttrs in interface FacesAttrsObject

addAttr

public void addAttr(Attr attr)

Add an Attr, to appear as an attribute in the HTML output of this control or object tag.

Specified by:

addAttr in interface FacesAttrsObject

Parameters:

action -

setAttrs

public void setAttrs(java.util.List<Attr> attrs)

This method is not used by the XPage generated .java file - instead the addAttr(Attr) method is used to add attributes to the list.

updateModel

public void updateModel(javax.faces.context.FacesContext context)

Overrides:

updateModel in class javax.faces.component.UIInput

getRendersChildren

public boolean getRendersChildren()

Returns a flag indicating whether this component is responsible for rendering its child components.

Overrides:

getRendersChildren in class javax.faces.component.UIComponentBase

See Also:

UIComponent.getRendersChildren()

validate

public void validate(javax.faces.context.FacesContext context)

Overrides:

validate in class javax.faces.component.UIInput

validateValue

protected void validateValue(javax.faces.context.FacesContext context,
                             java.lang.Object newValue)

Overrides:

validateValue in class javax.faces.component.UIInput

setRequired

public void setRequired(boolean required)

Specified by:

setRequired in interface javax.faces.component.EditableValueHolder

Overrides:

setRequired in class javax.faces.component.UIInput

isRequired

public boolean isRequired()

Specified by:

isRequired in interface javax.faces.component.EditableValueHolder

Overrides:

isRequired in class javax.faces.component.UIInput

getRequiredMessage

public java.lang.String getRequiredMessage()

Overrides:

getRequiredMessage in class javax.faces.component.UIInput

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIInput

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UIInput