com.liferay.faces.alloy.component.inputsourcecode

Class InputSourceCodeBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIOutput

javax.faces.component.UIInput

javax.faces.component.html.HtmlInputText

com.liferay.faces.alloy.component.inputsourcecode.InputSourceCodeBase

All Implemented Interfaces:

com.liferay.faces.util.component.ClientComponent, com.liferay.faces.util.component.Styleable, EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.EditableValueHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

Direct Known Subclasses:

InputSourceCode

@Generated(value="com.liferay.alloy.tools.builder.FacesBuilder")
public abstract class InputSourceCodeBase
extends javax.faces.component.html.HtmlInputText
implements com.liferay.faces.util.component.Styleable, com.liferay.faces.util.component.ClientComponent

Author:

Bruno Basto, Kyle Stiemann

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	InputSourceCodeBase.InputSourceCodePropertyKeys

Nested classes/interfaces inherited from class javax.faces.component.html.HtmlInputText

javax.faces.component.html.HtmlInputText.PropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_TYPE
static String	RENDERER_TYPE

Fields inherited from class javax.faces.component.UIInput

COMPONENT_FAMILY, CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Fields inherited from interface com.liferay.faces.util.component.Styleable

STYLE, STYLE_CLASS

Fields inherited from interface com.liferay.faces.util.component.ClientComponent

CLIENT_KEY

Constructor Summary

Constructors

Constructor and Description
InputSourceCodeBase()

Method Summary

Methods

Modifier and Type	Method and Description
String	getClientKey() clientKey attribute description: The key name that can be used to reference the component on the client.
String	getHeight() height attribute description: The the height (in pixels) of the rendered <div>.
Boolean	getHighlightActiveLine() highlightActiveLine attribute description: When true, the background-color of the line that is being edited by the user (the active line) will change to indicate a highlight.
String	getLabel() label attribute description: A localized label for this component that is typically only rendered in a FacesMessage when validation fails.
String	getLocale() locale attribute description: The locale of the text that the editor is editing or displaying.
Integer	getMaxLines() maxLines attribute description: Specifies the maximum number of lines that the editor is to display before a vertical scrollbar appears.
Integer	getMinLines() minLines attribute description: Minimum number of lines that the editor is to display.
String	getMode() mode attribute description: The name of the programming language that the editor is editing or displaying.
Boolean	getReadOnly() readOnly attribute description: When this flag is true, the component will be read-only, meaning that the user will be unable to edit the source code text.
Boolean	getShowPrintMargin() showPrintMargin attribute description: When this flag is true, a vertical line will appear that indicates the print margin.
String	getStyleClass() styleClass attribute description: List of CSS class names (separated by spaces) that are to be rendered within the class attribute.
String	getTabSize() tabSize attribute description: The number of spaces that are to be displayed in place of each tab character.
Boolean	getUseSoftTabs() useSoftTabs attribute description: When this flag is true, the tab key will produce space characters rather than tab characters.
Boolean	getUseWrapMode() useWrapMode attribute description: When this flag is true, the line will break when it reaches the end of the line.
String	getWidth() width attribute description: The the width (in pixels) of the rendered <div>.
void	setClientKey(String clientKey) clientKey attribute description: The key name that can be used to reference the component on the client.
void	setHeight(String height) height attribute description: The the height (in pixels) of the rendered <div>.
void	setHighlightActiveLine(Boolean highlightActiveLine) highlightActiveLine attribute description: When true, the background-color of the line that is being edited by the user (the active line) will change to indicate a highlight.
void	setLocale(String locale) locale attribute description: The locale of the text that the editor is editing or displaying.
void	setMaxLines(Integer maxLines) maxLines attribute description: Specifies the maximum number of lines that the editor is to display before a vertical scrollbar appears.
void	setMinLines(Integer minLines) minLines attribute description: Minimum number of lines that the editor is to display.
void	setMode(String mode) mode attribute description: The name of the programming language that the editor is editing or displaying.
void	setReadOnly(Boolean readOnly) readOnly attribute description: When this flag is true, the component will be read-only, meaning that the user will be unable to edit the source code text.
void	setShowPrintMargin(Boolean showPrintMargin) showPrintMargin attribute description: When this flag is true, a vertical line will appear that indicates the print margin.
void	setTabSize(String tabSize) tabSize attribute description: The number of spaces that are to be displayed in place of each tab character.
void	setUseSoftTabs(Boolean useSoftTabs) useSoftTabs attribute description: When this flag is true, the tab key will produce space characters rather than tab characters.
void	setUseWrapMode(Boolean useWrapMode) useWrapMode attribute description: When this flag is true, the line will break when it reaches the end of the line.
void	setWidth(String width) width attribute description: The the width (in pixels) of the rendered <div>.

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

getAccesskey, getAlt, getAutocomplete, getDefaultEventName, getDir, getEventNames, getLang, getMaxlength, getOnblur, getOnchange, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnselect, getRole, getSize, getStyle, getTabindex, getTitle, isDisabled, isReadonly, setAccesskey, setAlt, setAutocomplete, setDir, setDisabled, setLabel, setLang, setMaxlength, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setReadonly, setRole, setSize, setStyle, setStyleClass, setTabindex, setTitle

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, clearInitialState, compareValues, decode, getConvertedValue, getConverterMessage, getFamily, 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

addClientBehavior, addFacesListener, broadcast, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.liferay.faces.util.component.Styleable

getStyle, setStyle, setStyleClass

Methods inherited from interface com.liferay.faces.util.component.ClientComponent

getClientId

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

addClientBehavior, 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

RENDERER_TYPE

public static final String RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

InputSourceCodeBase

public InputSourceCodeBase()

Method Detail

getClientKey

public String getClientKey()

clientKey attribute description:

The key name that can be used to reference the component on the client.

Specified by:

getClientKey in interface com.liferay.faces.util.component.ClientComponent

setClientKey

public void setClientKey(String clientKey)

clientKey attribute description:

The key name that can be used to reference the component on the client.

Specified by:

setClientKey in interface com.liferay.faces.util.component.ClientComponent

getHeight

public String getHeight()

height attribute description:

The the height (in pixels) of the rendered <div>.

setHeight

public void setHeight(String height)

height attribute description:

The the height (in pixels) of the rendered <div>.

getHighlightActiveLine

public Boolean getHighlightActiveLine()

highlightActiveLine attribute description:

When true, the background-color of the line that is being edited by the user (the active line) will change to indicate a highlight.

setHighlightActiveLine

public void setHighlightActiveLine(Boolean highlightActiveLine)

highlightActiveLine attribute description:

When true, the background-color of the line that is being edited by the user (the active line) will change to indicate a highlight.

getLabel

public String getLabel()

label attribute description:

A localized label for this component that is typically only rendered in a FacesMessage when validation fails.

Overrides:

getLabel in class javax.faces.component.html.HtmlInputText

getLocale

public String getLocale()

locale attribute description:

The locale of the text that the editor is editing or displaying.

setLocale

public void setLocale(String locale)

locale attribute description:

The locale of the text that the editor is editing or displaying.

getMaxLines

public Integer getMaxLines()

maxLines attribute description:

Specifies the maximum number of lines that the editor is to display before a vertical scrollbar appears.

setMaxLines

public void setMaxLines(Integer maxLines)

maxLines attribute description:

Specifies the maximum number of lines that the editor is to display before a vertical scrollbar appears.

getMinLines

public Integer getMinLines()

minLines attribute description:

Minimum number of lines that the editor is to display.

setMinLines

public void setMinLines(Integer minLines)

minLines attribute description:

Minimum number of lines that the editor is to display.

getMode

public String getMode()

mode attribute description:

The name of the programming language that the editor is editing or displaying.

setMode

public void setMode(String mode)

mode attribute description:

The name of the programming language that the editor is editing or displaying.

getReadOnly

public Boolean getReadOnly()

readOnly attribute description:

When this flag is true, the component will be read-only, meaning that the user will be unable to edit the source code text. The default value is false.

setReadOnly

public void setReadOnly(Boolean readOnly)

readOnly attribute description:

When this flag is true, the component will be read-only, meaning that the user will be unable to edit the source code text. The default value is false.

getShowPrintMargin

public Boolean getShowPrintMargin()

showPrintMargin attribute description:

When this flag is true, a vertical line will appear that indicates the print margin. The default value is true.

setShowPrintMargin

public void setShowPrintMargin(Boolean showPrintMargin)

showPrintMargin attribute description:

When this flag is true, a vertical line will appear that indicates the print margin. The default value is true.

getStyleClass

public String getStyleClass()

styleClass attribute description:

List of CSS class names (separated by spaces) that are to be rendered within the class attribute.

Specified by:

getStyleClass in interface com.liferay.faces.util.component.Styleable

Overrides:

getStyleClass in class javax.faces.component.html.HtmlInputText

getTabSize

public String getTabSize()

tabSize attribute description:

The number of spaces that are to be displayed in place of each tab character.

setTabSize

public void setTabSize(String tabSize)

tabSize attribute description:

The number of spaces that are to be displayed in place of each tab character.

getUseSoftTabs

public Boolean getUseSoftTabs()

useSoftTabs attribute description:

When this flag is true, the tab key will produce space characters rather than tab characters. The default value is false.

setUseSoftTabs

public void setUseSoftTabs(Boolean useSoftTabs)

useSoftTabs attribute description:

When this flag is true, the tab key will produce space characters rather than tab characters. The default value is false.

getUseWrapMode

public Boolean getUseWrapMode()

useWrapMode attribute description:

When this flag is true, the line will break when it reaches the end of the line. The default value is true.

setUseWrapMode

public void setUseWrapMode(Boolean useWrapMode)

useWrapMode attribute description:

When this flag is true, the line will break when it reaches the end of the line. The default value is true.

getWidth

public String getWidth()

width attribute description:

The the width (in pixels) of the rendered <div>.

setWidth

public void setWidth(String width)

width attribute description:

The the width (in pixels) of the rendered <div>.