oracle.adf.view.faces.component.core.output
Class CoreOutputFormatted

java.lang.Object
  javax.faces.component.UIComponent
      oracle.adf.view.faces.component.UIXComponent
          oracle.adf.view.faces.component.UIXComponentBase
              oracle.adf.view.faces.component.UIXValue
                  oracle.adf.view.faces.component.UIXOutput
                      oracle.adf.view.faces.component.core.output.CoreOutputFormatted

All Implemented Interfaces:

StateHolder, ValueHolder

public class CoreOutputFormatted

extends UIXOutput

The outputFormatted bean accepts a string in its "value" attribute containing a very limited set of HTML markup and outputs formatted results. It is not intended as anything near to a generic HTML output engine, and will never be such a bean. Developers needing full HTML output should use <f:verbatim> or <af:outputText> with escape="false".

What this bean does provide is a limited ability to use a single source for translated or user-provided formatted text without further parsing or filtering or dangerous constructs (e.g., Javascript), and with some hope of successful output to non-HTML displays. It also supports more attributes than an unescaped outputText tag - for example, it supports styleClass.

This component supports the following HTML markup:

• <br>
• <hr>
• <li>, <ol>, <ul>
• <p>
• <b>
• <i>
• <tt>
• <big>
• <small>
• <pre>
• <span>
• <a>

and the following entities:

• &lt;
• &gt;
• &amp;
• &reg;
• &copy;
• &nbsp;
• &quot;

Elements or entities other than these will be ignored. In addition, the CSS attributes ("class" and "style") and "href" are supported - all others are ignored.

No guarantee is made that the input HTML will be output without modification. For example, paragraph and list-item elements will always be closed even if left open in the input text. Other HTML markup may be replaced with output more appropriate to the current look-and-feel or user agent.

Note: The escaping rules are different in a .jspx file than they are in a .jsp file. See the example below.

Example:

            In a .jspx:
 
             <af:outputFormatted
               styleUsage="instruction"
               value="&lt;b>simple outputFormatted&lt;/b>"/>
 
            In a .jsp:
 
             <af:outputFormatted
               styleUsage="instruction"
               value="<b>simple outputFormatted</b>"/>

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static PropertyKey	INLINE_STYLE_KEY
static PropertyKey	ONCLICK_KEY
static PropertyKey	ONDBLCLICK_KEY
static PropertyKey	ONKEYDOWN_KEY
static PropertyKey	ONKEYPRESS_KEY
static PropertyKey	ONKEYUP_KEY
static PropertyKey	ONMOUSEDOWN_KEY
static PropertyKey	ONMOUSEMOVE_KEY
static PropertyKey	ONMOUSEOUT_KEY
static PropertyKey	ONMOUSEOVER_KEY
static PropertyKey	ONMOUSEUP_KEY
static PropertyKey	PARTIAL_TRIGGERS_KEY
static PropertyKey	SHORT_DESC_KEY
static PropertyKey	STYLE_CLASS_KEY
static java.lang.String	STYLE_USAGE_IN_CONTEXT_BRANDING This sets the style needed for the inContextBranding text.
static java.lang.String	STYLE_USAGE_INSTRUCTION This sets the style to AFInstructionText.
static PropertyKey	STYLE_USAGE_KEY
static java.lang.String	STYLE_USAGE_PAGE_STAMP This sets the style to the style needed for page stamps.
static FacesBean.Type	TYPE

Fields inherited from class oracle.adf.view.faces.component.UIXValue

CONVERTER_KEY, VALUE_KEY

Fields inherited from class oracle.adf.view.faces.component.UIXComponentBase

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Constructor Summary

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

Method Summary

protected FacesBean.Type	getBeanType()
java.lang.String	getFamily()
java.lang.String	getInlineStyle() Gets the inline CSS style for this element
java.lang.String	getOnclick() Gets an onclick Javascript handler.
java.lang.String	getOndblclick() Gets an ondblclick Javascript handler.
java.lang.String	getOnkeydown() Gets an onkeydown Javascript handler.
java.lang.String	getOnkeypress() Gets an onkeypress Javascript handler.
java.lang.String	getOnkeyup() Gets an onkeyup Javascript handler.
java.lang.String	getOnmousedown() Gets an onmousedown Javascript handler.
java.lang.String	getOnmousemove() Gets an onmousemove Javascript handler.
java.lang.String	getOnmouseout() Gets an onmouseout Javascript handler.
java.lang.String	getOnmouseover() Gets an onmouseover Javascript handler.
java.lang.String	getOnmouseup() Gets an onmouseup Javascript handler.
java.lang.String[]	getPartialTriggers() Gets the IDs of the components that should trigger a partial update.
java.lang.String	getShortDesc() Gets the short description of the bean.
java.lang.String	getStyleClass() Gets the CSS style class of the bean.
java.lang.String	getStyleUsage() Gets the style usage, intended to make it easier to put the correct style on the text.
void	setInlineStyle(java.lang.String inlineStyle) Sets the inline CSS style for this element
void	setOnclick(java.lang.String onclick) Sets an onclick Javascript handler.
void	setOndblclick(java.lang.String ondblclick) Sets an ondblclick Javascript handler.
void	setOnkeydown(java.lang.String onkeydown) Sets an onkeydown Javascript handler.
void	setOnkeypress(java.lang.String onkeypress) Sets an onkeypress Javascript handler.
void	setOnkeyup(java.lang.String onkeyup) Sets an onkeyup Javascript handler.
void	setOnmousedown(java.lang.String onmousedown) Sets an onmousedown Javascript handler.
void	setOnmousemove(java.lang.String onmousemove) Sets an onmousemove Javascript handler.
void	setOnmouseout(java.lang.String onmouseout) Sets an onmouseout Javascript handler.
void	setOnmouseover(java.lang.String onmouseover) Sets an onmouseover Javascript handler.
void	setOnmouseup(java.lang.String onmouseup) Sets an onmouseup Javascript handler.
void	setPartialTriggers(java.lang.String[] partialTriggers) Sets the IDs of the components that should trigger a partial update.
void	setShortDesc(java.lang.String shortDesc) Sets the short description of the bean.
void	setStyleClass(java.lang.String styleClass) Sets the CSS style class of the bean.
void	setStyleUsage(java.lang.String styleUsage) Sets the style usage, intended to make it easier to put the correct style on the text.

Methods inherited from class oracle.adf.view.faces.component.UIXValue

getConverter, getLocalValue, getValue, setConverter, setValue

Methods inherited from class oracle.adf.view.faces.component.UIXComponentBase

addAttributeChange, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcast, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getLocalClientId, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeFacesListener, restoreState, saveState, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

Methods inherited from class java.lang.Object

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

Field Detail

STYLE_USAGE_PAGE_STAMP

public static final java.lang.String STYLE_USAGE_PAGE_STAMP

This sets the style to the style needed for page stamps.

See Also:

Constant Field Values

STYLE_USAGE_INSTRUCTION

public static final java.lang.String STYLE_USAGE_INSTRUCTION

This sets the style to AFInstructionText.

See Also:

Constant Field Values

STYLE_USAGE_IN_CONTEXT_BRANDING

public static final java.lang.String STYLE_USAGE_IN_CONTEXT_BRANDING

This sets the style needed for the inContextBranding text.

See Also:

Constant Field Values

TYPE

public static final FacesBean.Type TYPE

STYLE_USAGE_KEY

public static final PropertyKey STYLE_USAGE_KEY

SHORT_DESC_KEY

public static final PropertyKey SHORT_DESC_KEY

PARTIAL_TRIGGERS_KEY

public static final PropertyKey PARTIAL_TRIGGERS_KEY

ONCLICK_KEY

public static final PropertyKey ONCLICK_KEY

ONDBLCLICK_KEY

public static final PropertyKey ONDBLCLICK_KEY

ONMOUSEDOWN_KEY

public static final PropertyKey ONMOUSEDOWN_KEY

ONMOUSEUP_KEY

public static final PropertyKey ONMOUSEUP_KEY

ONMOUSEOVER_KEY

public static final PropertyKey ONMOUSEOVER_KEY

ONMOUSEMOVE_KEY

public static final PropertyKey ONMOUSEMOVE_KEY

ONMOUSEOUT_KEY

public static final PropertyKey ONMOUSEOUT_KEY

ONKEYPRESS_KEY

public static final PropertyKey ONKEYPRESS_KEY

ONKEYDOWN_KEY

public static final PropertyKey ONKEYDOWN_KEY

ONKEYUP_KEY

public static final PropertyKey ONKEYUP_KEY

STYLE_CLASS_KEY

public static final PropertyKey STYLE_CLASS_KEY

INLINE_STYLE_KEY

public static final PropertyKey INLINE_STYLE_KEY

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

CoreOutputFormatted

public CoreOutputFormatted()

Construct an instance of the CoreOutputFormatted.

CoreOutputFormatted

protected CoreOutputFormatted(java.lang.String rendererType)

Construct an instance of the CoreOutputFormatted.

Method Detail

getStyleUsage

public final java.lang.String getStyleUsage()

Gets the style usage, intended to make it easier to put the correct style on the text. Set this attribute when the outputFormatted is for instruction text, page stamp text, or inContextBranding text. The valid values are "instruction" , "pageStamp", and "inContextBranding". If styleUsage and styleClass attributes are both set, the styleClass attribute takes precedence.

setStyleUsage

public final void setStyleUsage(java.lang.String styleUsage)

Sets the style usage, intended to make it easier to put the correct style on the text. Set this attribute when the outputFormatted is for instruction text, page stamp text, or inContextBranding text. The valid values are "instruction" , "pageStamp", and "inContextBranding". If styleUsage and styleClass attributes are both set, the styleClass attribute takes precedence.

getShortDesc

public final java.lang.String getShortDesc()

Gets the short description of the bean. This text is commonly used by user agents to display tooltip help text.

setShortDesc

public final void setShortDesc(java.lang.String shortDesc)

Sets the short description of the bean. This text is commonly used by user agents to display tooltip help text.

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.

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.

getOnclick

public final java.lang.String getOnclick()

Gets an onclick Javascript handler.

setOnclick

public final void setOnclick(java.lang.String onclick)

Sets an onclick Javascript handler.

getOndblclick

public final java.lang.String getOndblclick()

Gets an ondblclick Javascript handler.

setOndblclick

public final void setOndblclick(java.lang.String ondblclick)

Sets an ondblclick Javascript handler.

getOnmousedown

public final java.lang.String getOnmousedown()

Gets an onmousedown Javascript handler.

setOnmousedown

public final void setOnmousedown(java.lang.String onmousedown)

Sets an onmousedown Javascript handler.

getOnmouseup

public final java.lang.String getOnmouseup()

Gets an onmouseup Javascript handler.

setOnmouseup

public final void setOnmouseup(java.lang.String onmouseup)

Sets an onmouseup Javascript handler.

getOnmouseover

public final java.lang.String getOnmouseover()

Gets an onmouseover Javascript handler.

setOnmouseover

public final void setOnmouseover(java.lang.String onmouseover)

Sets an onmouseover Javascript handler.

getOnmousemove

public final java.lang.String getOnmousemove()

Gets an onmousemove Javascript handler.

setOnmousemove

public final void setOnmousemove(java.lang.String onmousemove)

Sets an onmousemove Javascript handler.

getOnmouseout

public final java.lang.String getOnmouseout()

Gets an onmouseout Javascript handler.

setOnmouseout

public final void setOnmouseout(java.lang.String onmouseout)

Sets an onmouseout Javascript handler.

getOnkeypress

public final java.lang.String getOnkeypress()

Gets an onkeypress Javascript handler.

setOnkeypress

public final void setOnkeypress(java.lang.String onkeypress)

Sets an onkeypress Javascript handler.

getOnkeydown

public final java.lang.String getOnkeydown()

Gets an onkeydown Javascript handler.

setOnkeydown

public final void setOnkeydown(java.lang.String onkeydown)

Sets an onkeydown Javascript handler.

getOnkeyup

public final java.lang.String getOnkeyup()

Gets an onkeyup Javascript handler.

setOnkeyup

public final void setOnkeyup(java.lang.String onkeyup)

Sets an onkeyup Javascript handler.

getStyleClass

public final java.lang.String getStyleClass()

Gets the CSS style class of the bean.

setStyleClass

public final void setStyleClass(java.lang.String styleClass)

Sets the CSS style class of the bean.

getInlineStyle

public final java.lang.String getInlineStyle()

Gets the inline CSS style for this element

setInlineStyle

public final void setInlineStyle(java.lang.String inlineStyle)

Sets the inline CSS style for this element

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class UIXOutput

getBeanType

protected FacesBean.Type getBeanType()

Overrides:

getBeanType in class UIXOutput