org.apache.myfaces.custom.inputHtml
Class InputHtml

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIOutput
              javax.faces.component.UIInput
                  javax.faces.component.html.HtmlInputText
                      org.apache.myfaces.component.html.ext.AbstractHtmlInputText
                          org.apache.myfaces.component.html.ext.HtmlInputText
                              org.apache.myfaces.custom.inputHtml.InputHtml

All Implemented Interfaces:

EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.EditableValueHolder, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.UniqueIdVendor, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, org.apache.myfaces.component.AlignProperty, org.apache.myfaces.component.DataProperties, org.apache.myfaces.component.DisplayValueOnlyAware, org.apache.myfaces.component.ForceIdAware, org.apache.myfaces.component.UserRoleAware, org.apache.myfaces.shared_tomahawk.component.DisplayValueOnlyCapable

@JSFComponent(name="t:inputHtml",
              tagClass="org.apache.myfaces.custom.inputHtml.InputHtmlTag",
              composite=true)
public class InputHtml
extends org.apache.myfaces.component.html.ext.HtmlInputText
implements javax.faces.component.NamingContainer, javax.faces.component.UniqueIdVendor

HTML Editor using the kupu library. http://kupu.oscom.org/ An inline HTML based word processor based on the Kupu library. See http://kupu.oscom.org Right now, the support is limited to one editor per page (but you can use tabs to have multiple editors, but only one rendered at a time). Unless otherwise specified, all attributes accept static values or EL expressions.

Version:

$Revision: 673833 $ $Date: 2008-07-03 16:58:05 -0500 (jue, 03 jul 2008) $

Author:

Sylvain Vieujot (latest modification by $Author: skitching $)

Nested Class Summary

protected static class

InputHtml.PropertyKeys

Field Summary

static String	COMPONENT_TYPE
static String	DEFAULT_RENDERER_TYPE

Fields inherited from class org.apache.myfaces.component.html.ext.HtmlInputText

COMPONENT_FAMILY

Fields inherited from class javax.faces.component.UIInput

CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME

Fields 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

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Fields inherited from interface org.apache.myfaces.component.UserRoleAware

ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR

Fields inherited from interface org.apache.myfaces.shared_tomahawk.component.DisplayValueOnlyCapable

DISPLAY_VALUE_ONLY_ATTR, DISPLAY_VALUE_ONLY_STYLE_ATTR, DISPLAY_VALUE_ONLY_STYLE_CLASS_ATTR

Constructor Summary

InputHtml()

Method Summary

String	createUniqueId(javax.faces.context.FacesContext context, String seed)
String	getDisplayValueOnlyText()
String	getEncodedText()
String	getFallback() Use a text area instead of the javascript HTML editor.
String	getFallbackText()
String	getFormId()
String	getHiddenText()
String	getKupuConfig()
String	getType() The type of the value.
String	getValueAsHtmlDocument(javax.faces.context.FacesContext context)
String	getValueFromDocument(String text)
boolean	isAddKupuLogo() Show the Kupu Logo in the buttons bar.
boolean	isAllowEditSource() Allows the user to edit the HTML source code.
boolean	isAllowExternalLinks() Allows the user to insert external links.
boolean	isShowAllToolBoxes() Shortcut to avoid setting all the showXXToolBox to true.
boolean	isShowAnyToolBox()
boolean	isShowCleanupExpressionsToolBox() Show the Cleanup Expressions tool box next to the text.
boolean	isShowDebugToolBox() Show the Debug tool box next to the text.
boolean	isShowImagesToolBox() Show the Images tool box next to the text.
boolean	isShowLinksToolBox() Show the Links tool box next to the text.
boolean	isShowPropertiesToolBox() Show the Properties tool box next to the text.
boolean	isShowTablesToolBox() Show the Tables tool box next to the text.
boolean	isTypeDocument()
void	processEvent(javax.faces.event.ComponentSystemEvent event)
void	setAddKupuLogo(boolean addKupuLogo)
void	setAllowEditSource(boolean allowEditSource)
void	setAllowExternalLinks(boolean allowExternalLinks)
void	setFallback(String _fallback)
void	setRendererType(String rendererType)
void	setShowAllToolBoxes(boolean showAllToolBoxes)
void	setShowCleanupExpressionsToolBox(boolean showCleanupExpressionsToolBox)
void	setShowDebugToolBox(boolean showTablesToolBox)
void	setShowImagesToolBox(boolean showImagesToolBox)
void	setShowLinksToolBox(boolean showLinksToolBox)
void	setShowPropertiesToolBox(boolean showPropertiesToolBox)
void	setShowTablesToolBox(boolean showTablesToolBox)
void	setType(String _type)

Methods inherited from class org.apache.myfaces.component.html.ext.HtmlInputText

addClientBehavior, getAccesskey, getAlign, getAlt, getAutocomplete, getDatafld, getDataformatas, getDatasrc, getDir, getDisplayValueOnly, getDisplayValueOnlyStyle, getDisplayValueOnlyStyleClass, getEnabledOnUserRole, getFamily, getLabel, getLang, getMaxlength, getOnblur, getOnchange, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnselect, getSize, getStyle, getStyleClass, getTabindex, getTitle, getVisibleOnUserRole, isDisabled, isDisabledOnClientSide, isForceId, isForceIdIndex, isReadonly, setAccesskey, setAlign, setAlt, setAutocomplete, setDatafld, setDataformatas, setDatasrc, setDir, setDisabled, setDisabledOnClientSide, setDisplayValueOnly, setDisplayValueOnlyStyle, setDisplayValueOnlyStyleClass, setEnabledOnUserRole, setForceId, setForceIdIndex, setLabel, setLang, setMaxlength, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setReadonly, setSize, setStyle, setStyleClass, setTabindex, setTitle, setValueBinding, setValueExpression, setVisibleOnUserRole

Methods inherited from class org.apache.myfaces.component.html.ext.AbstractHtmlInputText

getClientId, isDisplayValueOnly, isRendered, isSetDisplayValueOnly, setDisplayValueOnly

Methods inherited from class javax.faces.component.html.HtmlInputText

getDefaultEventName, getEventNames

Methods 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, restoreState, saveState, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel, validate, validateValue

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, setConverter

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, invokeOnComponent, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setTransient, visitTree

Methods inherited from class javax.faces.component.UIComponent

getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, pushComponentToEL, setInView, subscribeToEvent, unsubscribeFromEvent

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.behavior.ClientBehaviorHolder

getClientBehaviors

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, getLocalValue, setConverter

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

DEFAULT_RENDERER_TYPE

public static final String DEFAULT_RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

InputHtml

public InputHtml()

Method Detail

setRendererType

public void setRendererType(String rendererType)

Overrides:

setRendererType in class javax.faces.component.UIComponentBase

processEvent

public void processEvent(javax.faces.event.ComponentSystemEvent event)

Specified by:

processEvent in interface javax.faces.event.ComponentSystemEventListener

Overrides:

processEvent in class javax.faces.component.UIComponent

getKupuConfig

public String getKupuConfig()

getDisplayValueOnlyText

public String getDisplayValueOnlyText()

getFallbackText

public String getFallbackText()

getHiddenText

public String getHiddenText()

getFormId

public String getFormId()

getEncodedText

public String getEncodedText()

createUniqueId

public String createUniqueId(javax.faces.context.FacesContext context,
                             String seed)

Specified by:

createUniqueId in interface javax.faces.component.UniqueIdVendor

Since:

2.0

getFallback

public String getFallback()

Use a text area instead of the javascript HTML editor. Default is false. Use with caution.

setFallback

public void setFallback(String _fallback)

getType

public String getType()

The type of the value. It can be either fragment for an HTML fragment (default) or document for a full HTML document, with head, title, body, ... tags.

setType

public void setType(String _type)

isTypeDocument

public boolean isTypeDocument()

isAllowEditSource

public boolean isAllowEditSource()

Allows the user to edit the HTML source code. Default is true.

setAllowEditSource

public void setAllowEditSource(boolean allowEditSource)

isAllowExternalLinks

public boolean isAllowExternalLinks()

Allows the user to insert external links. Default is true.

setAllowExternalLinks

public void setAllowExternalLinks(boolean allowExternalLinks)

isAddKupuLogo

public boolean isAddKupuLogo()

Show the Kupu Logo in the buttons bar. Default is true.

setAddKupuLogo

public void setAddKupuLogo(boolean addKupuLogo)

isShowAllToolBoxes

public boolean isShowAllToolBoxes()

Shortcut to avoid setting all the showXXToolBox to true. Default is false.

setShowAllToolBoxes

public void setShowAllToolBoxes(boolean showAllToolBoxes)

isShowPropertiesToolBox

public boolean isShowPropertiesToolBox()

Show the Properties tool box next to the text. Default is false.

setShowPropertiesToolBox

public void setShowPropertiesToolBox(boolean showPropertiesToolBox)

isShowLinksToolBox

public boolean isShowLinksToolBox()

Show the Links tool box next to the text. Default is false.

setShowLinksToolBox

public void setShowLinksToolBox(boolean showLinksToolBox)

isShowImagesToolBox

public boolean isShowImagesToolBox()

Show the Images tool box next to the text. Default is false.

setShowImagesToolBox

public void setShowImagesToolBox(boolean showImagesToolBox)

isShowTablesToolBox

public boolean isShowTablesToolBox()

Show the Tables tool box next to the text. Default is false.

setShowTablesToolBox

public void setShowTablesToolBox(boolean showTablesToolBox)

isShowCleanupExpressionsToolBox

public boolean isShowCleanupExpressionsToolBox()

Show the Cleanup Expressions tool box next to the text. Default is false.

setShowCleanupExpressionsToolBox

public void setShowCleanupExpressionsToolBox(boolean showCleanupExpressionsToolBox)

isShowDebugToolBox

public boolean isShowDebugToolBox()

Show the Debug tool box next to the text. Default is false.

setShowDebugToolBox

public void setShowDebugToolBox(boolean showTablesToolBox)

isShowAnyToolBox

public boolean isShowAnyToolBox()

getValueAsHtmlDocument

public String getValueAsHtmlDocument(javax.faces.context.FacesContext context)

getValueFromDocument

public String getValueFromDocument(String text)