Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.myfaces.custom.inputHtml
Class InputHtml

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIOutput
              extended by javax.faces.component.UIInput
                  extended by javax.faces.component.html.HtmlInputText
                      extended by org.apache.myfaces.component.html.ext.AbstractHtmlInputText
                          extended by org.apache.myfaces.component.html.ext.HtmlInputText
                              extended by org.apache.myfaces.custom.inputHtml.InputHtml
All Implemented Interfaces:
javax.faces.component.EditableValueHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder, AlignProperty, DataProperties, DisplayValueOnlyAware, ForceIdAware, UserRoleAware, org.apache.myfaces.shared_tomahawk.component.DisplayValueOnlyCapable
public class InputHtml
extends org.apache.myfaces.component.html.ext.HtmlInputText

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 (Thu, 03 Jul 2008) $
Author:
Sylvain Vieujot (latest modification by $Author: skitching $)

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
 
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 getFallback()
          Use a text area instead of the javascript HTML editor.
 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 restoreState(javax.faces.context.FacesContext context, Object state)
           
 Object saveState(javax.faces.context.FacesContext context)
           
 void setAddKupuLogo(boolean addKupuLogo)
           
 void setAllowEditSource(boolean allowEditSource)
           
 void setAllowExternalLinks(boolean allowExternalLinks)
           
 void setFallback(String _fallback)
           
 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
getAlign, getAutocomplete, getDatafld, getDataformatas, getDatasrc, getDisplayValueOnly, getDisplayValueOnlyStyle, getDisplayValueOnlyStyleClass, getEnabledOnUserRole, getFamily, getVisibleOnUserRole, isDisabledOnClientSide, isForceId, isForceIdIndex, setAlign, setAutocomplete, setDatafld, setDataformatas, setDatasrc, setDisabledOnClientSide, setDisplayValueOnly, setDisplayValueOnlyStyle, setDisplayValueOnlyStyleClass, setEnabledOnUserRole, setForceId, setForceIdIndex, 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
getAccesskey, getAlt, getDir, getLang, getMaxlength, getOnblur, getOnchange, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnselect, getSize, getStyle, getStyleClass, getTabindex, getTitle, isDisabled, isReadonly, setAccesskey, setAlt, setDir, setDisabled, setLang, setMaxlength, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setReadonly, setSize, setStyle, setStyleClass, setTabindex, setTitle
 
Methods inherited from class javax.faces.component.UIInput
addValidator, addValueChangeListener, broadcast, compareValues, decode, getConvertedValue, getSubmittedValue, getValidator, getValidators, getValue, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, setImmediate, setLocalValueSet, setRequired, setSubmittedValue, setValid, setValidator, 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, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface javax.faces.component.ValueHolder
getConverter, getLocalValue, 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

saveState

public Object saveState(javax.faces.context.FacesContext context)
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class org.apache.myfaces.component.html.ext.HtmlInputText

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         Object state)
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class org.apache.myfaces.component.html.ext.HtmlInputText

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)
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2012 The Apache Software Foundation. All Rights Reserved.