Oracle Fusion Middleware extensions for Applications Core API Reference
11g Release 1 (11.1.1.6)

E22562-03

oracle.apps.fnd.applcore.flex.ui.kff
Class KffComponent

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.UIXPanel
                  extended by oracle.adf.view.rich.component.rich.layout.RichPanelFormLayout
                      extended by oracle.apps.fnd.applcore.flex.dynamic.DynamicForm
                          extended by oracle.apps.fnd.applcore.flex.ui.kff.KffComponent
All Implemented Interfaces:
java.io.Serializable, javax.faces.component.StateHolder, KFFConstants, org.apache.myfaces.trinidad.component.FlattenedComponent

public class KffComponent
extends DynamicForm
implements org.apache.myfaces.trinidad.component.FlattenedComponent, KFFConstants, java.io.Serializable

See Also:
Serialized Form

Field Summary
static org.apache.myfaces.trinidad.bean.PropertyKey ACCESSOR_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey AUTOSUBMIT_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey CHANGED_KEY
           
static java.lang.String COMPONENT_TYPE
          component type.
static org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey DEFAULT_COMBINATION_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey DISABLED_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey FLATTEN_CHILDREN_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey FLEXFIELDTYPE_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey HELPTOPICID_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey IMMEDIATE_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey LABEL_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey READONLY_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey REQUIRED_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey SIMPLE_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey TABLE_MODE_KEY
           
static org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
           
static org.apache.myfaces.trinidad.bean.PropertyKey VALUE_CHANGE_LISTENER_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey WIDTH_KEY
           
 
Fields inherited from class oracle.apps.fnd.applcore.flex.dynamic.DynamicForm
CATEGORY, CATEGORY_KEY, DISPLAYHINT, EDITABLE_KEY, factories, FIELDORDER, VALUE_KEY
 
Fields inherited from class oracle.adf.view.rich.component.rich.layout.RichPanelFormLayout
CLIENT_ATTRIBUTES_KEY, CLIENT_COMPONENT_KEY, CLIENT_LISTENERS_KEY, COMPONENT_FAMILY, CUSTOMIZATION_ID_KEY, FIELD_WIDTH_KEY, FOOTER_FACET, INLINE_STYLE_KEY, LABEL_ALIGNMENT_KEY, LABEL_ALIGNMENT_START, LABEL_ALIGNMENT_TOP, LABEL_WIDTH_KEY, MAX_COLUMNS_KEY, PARTIAL_TRIGGERS_KEY, ROWS_KEY, SHORT_DESC_KEY, STYLE_CLASS_KEY, UNSECURE_KEY, VISIBLE_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
 
Fields inherited from interface oracle.apps.fnd.applcore.flex.ui.KFFConstants
BINDING_END, BINDING_ROW, BINDING_SEPARATOR, BINDING_START, BLANK_SPACE, CANCEL_BUTTON_ID, CHAR_TO_PIX, CLEAR_BUTTON_ID, CLIENT_EVENTS, COLON_SEPERATOR_WITH_SPACE, COLUMN_WIDTH, CONCAT_SEGMENT_ID, CONCATENATED_STORAGE, DEFAULT_ITER_RANGE_SIZE, FALSE_BINDING_EXPRESSION, FILTER_ACCESSOR, FILTER_CONDITIONS_HEADING, FILTER_CRITERIA, FILTER_DISABLED_IMAGE_SOURCE_PATH, FILTER_ENABLED_IMAGE_SOURCE_PATH, FILTER_IMAGE_ID, FILTER_KFF_NAME, FILTER_NAME, FILTER_SIN_ATTRIBUTE_NAME, FIN_ACCOUNT_FLEX_KFF_Segments, KFF_ATTR_DELIMITER, KFF_BUTTON_BAR_ID, KFF_BUTTON_DIM, KFF_BUTTON_ID, KFF_CONFIRM_RESET_POPUP_ID, KFF_CONFIRM_RESET_POPUP_TITLE_ICON_SOURCE_PATH, KFF_CRITERIA_NAME, KFF_DEFAULT_WIDTH, KFF_DISABLED_IMAGE_SOURCE_PATH, KFF_DOWN_IMAGE_SOURCE_PATH, KFF_ENABLED_IMAGE_SOURCE_PATH, KFF_HOVER_DISABLED_IMAGE_SOURCE_PATH, KFF_HOVER_DOWN_IMAGE_SOURCE_PATH, KFF_HOVER_ENABLED_IMAGE_SOURCE_PATH, KFF_HOVER_OVER_IMAGE_SOURCE_PATH, KFF_IMAGE_ID, KFF_ITER, KFF_OVER_IMAGE_SOURCE_PATH, KFF_PROP_CCID, KFF_PROP_FILTER, KFF_PROP_SEGMENT_NAME, KFF_PROP_STRUCTURE_ID, KFF_QUERY_BUTTON_ID, KFF_RESET_BUTTON_ID, KFF_RESULT_TABLE_ID, KFF_SEARCH_PANEL_ID, KFF_SEARCH_POPUP_ID, KFF_SPACER_ID, KFF_VALUE_HOLDER, KFF_VO_FETCH_SIZE, KFF_VO_MAX_FETCH_SIZE, KFF_VO_NAME, MASTER_ATTR_CONCAT_SUFFIX, MASTER_ATTR_DELIMITER_SUFFIX, MASTER_ATTR_PREFIX, MASTER_PROP_CCID, MASTER_PROP_STRUCTUREID, MAX_COL_WIDTH, MAX_ROWS_DISPLAYED, MIN_COLUMNS, MIN_TABLE_WIDTH, PROP_PREFIX, QUERY_ID, REQUIRED_INDICATOR, RESULT_TABLE_FETCH_SIZE, RESULT_TABLE_ROWS, SEARCH_BUTTON_ID, SELECT_BUTTON_ID, STRING_CODE_COMBINATION, STRING_DEFAULT, STRING_HORIZONTAL, STRING_KFF, STRING_KFF_FILTER, STRING_LABEL, STRING_MULTIHORIZONTAL, STRING_READ_ONLY, STRING_SINGLE, STRING_VERTICAL, TABLE_EDITMODE_CLICKTOEDIT, TRUE_BINDING_EXPRESSION
 
Constructor Summary
KffComponent()
           
 
Method Summary
 void changeTableBinding(javax.faces.component.UIComponent comp, java.lang.String[] newAttributeNames, boolean executeQuery)
           
 void createChildren(javax.faces.context.FacesContext context)
          check current row and generate UI components and bindings
 void decode(javax.faces.context.FacesContext context)
          to add parent as partial target
 java.lang.String getAccessor()
          Gets the accessor name.
 javax.el.ValueExpression getAutoSubmit()
          Gets the AutoSubmit attribute value associated with KFF
protected  org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
           
 javax.el.ValueExpression getChanged()
          Gets the Changed attribute value associated with KFF
protected  java.lang.String getClassName()
           
protected  java.lang.String getControlType(oracle.jbo.LocaleContext localCtx, oracle.jbo.AttributeDef def)
           
 javax.el.ValueExpression getDefaultCombination()
          Checks whether table mode is set.
 javax.el.ValueExpression getDisabled()
          Gets the Disabled attribute value associated with KFF
 java.lang.Object getFlexFieldType()
          Object for flexFieldType attribute of KFF.
 javax.el.ValueExpression getHelpTopicId()
          Gets the HelpTopicId associated with KFF
 javax.el.ValueExpression getImmediate()
          Gets the ReadOnly attribute value associated with KFF
 java.lang.String[] getKffPartialTriggers()
          Gets the PartialTrggers attribute value associated with KFF
 javax.el.ValueExpression getLabel()
          Checks whether table mode is set.
 KffModel getModel()
           
 javax.el.ValueExpression getReadOnly()
          Gets the ReadOnly attribute value associated with KFF
 javax.el.ValueExpression getRendered()
          Gets the Rendered attribute value associated with KFF
 javax.el.ValueExpression getRequired()
          Gets the Required attribute value associated with KFF
 javax.el.ValueExpression getSimple()
          Gets the Simple attribute value associated with KFF
protected  KffUIHandler getUIHandler()
           
 javax.el.MethodExpression getValueChangeListener()
          Gets the ValueChangeListener attribute value associated with KFF
 javax.el.ValueExpression getVisible()
          Gets the Visible attribute value associated with KFF
 java.lang.String getWidth()
          Gets the Width attribute value associated with KFF
 boolean isFlatteningChildren(javax.faces.context.FacesContext context)
          Checks whether this component need to flatten its children.
protected  void populateFactories()
           
<S> boolean
processFlattenedChildren(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.component.ComponentProcessingContext cpContext, org.apache.myfaces.trinidad.component.ComponentProcessor<S> childProcessor, S callbackContext)
          Implementation for ProcessFlattenChildren API for DescriptiveFlexfield component.
 void setAccessor(java.lang.String accessorName)
          Sets the accessor name.
 void setParent(javax.faces.component.UIComponent p)
           
 boolean skipAttributeDef(javax.faces.context.FacesContext context, oracle.jbo.uicli.binding.JUIteratorBinding iterator, oracle.jbo.AttributeDef def)
           
 
Methods inherited from class oracle.apps.fnd.applcore.flex.dynamic.DynamicForm
addFactory, addRowSetListener, afterCreateChildren, encodeBegin, getAttributeDefinitions, getBaseFactory, getCategory, getCategoryValue, getCurrentRow, getEditPermission, getFilteredAttributeDefinitions, getIterator, getLoggingPrefix, getValue, getViewId, isBindingChanged, isEditable, log, logFinest, loggingEnabled, loggingFinestEnabled, logMethod, logMethodFinest, releaseBindings, setBindingChanged, setCategory, setEditable, setValue
 
Methods inherited from class oracle.adf.view.rich.component.rich.layout.RichPanelFormLayout
getClientAttributes, getClientListeners, getCustomizationId, getFamily, getFieldWidth, getFooter, getInlineStyle, getLabelAlignment, getLabelWidth, getMaxColumns, getPartialTriggers, getRows, getShortDesc, getStyleClass, getUnsecure, isClientComponent, isVisible, setClientAttributes, setClientComponent, setClientListeners, setCustomizationId, setFieldWidth, setFooter, setInlineStyle, setLabelAlignment, setLabelWidth, setMaxColumns, setPartialTriggers, setRows, setShortDesc, setStyleClass, setUnsecure, setVisible
 
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decodeChildren, decodeChildrenImpl, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, 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
 

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE
component type.

See Also:
Constant Field Values

TYPE

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

ACCESSOR_KEY

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

LABEL_KEY

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

READONLY_KEY

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

IMMEDIATE_KEY

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

TABLE_MODE_KEY

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

AUTOSUBMIT_KEY

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

FLATTEN_CHILDREN_KEY

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

CUSTOMIZATION_KEY

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

VALUE_CHANGE_LISTENER_KEY

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

DISABLED_KEY

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

REQUIRED_KEY

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

WIDTH_KEY

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

FLEXFIELDTYPE_KEY

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

HELPTOPICID_KEY

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

SIMPLE_KEY

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

CHANGED_KEY

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

DEFAULT_COMBINATION_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey DEFAULT_COMBINATION_KEY
Constructor Detail

KffComponent

public KffComponent()
Method Detail

populateFactories

protected void populateFactories()
Overrides:
populateFactories in class DynamicForm

createChildren

public void createChildren(javax.faces.context.FacesContext context)
Description copied from class: DynamicForm
check current row and generate UI components and bindings

Overrides:
createChildren in class DynamicForm

decode

public void decode(javax.faces.context.FacesContext context)
to add parent as partial target

Overrides:
decode in class org.apache.myfaces.trinidad.component.UIXComponentBase
Parameters:
context - as FacesContext

getBeanType

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

setParent

public void setParent(javax.faces.component.UIComponent p)
Overrides:
setParent in class org.apache.myfaces.trinidad.component.UIXComponentBase

getModel

public KffModel getModel()

getUIHandler

protected KffUIHandler getUIHandler()

getClassName

protected java.lang.String getClassName()
Overrides:
getClassName in class DynamicForm

processFlattenedChildren

public <S> boolean processFlattenedChildren(javax.faces.context.FacesContext context,
                                            org.apache.myfaces.trinidad.component.ComponentProcessingContext cpContext,
                                            org.apache.myfaces.trinidad.component.ComponentProcessor<S> childProcessor,
                                            S callbackContext)
                                 throws java.io.IOException
Implementation for ProcessFlattenChildren API for DescriptiveFlexfield component.

Specified by:
processFlattenedChildren in interface org.apache.myfaces.trinidad.component.FlattenedComponent
Throws:
java.io.IOException

isFlatteningChildren

public boolean isFlatteningChildren(javax.faces.context.FacesContext context)
Checks whether this component need to flatten its children.

Specified by:
isFlatteningChildren in interface org.apache.myfaces.trinidad.component.FlattenedComponent
Parameters:
context - as FacesContext
Returns:
true if children need to be flatten

getControlType

protected java.lang.String getControlType(oracle.jbo.LocaleContext localCtx,
                                          oracle.jbo.AttributeDef def)
Overrides:
getControlType in class DynamicForm

getAccessor

public java.lang.String getAccessor()
Gets the accessor name.

Returns:
Accessor name as String

setAccessor

public void setAccessor(java.lang.String accessorName)
Sets the accessor name.

Parameters:
accessorName - accessor name

getLabel

public javax.el.ValueExpression getLabel()
Checks whether table mode is set.

Returns:
table mode as String

getDefaultCombination

public javax.el.ValueExpression getDefaultCombination()
Checks whether table mode is set.

Returns:
table mode as String

getValueChangeListener

public javax.el.MethodExpression getValueChangeListener()
Gets the ValueChangeListener attribute value associated with KFF

Returns:
returns valueChangeListener as a MethodExpression from the VALUE_CHANGE_LISTENER_KEY

getReadOnly

public javax.el.ValueExpression getReadOnly()
Gets the ReadOnly attribute value associated with KFF

Returns:
ValueExpression returns the expression for readOnly

getImmediate

public javax.el.ValueExpression getImmediate()
Gets the ReadOnly attribute value associated with KFF

Returns:
ValueExpression returns the expression for readOnly

getDisabled

public javax.el.ValueExpression getDisabled()
Gets the Disabled attribute value associated with KFF

Returns:
ValueExpression returns the expression for disabled

getChanged

public javax.el.ValueExpression getChanged()
Gets the Changed attribute value associated with KFF

Returns:
ValueExpression returns the expression for changed

getSimple

public javax.el.ValueExpression getSimple()
Gets the Simple attribute value associated with KFF

Returns:
ValueExpression returns the expression for simple

getHelpTopicId

public javax.el.ValueExpression getHelpTopicId()
Gets the HelpTopicId associated with KFF

Returns:
ValueExpression returns the expression for helpTopicId

getKffPartialTriggers

public java.lang.String[] getKffPartialTriggers()
Gets the PartialTrggers attribute value associated with KFF

Returns:
ValueExpression returns the expression for partialTriggers

getRendered

public javax.el.ValueExpression getRendered()
Gets the Rendered attribute value associated with KFF

Returns:
ValueExpression returns the expression for rendered

getAutoSubmit

public javax.el.ValueExpression getAutoSubmit()
Gets the AutoSubmit attribute value associated with KFF

Returns:
ValueExpression returns the expression for autoSubmit

getVisible

public javax.el.ValueExpression getVisible()
Gets the Visible attribute value associated with KFF

Returns:
ValueExpression returns the expression for visible

getWidth

public java.lang.String getWidth()
Gets the Width attribute value associated with KFF

Returns:
returns width as a String from the WIDTH_KEY if value is null, returns kff default width which is 30

getRequired

public javax.el.ValueExpression getRequired()
Gets the Required attribute value associated with KFF

Returns:
ValueExpression returns the expression for required

getFlexFieldType

public java.lang.Object getFlexFieldType()
Object for flexFieldType attribute of KFF.

Returns:
String as an object for KFF as "KFF"(which is value of STRING_KFF)

skipAttributeDef

public boolean skipAttributeDef(javax.faces.context.FacesContext context,
                                oracle.jbo.uicli.binding.JUIteratorBinding iterator,
                                oracle.jbo.AttributeDef def)
Overrides:
skipAttributeDef in class DynamicForm
Parameters:
context - is current FacesContextInstance
iterator - is iterator Binding
def - is AttributeDef
Returns:
boolean

changeTableBinding

public void changeTableBinding(javax.faces.component.UIComponent comp,
                               java.lang.String[] newAttributeNames,
                               boolean executeQuery)

Oracle Fusion Middleware extensions for Applications Core API Reference
11g Release 1 (11.1.1.6)

E22562-03

Copyright © 2012 Oracle. All Rights Reserved.