Skip navigation links

Oracle© Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 1 (11.1.1.7.0)
E10684-08


oracle.adf.view.rich.component.rich.input
Class RichInputFile

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by org.apache.myfaces.trinidad.component.UIXComponent
          extended by org.apache.myfaces.trinidad.component.UIXComponentBase
              extended by org.apache.myfaces.trinidad.component.UIXValue
                  extended by org.apache.myfaces.trinidad.component.UIXEditableValue
                      extended by org.apache.myfaces.trinidad.component.UIXInput
                          extended by oracle.adf.view.rich.component.rich.input.RichInputFile

All Implemented Interfaces:
javax.faces.component.EditableValueHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder

public class RichInputFile
extends org.apache.myfaces.trinidad.component.UIXInput

The inputFile component is a component that can be used to upload a file. Any form that contains this component must have usesUpload set to true. The "value" property of an inputFile component will be set to an instance of the <html:code>org.apache.myfaces.trinidad.model.UploadedFile</html:code> class when a file is uploaded in single file mode (with the appropriate <html:code>ValueChangeEvent</html:code> delivered.) The property will be set to an instance of <html:code>List<org.apache.myfaces.trinidad.model.UploadedFile></html:code> when the component is in multiple file upload mode. Before using the component, developers must install the Trinidad filter. <html:p> The component supports custom converters to transform the <html:code>org.apache.myfaces.trinidad.model.UploadedFile</html:code>. To archive this, the the <html:code>getAsObject()</html:code> method is invoked, where the the <html:code>String</html:code> value is a key, which must be used to query the actual uploaded file from the request Map: </html:p>

   public Object getAsObject(FacesContext context, UIComponent component, String fileKey)
   {
     UploadedFile file = (UploadedFile)context.getExternalContext().getRequestMap().get(fileKey);
     // do transformation
     return file;
   }
           

<html:p> There is a maximum size for downloaded files. For further information, see Configuration (The Configuration page comes from the Apache Trinidad site and therefore refers to tr: components. Simply replace tr: with af: for ADF Faces). </html:p> <html:p> The attributes "disabled", "immediate", "readOnly", "required", "requiredMessageDetail", "value" are not settable from the client for security reasons. </html:p>

Events:

Type Phases Description
javax.faces.event.ValueChangeEvent Process Validations
Apply Request Values
The valueChange event is delivered when the value attribute is changed.
org.apache.myfaces.trinidad.event.AttributeChangeEvent Invoke Application
Apply Request Values
Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.

Field Summary
static org.apache.myfaces.trinidad.bean.PropertyKey ACCESS_KEY_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey AUTO_HEIGHT_ROWS_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey AUTO_SUBMIT_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey CHANGED_DESC_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey CHANGED_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey COLUMNS_KEY
           
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
static org.apache.myfaces.trinidad.bean.PropertyKey CONTENT_STYLE_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY
          Deprecated. 
static org.apache.myfaces.trinidad.bean.PropertyKey DISABLED_KEY
           
static java.lang.String EDITABLE_ALWAYS
           
static java.lang.String EDITABLE_INHERIT
           
static org.apache.myfaces.trinidad.bean.PropertyKey EDITABLE_KEY
           
static java.lang.String EDITABLE_ON_ACCESS
           
static java.lang.String HELP_FACET
           
static org.apache.myfaces.trinidad.bean.PropertyKey HELP_TOPIC_ID_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey LABEL_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey MAXIMUM_FILES_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey READ_ONLY_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey ROWS_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey SHOW_REQUIRED_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey SIMPLE_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY
           
static org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
           
static org.apache.myfaces.trinidad.bean.PropertyKey UNSECURE_KEY
           
static java.lang.String UPLOAD_TYPE_AUTO
           
static java.lang.String UPLOAD_TYPE_AUTO_IF_MULTIPLE
           
static org.apache.myfaces.trinidad.bean.PropertyKey UPLOAD_TYPE_KEY
           
static java.lang.String UPLOAD_TYPE_MANUAL
           
static java.lang.String UPLOAD_TYPE_MANUAL_IF_MULTIPLE
           
static java.lang.String UPLOAD_TYPE_SUBMIT
           
static org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY
           

 

Fields inherited from class org.apache.myfaces.trinidad.component.UIXEditableValue
CONVERSION_MESSAGE_ID, IMMEDIATE_KEY, LOCAL_VALUE_SET_KEY, REQUIRED_KEY, REQUIRED_MESSAGE_DETAIL_KEY, REQUIRED_MESSAGE_ID, SUBMITTED_VALUE_KEY, VALID_KEY, VALIDATE_EMPTY_FIELDS_PARAM_NAME, VALIDATOR_KEY, VALIDATORS_KEY, VALUE_CHANGE_LISTENER_KEY

 

Fields inherited from class org.apache.myfaces.trinidad.component.UIXValue
CONVERTER_KEY, VALUE_KEY

 

Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

 

Fields inherited from class javax.faces.component.UIComponent
bindings

 

Constructor Summary
  RichInputFile()
          Construct an instance of the RichInputFile.
protected RichInputFile(java.lang.String rendererType)
          Construct an instance of the RichInputFile.

 

Method Summary
 char getAccessKey()
          Gets a character used to gain quick access to the form element specified by the for, if set (or this component itself, if it is a "non-simple" form element).
 int getAutoHeightRows()
          Gets an attribute that specifies the number of rows used to size the component height.
protected  org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
           
 java.lang.String getChangedDesc()
          Gets the text commonly used by user agents to display tooltip text on the changed indicator icon.
 java.util.Set getClientAttributes()
          Gets a set of client attribute names.
 ClientListenerSet getClientListeners()
          Gets a set of client listeners.
 int getColumns()
          Gets the size of the text control specified by the number of characters shown.The default value depends on the browser.
 java.lang.String getContentStyle()
          Gets the style of the content piece of the component.
 java.lang.String getCustomizationId()
          Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
 java.lang.String getEditable()
          Gets the editable look and feel to use for input components.
 java.lang.String getFamily()
           
 javax.faces.component.UIComponent getHelp()
          This facet is deprecated, helpTopicId should be used for providing help.
 java.lang.String getHelpTopicId()
          Gets the id used to look up a topic in a helpProvider.
 java.lang.String getInlineStyle()
          Gets the CSS styles to use for this component.
 java.lang.String getLabel()
          Gets the label of the component.
 int getMaximumFiles()
          Gets an attribute that is used to restrict the number of files a user can upload.
 java.lang.String[] getPartialTriggers()
          Gets the IDs of the components that should trigger a partial update.
 int getRows()
          Gets an attribute that determines the number of rows in the file list.
 java.lang.String getShortDesc()
          Gets the short description of the component.
 java.lang.String getStyleClass()
          Gets a CSS style class to use for this component.
 java.util.Set<java.lang.String> getUnsecure()
          Gets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client.
 java.lang.String getUploadType()
          Gets an attribute that controls the upload behavior of the component.
 boolean isAutoSubmit()
          Gets an attribute which if set to TRUE on a form element, the component will automatically submit when an appropriate action takes place (a click, text change, etc.).
 boolean isChanged()
          Gets an attribute which if set to true, the changed indicator icon will be displayed on the component.
 boolean isClientComponent()
          Gets whether a client-side component will be generated.
 boolean isDisabled()
          Gets whether the element is disabled.
 boolean isReadOnly()
          Gets whether the control is displayed as an editable field or as an output-style text control.
 boolean isShowRequired()
          Gets whether the associated control displays a visual indication of required user input.
 boolean isSimple()
          Gets a boolean value that controls whether the component provides label support; when set to "true", the component will not display the label (these may be ignored: label, labelAndAccessKey, accessKey, showRequired, help facet) and may use simpler layout primitives.
 boolean isVisible()
          Gets the visibility of the component.
 void setAccessKey(char accessKey)
          Sets a character used to gain quick access to the form element specified by the for, if set (or this component itself, if it is a "non-simple" form element).
 void setAutoHeightRows(int autoHeightRows)
          Sets an attribute that specifies the number of rows used to size the component height.
 void setAutoSubmit(boolean autoSubmit)
          Sets an attribute which if set to TRUE on a form element, the component will automatically submit when an appropriate action takes place (a click, text change, etc.).
 void setChanged(boolean changed)
          Sets an attribute which if set to true, the changed indicator icon will be displayed on the component.
 void setChangedDesc(java.lang.String changedDesc)
          Sets the text commonly used by user agents to display tooltip text on the changed indicator icon.
 void setClientAttributes(java.util.Set clientAttributes)
          Sets a set of client attribute names.
 void setClientComponent(boolean clientComponent)
          Sets whether a client-side component will be generated.
 void setClientListeners(ClientListenerSet clientListeners)
          Sets a set of client listeners.
 void setColumns(int columns)
          Sets the size of the text control specified by the number of characters shown.The default value depends on the browser.
 void setContentStyle(java.lang.String contentStyle)
          Sets the style of the content piece of the component.
 void setCustomizationId(java.lang.String customizationId)
          Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
 void setDisabled(boolean disabled)
          Sets whether the element is disabled.
 void setEditable(java.lang.String editable)
          Sets the editable look and feel to use for input components.
 void setHelp(javax.faces.component.UIComponent helpFacet)
          This facet is deprecated, helpTopicId should be used for providing help.
 void setHelpTopicId(java.lang.String helpTopicId)
          Sets the id used to look up a topic in a helpProvider.
 void setInlineStyle(java.lang.String inlineStyle)
          Sets the CSS styles to use for this component.
 void setLabel(java.lang.String label)
          Sets the label of the component.
 void setMaximumFiles(int maximumFiles)
          Sets an attribute that is used to restrict the number of files a user can upload.
 void setPartialTriggers(java.lang.String[] partialTriggers)
          Sets the IDs of the components that should trigger a partial update.
 void setReadOnly(boolean readOnly)
          Sets whether the control is displayed as an editable field or as an output-style text control.
 void setRows(int rows)
          Sets an attribute that determines the number of rows in the file list.
 void setShortDesc(java.lang.String shortDesc)
          Sets the short description of the component.
 void setShowRequired(boolean showRequired)
          Sets whether the associated control displays a visual indication of required user input.
 void setSimple(boolean simple)
          Sets a boolean value that controls whether the component provides label support; when set to "true", the component will not display the label (these may be ignored: label, labelAndAccessKey, accessKey, showRequired, help facet) and may use simpler layout primitives.
 void setStyleClass(java.lang.String styleClass)
          Sets a CSS style class to use for this component.
 void setUnsecure(java.util.Set<java.lang.String> unsecure)
          Sets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client.
 void setUploadType(java.lang.String uploadType)
          Sets an attribute that controls the upload behavior of the component.
 void setVisible(boolean visible)
          Sets the visibility of the component.

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXEditableValue
addValidator, addValueChangeListener, broadcast, compareValues, getConvertedValue, getRequiredMessageDetail, getRequiredMessageKey, getSubmittedValue, getValidator, getValidators, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, setImmediate, setLocalValueSet, setRequired, setRequiredMessageDetail, setSubmittedValue, setValid, setValidator, setValueChangeListener, shouldValidateEmptyFields, updateModel, validate, validateValue

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXValue
getConverter, getLocalValue, getValue, setConverter, setValue

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getComponentChangeFilters, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, queueEvent, removeAttributeChangeListener, removeComponentChangeFilter, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent
addPartialTarget, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree, visitTree

 

Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Methods inherited from interface javax.faces.component.ValueHolder
getConverter, getLocalValue, getValue, setConverter, setValue

 

Field Detail

EDITABLE_INHERIT

public static final java.lang.String EDITABLE_INHERIT
See Also:
Constant Field Values

EDITABLE_ALWAYS

public static final java.lang.String EDITABLE_ALWAYS
See Also:
Constant Field Values

EDITABLE_ON_ACCESS

public static final java.lang.String EDITABLE_ON_ACCESS
See Also:
Constant Field Values

UPLOAD_TYPE_SUBMIT

public static final java.lang.String UPLOAD_TYPE_SUBMIT
See Also:
Constant Field Values

UPLOAD_TYPE_AUTO

public static final java.lang.String UPLOAD_TYPE_AUTO
See Also:
Constant Field Values

UPLOAD_TYPE_MANUAL

public static final java.lang.String UPLOAD_TYPE_MANUAL
See Also:
Constant Field Values

UPLOAD_TYPE_AUTO_IF_MULTIPLE

public static final java.lang.String UPLOAD_TYPE_AUTO_IF_MULTIPLE
See Also:
Constant Field Values

UPLOAD_TYPE_MANUAL_IF_MULTIPLE

public static final java.lang.String UPLOAD_TYPE_MANUAL_IF_MULTIPLE
See Also:
Constant Field Values

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

CHANGED_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CHANGED_KEY

CHANGED_DESC_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CHANGED_DESC_KEY

AUTO_SUBMIT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey AUTO_SUBMIT_KEY

ACCESS_KEY_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey ACCESS_KEY_KEY

CONTENT_STYLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTENT_STYLE_KEY

HELP_TOPIC_ID_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey HELP_TOPIC_ID_KEY

DISABLED_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey DISABLED_KEY

LABEL_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey LABEL_KEY

READ_ONLY_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey READ_ONLY_KEY

SHOW_REQUIRED_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHOW_REQUIRED_KEY

SIMPLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SIMPLE_KEY

INLINE_STYLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY

STYLE_CLASS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY

SHORT_DESC_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY

UNSECURE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey UNSECURE_KEY

VISIBLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY

CUSTOMIZATION_ID_KEY

@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY
Deprecated. 

CLIENT_COMPONENT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY

CLIENT_ATTRIBUTES_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY

PARTIAL_TRIGGERS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY

CLIENT_LISTENERS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY

EDITABLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey EDITABLE_KEY

COLUMNS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey COLUMNS_KEY

UPLOAD_TYPE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey UPLOAD_TYPE_KEY

MAXIMUM_FILES_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey MAXIMUM_FILES_KEY

AUTO_HEIGHT_ROWS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey AUTO_HEIGHT_ROWS_KEY

ROWS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey ROWS_KEY

HELP_FACET

public static final java.lang.String HELP_FACET
See Also:
Constant Field Values

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

Constructor Detail

RichInputFile

public RichInputFile()
Construct an instance of the RichInputFile.

RichInputFile

protected RichInputFile(java.lang.String rendererType)
Construct an instance of the RichInputFile.

Method Detail

getHelp

public final javax.faces.component.UIComponent getHelp()
This facet is deprecated, helpTopicId should be used for providing help. This is a no-op for form components.

setHelp

public final void setHelp(javax.faces.component.UIComponent helpFacet)
This facet is deprecated, helpTopicId should be used for providing help. This is a no-op for form components.

isChanged

public final boolean isChanged()
Gets an attribute which if set to true, the changed indicator icon will be displayed on the component. This value defaults to false.
Returns:
the new changed value

setChanged

public final void setChanged(boolean changed)
Sets an attribute which if set to true, the changed indicator icon will be displayed on the component. This value defaults to false.
Parameters:
changed - the new changed value

getChangedDesc

public final java.lang.String getChangedDesc()
Gets the text commonly used by user agents to display tooltip text on the changed indicator icon. Default value is "Changed". The behavior of the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips.
Returns:
the new changedDesc value

setChangedDesc

public final void setChangedDesc(java.lang.String changedDesc)
Sets the text commonly used by user agents to display tooltip text on the changed indicator icon. Default value is "Changed". The behavior of the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips.
Parameters:
changedDesc - the new changedDesc value

isAutoSubmit

public final boolean isAutoSubmit()
Gets an attribute which if set to TRUE on a form element, the component will automatically submit when an appropriate action takes place (a click, text change, etc.). Since autoSubmit is a partial submit, also submitted and re-rendered are any other components with partialTriggers pointing to this component.
Returns:
the new autoSubmit value

setAutoSubmit

public final void setAutoSubmit(boolean autoSubmit)
Sets an attribute which if set to TRUE on a form element, the component will automatically submit when an appropriate action takes place (a click, text change, etc.). Since autoSubmit is a partial submit, also submitted and re-rendered are any other components with partialTriggers pointing to this component.
Parameters:
autoSubmit - the new autoSubmit value

getAccessKey

public final char getAccessKey()
Gets a character used to gain quick access to the form element specified by the for, if set (or this component itself, if it is a "non-simple" form element). For accessibility reasons, this functionality is not supported in screen reader mode. If the same access key appears in multiple locations in the same page of output, the rendering user agent will cycle among the elements accessed by the similar keys.

This attribute is sometimes referred to as the "mnemonic".

Note that the accessKey is triggered by browser-specific and platform-specific modifier keys. It even has browser-specific meaning. For example, Internet Explorer 7.0 will set focus when you press Alt+<accessKey>. Firefox 2.0 on some operating systems you press Alt+Shift+<accessKey>. Firefox 2.0 on other operating systems you press Control+<accessKey>. Refer to your browser's documentation for how it treats accessKey.

Returns:
the new accessKey value

setAccessKey

public final void setAccessKey(char accessKey)
Sets a character used to gain quick access to the form element specified by the for, if set (or this component itself, if it is a "non-simple" form element). For accessibility reasons, this functionality is not supported in screen reader mode. If the same access key appears in multiple locations in the same page of output, the rendering user agent will cycle among the elements accessed by the similar keys.

This attribute is sometimes referred to as the "mnemonic".

Note that the accessKey is triggered by browser-specific and platform-specific modifier keys. It even has browser-specific meaning. For example, Internet Explorer 7.0 will set focus when you press Alt+<accessKey>. Firefox 2.0 on some operating systems you press Alt+Shift+<accessKey>. Firefox 2.0 on other operating systems you press Control+<accessKey>. Refer to your browser's documentation for how it treats accessKey.

Parameters:
accessKey - the new accessKey value

getContentStyle

public final java.lang.String getContentStyle()
Gets the style of the content piece of the component. You can style width by setting this attribute like this: width: 100px.
Returns:
the new contentStyle value

setContentStyle

public final void setContentStyle(java.lang.String contentStyle)
Sets the style of the content piece of the component. You can style width by setting this attribute like this: width: 100px.
Parameters:
contentStyle - the new contentStyle value

getHelpTopicId

public final java.lang.String getHelpTopicId()
Gets the id used to look up a topic in a helpProvider.
Returns:
the new helpTopicId value

setHelpTopicId

public final void setHelpTopicId(java.lang.String helpTopicId)
Sets the id used to look up a topic in a helpProvider.
Parameters:
helpTopicId - the new helpTopicId value

isDisabled

public final boolean isDisabled()
Gets whether the element is disabled. Unlike a readonly component, a disabled component is unable to receive focus. If the component has the potential to have a scrollbar, and you want the user to be able to scroll through the component's text or values, use the 'readOnly' attribute, not the 'disabled' attribute.
Returns:
the new disabled value

setDisabled

public final void setDisabled(boolean disabled)
Sets whether the element is disabled. Unlike a readonly component, a disabled component is unable to receive focus. If the component has the potential to have a scrollbar, and you want the user to be able to scroll through the component's text or values, use the 'readOnly' attribute, not the 'disabled' attribute.
Parameters:
disabled - the new disabled value

getLabel

public final java.lang.String getLabel()
Gets the label of the component. If you want the label to appear above the control, use a panelFormLayout.
Returns:
the new label value

setLabel

public final void setLabel(java.lang.String label)
Sets the label of the component. If you want the label to appear above the control, use a panelFormLayout.
Parameters:
label - the new label value

isReadOnly

public final boolean isReadOnly()
Gets whether the control is displayed as an editable field or as an output-style text control. Unlike a disabled component, a readonly component is able to receive focus.
Returns:
the new readOnly value

setReadOnly

public final void setReadOnly(boolean readOnly)
Sets whether the control is displayed as an editable field or as an output-style text control. Unlike a disabled component, a readonly component is able to receive focus.
Parameters:
readOnly - the new readOnly value

isShowRequired

public final boolean isShowRequired()
Gets whether the associated control displays a visual indication of required user input. If a "required" attribute is also present, both the "required" attribute and the "showRequired" attribute must be false for the visual indication not to be displayed. An example of when it can be desirable to use the showRequired property is if you have a field that is initially empty and is required only if some other field on the page is touched.
Returns:
the new showRequired value

setShowRequired

public final void setShowRequired(boolean showRequired)
Sets whether the associated control displays a visual indication of required user input. If a "required" attribute is also present, both the "required" attribute and the "showRequired" attribute must be false for the visual indication not to be displayed. An example of when it can be desirable to use the showRequired property is if you have a field that is initially empty and is required only if some other field on the page is touched.
Parameters:
showRequired - the new showRequired value

isSimple

public final boolean isSimple()
Gets a boolean value that controls whether the component provides label support; when set to "true", the component will not display the label (these may be ignored: label, labelAndAccessKey, accessKey, showRequired, help facet) and may use simpler layout primitives. One of the usecases can be when the component is used in repeatable elements like in table, for-each etc., where label is not required.
Returns:
the new simple value

setSimple

public final void setSimple(boolean simple)
Sets a boolean value that controls whether the component provides label support; when set to "true", the component will not display the label (these may be ignored: label, labelAndAccessKey, accessKey, showRequired, help facet) and may use simpler layout primitives. One of the usecases can be when the component is used in repeatable elements like in table, for-each etc., where label is not required.
Parameters:
simple - the new simple value

getInlineStyle

public final java.lang.String getInlineStyle()
Gets the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.
Returns:
the new inlineStyle value

setInlineStyle

public final void setInlineStyle(java.lang.String inlineStyle)
Sets the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.
Parameters:
inlineStyle - the new inlineStyle value

getStyleClass

public final java.lang.String getStyleClass()
Gets a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.
Returns:
the new styleClass value

setStyleClass

public final void setStyleClass(java.lang.String styleClass)
Sets a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.
Parameters:
styleClass - the new styleClass value

getShortDesc

public final java.lang.String getShortDesc()
Gets the short description of the component. This text is commonly used by user agents to display tooltip help text, in which case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute it is recommended that helpTopicId is used as it is more flexible and is more accessibility-compliant.
Returns:
the new shortDesc value

setShortDesc

public final void setShortDesc(java.lang.String shortDesc)
Sets the short description of the component. This text is commonly used by user agents to display tooltip help text, in which case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute it is recommended that helpTopicId is used as it is more flexible and is more accessibility-compliant.
Parameters:
shortDesc - the new shortDesc value

getUnsecure

public final java.util.Set<java.lang.String> getUnsecure()
Gets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. Currently, this is supported only for the "disabled" attribute.
Returns:
the new unsecure value

setUnsecure

public final void setUnsecure(java.util.Set<java.lang.String> unsecure)
Sets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. Currently, this is supported only for the "disabled" attribute.
Parameters:
unsecure - the new unsecure value

isVisible

public final boolean isVisible()
Gets the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property.
Returns:
the new visible value

setVisible

public final void setVisible(boolean visible)
Sets the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property.
Parameters:
visible - the new visible value

getCustomizationId

@Deprecated
public final java.lang.String getCustomizationId()
Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
Gets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
Returns:
the new customizationId value

setCustomizationId

@Deprecated
public final void setCustomizationId(java.lang.String customizationId)
Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
Sets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
Parameters:
customizationId - the new customizationId value

isClientComponent

public final boolean isClientComponent()
Gets whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary.
Returns:
the new clientComponent value

setClientComponent

public final void setClientComponent(boolean clientComponent)
Sets whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary.
Parameters:
clientComponent - the new clientComponent value

getClientAttributes

public final java.util.Set getClientAttributes()
Gets a set of client attribute names.
Returns:
the new clientAttributes value

setClientAttributes

public final void setClientAttributes(java.util.Set clientAttributes)
Sets a set of client attribute names.
Parameters:
clientAttributes - the new clientAttributes value

getPartialTriggers

public final java.lang.String[] getPartialTriggers()
Gets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.
Returns:
the new partialTriggers value

setPartialTriggers

public final void setPartialTriggers(java.lang.String[] partialTriggers)
Sets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.
Parameters:
partialTriggers - the new partialTriggers value

getClientListeners

public final ClientListenerSet getClientListeners()
Gets a set of client listeners.
Returns:
the new clientListeners value

setClientListeners

public final void setClientListeners(ClientListenerSet clientListeners)
Sets a set of client listeners.
Parameters:
clientListeners - the new clientListeners value

getEditable

public final java.lang.String getEditable()
Gets the editable look and feel to use for input components. 'always' indicates that the input component should always look editable. 'onAccess' indicates that the input will only look editable when accessed (hover, focus). 'inherit' indicates that we want to use the component parent's setting. None of the ancestor components define 'always' or 'onAccess', then 'always' will be used.
Returns:
the new editable value

setEditable

public final void setEditable(java.lang.String editable)
Sets the editable look and feel to use for input components. 'always' indicates that the input component should always look editable. 'onAccess' indicates that the input will only look editable when accessed (hover, focus). 'inherit' indicates that we want to use the component parent's setting. None of the ancestor components define 'always' or 'onAccess', then 'always' will be used.
Parameters:
editable - the new editable value

getColumns

public final int getColumns()
Gets the size of the text control specified by the number of characters shown.The default value depends on the browser.
Returns:
the new columns value

setColumns

public final void setColumns(int columns)
Sets the size of the text control specified by the number of characters shown.The default value depends on the browser.
Parameters:
columns - the new columns value

getUploadType

public final java.lang.String getUploadType()
Gets an attribute that controls the upload behavior of the component. Depending on what value is used, the Upload button will appear to enable manual uploading of files or files will be upload automatically once added.
Returns:
the new uploadType value

setUploadType

public final void setUploadType(java.lang.String uploadType)
Sets an attribute that controls the upload behavior of the component. Depending on what value is used, the Upload button will appear to enable manual uploading of files or files will be upload automatically once added.
Parameters:
uploadType - the new uploadType value

getMaximumFiles

public final int getMaximumFiles()
Gets an attribute that is used to restrict the number of files a user can upload. If the user tries to upload more files than specified in maximumFiles then an error is returned. If maximumFiles is less than 1 then the number of files is unlimited.
Returns:
the new maximumFiles value

setMaximumFiles

public final void setMaximumFiles(int maximumFiles)
Sets an attribute that is used to restrict the number of files a user can upload. If the user tries to upload more files than specified in maximumFiles then an error is returned. If maximumFiles is less than 1 then the number of files is unlimited.
Parameters:
maximumFiles - the new maximumFiles value

getAutoHeightRows

public final int getAutoHeightRows()
Gets an attribute that specifies the number of rows used to size the component height. The default value is -1 (no auto-sizing for any number of rows).
Returns:
the new autoHeightRows value

setAutoHeightRows

public final void setAutoHeightRows(int autoHeightRows)
Sets an attribute that specifies the number of rows used to size the component height. The default value is -1 (no auto-sizing for any number of rows).
Parameters:
autoHeightRows - the new autoHeightRows value

getRows

public final int getRows()
Gets an attribute that determines the number of rows in the file list. There will be a scrollbar which will be displayed when the number of files exceeds this number.
Returns:
the new rows value

setRows

public final void setRows(int rows)
Sets an attribute that determines the number of rows in the file list. There will be a scrollbar which will be displayed when the number of files exceeds this number.
Parameters:
rows - the new rows value

getFamily

public java.lang.String getFamily()
Overrides:
getFamily in class org.apache.myfaces.trinidad.component.UIXInput

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
Overrides:
getBeanType in class org.apache.myfaces.trinidad.component.UIXInput

Skip navigation links

Oracle© Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 1 (11.1.1.7.0)
E10684-08


Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved.