Heading (Javlo 2 2.1 API)

java.lang.Object
- org.javlo.component.core.AbstractVisualComponent
- - org.javlo.component.properties.AbstractPropertiesComponent
  - - org.javlo.component.title.Heading

All Implemented Interfaces:

Comparable<IContentVisualComponent>, IContentVisualComponent, ISubTitle, IRestItem
```
public class Heading
extends AbstractPropertiesComponent
implements ISubTitle
```

Field Summary

Fields
Modifier and Type Field and Description

static String SMALL_TEXT

static String TEXT

static String TYPE
- Fields inherited from class org.javlo.component.properties.AbstractPropertiesComponent
  properties
- Fields inherited from class org.javlo.component.core.AbstractVisualComponent
  CACHE_KEY_SUFFIX_PARAM_NAME, COMPONENT_KEY, config, EDIT_CLASS, FORCE_COMPONENT_ID, HIDDEN, I18N_FILE, logger, NOT_EDIT_PREVIEW_PARAM_NAME, SCROLL_TO_COMP_ID_ATTRIBUTE_NAME, TIME_CACHE_NAME, VALUE_SEPARATOR
- Fields inherited from interface org.javlo.component.core.IContentVisualComponent
  COLORED_WRAPPER_CLASS, COMP_ID_REQUEST_PARAM, COMPLEXITY_ADMIN, COMPLEXITY_EASY, COMPLEXITY_STANDARD, CONTAINER_COLOR, DEFAULT_COLOR, DYN_COMP_COLOR, ECOM_COLOR, EDIT_ACTION_CSS_CLASS, GRAPHIC_COLOR, HIGH_LABEL_LEVEL, ID_SEPARATOR, LINK_COLOR, LOW_LABEL_LEVEL, META_COLOR, MIDDLE_LABEL_LEVEL, SEARCH_LEVEL_HIGH, SEARCH_LEVEL_LOW, SEARCH_LEVEL_MIDDLE, SEARCH_LEVEL_NONE, TEXT_COLOR, VIEW_DEFINITION_REQUEST_ID, WEB2_COLOR

Fields
Modifier and Type	Field and Description
`static String`	`SMALL_TEXT`
`static String`	`TEXT`
`static String`	`TYPE`

Constructor Summary

Constructors
Constructor and Description

Heading()

Constructors
Constructor and Description
`Heading()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getDepth(ContentContext ctx)`
`protected String`	`getEditXHTMLCode(ContentContext ctx)`
`List<String>`	`getFields(ContentContext ctx)`
`String`	`getFontAwesome()`
`protected String`	`getForcedPrefixViewXHTMLCode(ContentContext ctx)`
`String`	`getHexColor()` get the exadecimal color for representation of the component.
`protected String`	`getInlineStyle(ContentContext ctx)`
`int`	`getLabelLevel(ContentContext ctx)` define the level of label.
`int`	`getSearchLevel()` return the level of the component is a search.
`String`	`getSpecialPreviewCssId(ContentContext ctx)`
`String`	`getSubTitle(ContentContext ctx)`
`int`	`getSubTitleLevel(ContentContext ctx)`
`String`	`getSuffixViewXHTMLCode(ContentContext ctx)` code for sufix the view XHTML code.
`protected String`	`getTag(ContentContext ctx)`
`String`	`getTextLabel(ContentContext ctx)` return a string representation of the component
`String`	`getTextTitle(ContentContext ctx)` return a string representation of the component with complete title
`protected String`	`getTitle(ContentContext ctx)`
`String`	`getType()` return the type of the element.
`String`	`getViewXHTMLCode(ContentContext ctx)`
`String`	`getXHTMLConfig(ContentContext ctx)` xhtml code for config the component
`String`	`getXHTMLId(ContentContext ctx)`
`protected void`	`init()`
`void`	`init(ComponentBean bean, ContentContext newContext)`
`boolean`	`initContent(ContentContext ctx)` init the content with a default value. sample : "lorem ipsum" for text component.
`boolean`	`isContentCachable(ContentContext ctx)` return the part of header needed for this component
`boolean`	`isDefaultValue(ContentContext ctx)` return true if value is never modified.
`protected boolean`	`isHiddable()`
`boolean`	`isListable()` you display the composant as a list (if you want)
`boolean`	`isNoLinkable()`
`boolean`	`isRealContent(ContentContext ctx)` return true if component is considered as realContent and the page that contain the component is also considered as real content.
`protected boolean`	`isValueTranslatable()`
`static void`	`main(String[] args)`
`String`	`performEdit(ContentContext ctx)` action call when update the content page.
`void`	`prepareView(ContentContext ctx)` prepare the rendering of a component. default attributes put in request : style, value, type, compid

Methods inherited from class org.javlo.component.properties.AbstractPropertiesComponent
createKeyWithField, getContentAsMap, getContentAsText, getFieldDoubleValue, getFieldLongValue, getFieldName, getFieldType, getFieldValue, getFieldValue, getHeader, getListSeparator, getRowSize, getWordCount, setFieldValue, storeProperties, transflateFrom, validateField

Methods inherited from class org.javlo.component.core.AbstractVisualComponent
applyReplacement, cleanValue, clearReplacement, clone, compareTo, contructViewStyle, countLine, delete, deleteMySelf, equals, equals, executeCurrentRenderer, executeJSP, executeRenderer, executeRenderer, extractFieldsFromRenderer, getAjaxId, getArea, getAuthors, getBackgroundColor, getBaseHelpURL, getClassName, getComplexityLevel, getComponentBean, getComponentCSS, getComponentCssClass, getComponentId, getComponentLabel, getComponentPath, getConfig, getConfigMessage, getContainerPage, getContentCache, getContentMessage, getContentName, getContentTimeCache, getCookiesDisplayStatus, getCreationDate, getCSSStyle, getCurrentPage, getCurrentRenderer, getDebugHeader, getDefaultHelpURI, getDefaultRenderer, getDeleteDate, getDescription, getDisplayAsInputName, getDisplayMessage, getEditorComplexity, getEditText, getEmptyCode, getEmptyXHTMLCode, getErrorMessage, getErrorMessage, getExternalResources, getFirstPrefix, getForcedId, getForcedSuffixViewXHTMLCode, getFormName, getHeaderContent, getHelpType, getHelpURI, getHelpURL, getI18nEditableKeys, getId, getImportFolderPath, getImportFolderPath, getInputName, getInputNameRenderer, getInputNameRendererTitle, getItalicAndStrongLanguageMarkerList, getJSOnSubmit, getKey, getLastSufix, getLayout, getListClass, getListGroup, getListItemTag, getListTag, getLock, getMarkerList, getMessage, getMirrorWrapper, getModificationDate, getNextComponent, getPage, getPageDescription, getPrefixViewXHTMLCode, getPreviewAttributes, getPreviewCssClass, getPreviewCssId, getPreviousComponent, getQuotationLanguageMarkerList, getRemplacement, getRenderer, getRendererTitle, getRenderes, getRequestComponent, getSelectRendererXHTML, getSpecialInputTag, getSpecialPreviewCssClass, getSpecialTagTitle, getSpecialTagXHTML, getSpecificClass, getStyle, getStyleLabel, getStyleLabelList, getStyleList, getStyleTitle, getTextColor, getTextForSearch, getTextMessage, getTitleLevel, getTypeInputName, getValue, getValue, getVersion, getViewData, getViewDataFile, getViewID, getViewText, getWidth, getXHTMLCode, haveRight, includeComponentJSP, includePage, insert, isAjaxWrapper, isAskWidth, isAutoDeletable, isAutoRenderer, isBackgroundColored, isCanAddClass, isColored, isConfig, isContentCachableByQuery, isContentTimeCachable, isDispayEmptyXHTMLCode, isDisplayable, isDisplayHidden, isEditOnCreate, isFirstElementOfRepeatSequence, isFirstRepeated, isFreeInputLayout, isHelpURL, isHidden, isHiddenInMode, isInline, isInsertable, isList, isMetaTitle, isMirroredByDefault, isMirrorWrapped, isModify, isNeedDelete, isNeedRefresh, isNeedRenderer, isNew, isNextSame, isNextSame, isNolink, isPreviousSame, isPreviousSame, isRepeat, isRepeatable, isRestMatch, isReversedLink, isUnique, isValueProperties, isViewDataFile, isVisible, isVisible, isVisibleFromCookies, isWrapped, isXML, loadViewData, markAsNew, newInstance, next, onStyleChange, performConfig, performUpdate, previous, processView, renderViewXHTMLCode, replaceAllInContent, replaceInContent, resetContentCache, resetViewData, setBackgroundColor, setComponentBean, setContainerPage, setContentCache, setContentTimeCache, setDisplayHidden, setForcedId, setHidden, setHiddenInMode, setList, setMessage, setMirrorWrapped, setModify, setNeedRefresh, setNextComponent, setNolink, setPage, setPreviousComponent, setRenderer, setRepeat, setStyle, setTextColor, setValid, setValue, setWidth, stored, storeViewData, stringToReader, stringToReader, stringToStream, textToXHTML

Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TYPE
```
public static final String TYPE
```
    See Also:
    
    Constant Field Values
  - TEXT
```
public static final String TEXT
```
    See Also:
    
    Constant Field Values
  - SMALL_TEXT
```
public static final String SMALL_TEXT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Heading
```
public Heading()
```
- Method Detail
  - getType
```
public String getType()
```
    Description copied from interface: IContentVisualComponent
    
    return the type of the element.
    
    Specified by:
    
    getType in interface IContentVisualComponent
    
    Returns:
    
    the type of the element.
  - getFields
```
public List<String> getFields(ContentContext ctx)
                       throws Exception
```
    Specified by:
    
    getFields in class AbstractPropertiesComponent
    
    Throws:
    
    Exception
  - prepareView
```
public void prepareView(ContentContext ctx)
                 throws Exception
```
    Description copied from class: AbstractVisualComponent
    
    prepare the rendering of a component. default attributes put in request : style, value, type, compid
    
    Overrides:
    
    prepareView in class AbstractPropertiesComponent
    
    Throws:
    
    Exception
  - getEditXHTMLCode
```
protected String getEditXHTMLCode(ContentContext ctx)
                           throws Exception
```
    Overrides:
    
    getEditXHTMLCode in class AbstractPropertiesComponent
    
    Throws:
    
    Exception
  - getDepth
```
public int getDepth(ContentContext ctx)
```
  - getTextTitle
```
public String getTextTitle(ContentContext ctx)
```
    Description copied from interface: IContentVisualComponent
    
    return a string representation of the component with complete title
    
    Specified by:
    
    getTextTitle in interface IContentVisualComponent
    
    Overrides:
    
    getTextTitle in class AbstractVisualComponent
    
    Returns:
  - getTextLabel
```
public String getTextLabel(ContentContext ctx)
```
    Description copied from interface: IContentVisualComponent
    
    return a string representation of the component
    
    Specified by:
    
    getTextLabel in interface IContentVisualComponent
    
    Overrides:
    
    getTextLabel in class AbstractVisualComponent
  - getViewXHTMLCode
```
public String getViewXHTMLCode(ContentContext ctx)
                        throws Exception
```
    Overrides:
    
    getViewXHTMLCode in class AbstractPropertiesComponent
    
    Throws:
    
    Exception
  - getTitle
```
protected String getTitle(ContentContext ctx)
                   throws ServiceException,
                          Exception
```
    Throws:
    
    ServiceException
    
    Exception
  - getTag
```
protected String getTag(ContentContext ctx)
```
    Overrides:
    
    getTag in class AbstractVisualComponent
  - isListable
```
public boolean isListable()
```
    Description copied from interface: IContentVisualComponent
    
    you display the composant as a list (if you want)
    
    Specified by:
    
    isListable in interface IContentVisualComponent
    
    Overrides:
    
    isListable in class AbstractVisualComponent
    
    Returns:
    
    true if a text is listable
  - getSearchLevel
```
public int getSearchLevel()
```
    Description copied from interface: IContentVisualComponent
    
    return the level of the component is a search.
    
    Specified by:
    
    getSearchLevel in interface IContentVisualComponent
    
    Overrides:
    
    getSearchLevel in class AbstractVisualComponent
    
    Returns:
    
    1-LOW 2-MIDDLE 3-HIGH
  - getHexColor
```
public String getHexColor()
```
    Description copied from interface: IContentVisualComponent
    
    get the exadecimal color for representation of the component.
    
    Specified by:
    
    getHexColor in interface IContentVisualComponent
    
    Overrides:
    
    getHexColor in class AbstractVisualComponent
    
    Returns:
    
    a exadecimal color (sample : a5b499)
  - init
```
protected void init()
             throws ResourceNotFoundException
```
    Overrides:
    
    init in class AbstractVisualComponent
    
    Throws:
    
    ResourceNotFoundException
  - init
```
public void init(ComponentBean bean,
                 ContentContext newContext)
          throws Exception
```
    Overrides:
    
    init in class AbstractPropertiesComponent
    
    Throws:
    
    Exception
  - initContent
```
public boolean initContent(ContentContext ctx)
                    throws Exception
```
    Description copied from interface: IContentVisualComponent
    
    init the content with a default value. sample : "lorem ipsum" for text component.
    
    Specified by:
    
    initContent in interface IContentVisualComponent
    
    Overrides:
    
    initContent in class AbstractVisualComponent
    
    Returns:
    
    true if content is create.
    
    Throws:
    
    Exception
  - getSubTitle
```
public String getSubTitle(ContentContext ctx)
```
    Specified by:
    
    getSubTitle in interface ISubTitle
  - getSubTitleLevel
```
public int getSubTitleLevel(ContentContext ctx)
```
    Specified by:
    
    getSubTitleLevel in interface ISubTitle
  - getLabelLevel
```
public int getLabelLevel(ContentContext ctx)
```
    Description copied from interface: IContentVisualComponent
    
    define the level of label. If there area most than 1 level on page, the label of the page is the bigger level.
    
    Specified by:
    
    getLabelLevel in interface IContentVisualComponent
    
    Overrides:
    
    getLabelLevel in class AbstractVisualComponent
    
    Returns:
    
    0=default, no the components is'nt label.
  - getXHTMLId
```
public String getXHTMLId(ContentContext ctx)
```
    Specified by:
    
    getXHTMLId in interface ISubTitle
  - getInlineStyle
```
protected String getInlineStyle(ContentContext ctx)
```
    Overrides:
    
    getInlineStyle in class AbstractVisualComponent
  - getXHTMLConfig
```
public String getXHTMLConfig(ContentContext ctx)
                      throws Exception
```
    Description copied from interface: IContentVisualComponent
    
    xhtml code for config the component
    
    Specified by:
    
    getXHTMLConfig in interface IContentVisualComponent
    
    Overrides:
    
    getXHTMLConfig in class AbstractVisualComponent
    
    Returns:
    
    Throws:
    
    Exception
  - getSpecialPreviewCssId
```
public String getSpecialPreviewCssId(ContentContext ctx)
```
    Overrides:
    
    getSpecialPreviewCssId in class AbstractVisualComponent
  - isHiddable
```
protected boolean isHiddable()
```
    Overrides:
    
    isHiddable in class AbstractVisualComponent
  - getForcedPrefixViewXHTMLCode
```
protected String getForcedPrefixViewXHTMLCode(ContentContext ctx)
```
    Overrides:
    
    getForcedPrefixViewXHTMLCode in class AbstractVisualComponent
  - getSuffixViewXHTMLCode
```
public String getSuffixViewXHTMLCode(ContentContext ctx)
```
    Description copied from interface: IContentVisualComponent
    
    code for sufix the view XHTML code.
    
    Specified by:
    
    getSuffixViewXHTMLCode in interface IContentVisualComponent
    
    Overrides:
    
    getSuffixViewXHTMLCode in class AbstractVisualComponent
    
    Returns:
    
    XHTML code.
  - isRealContent
```
public boolean isRealContent(ContentContext ctx)
```
    Description copied from interface: IContentVisualComponent
    
    return true if component is considered as realContent and the page that contain the component is also considered as real content.
    
    Specified by:
    
    isRealContent in interface IContentVisualComponent
    
    Overrides:
    
    isRealContent in class AbstractPropertiesComponent
    
    Parameters:
    
    ctx - current context
    
    Returns:
  - isNoLinkable
```
public boolean isNoLinkable()
```
    Overrides:
    
    isNoLinkable in class AbstractVisualComponent
  - isContentCachable
```
public boolean isContentCachable(ContentContext ctx)
```
    Description copied from interface: IContentVisualComponent
    
    return the part of header needed for this component
    
    Specified by:
    
    isContentCachable in interface IContentVisualComponent
    
    Overrides:
    
    isContentCachable in class AbstractVisualComponent
    
    Returns:
  - performEdit
```
public String performEdit(ContentContext ctx)
                   throws Exception
```
    Description copied from interface: IContentVisualComponent
    
    action call when update the content page.
    
    Specified by:
    
    performEdit in interface IContentVisualComponent
    
    Overrides:
    
    performEdit in class AbstractPropertiesComponent
    
    Returns:
    
    the error message, null if no error
    
    Throws:
    
    Exception
  - isDefaultValue
```
public boolean isDefaultValue(ContentContext ctx)
```
    Description copied from interface: IContentVisualComponent
    
    return true if value is never modified.
    
    Specified by:
    
    isDefaultValue in interface IContentVisualComponent
    
    Overrides:
    
    isDefaultValue in class AbstractVisualComponent
    
    Returns:
    
    true if value contain default value.
  - getFontAwesome
```
public String getFontAwesome()
```
    Specified by:
    
    getFontAwesome in interface IContentVisualComponent
    
    Overrides:
    
    getFontAwesome in class AbstractVisualComponent
  - main
```
public static void main(String[] args)
```
  - isValueTranslatable
```
protected boolean isValueTranslatable()
```
    Overrides:
    
    isValueTranslatable in class AbstractVisualComponent

Class Heading

Field Summary

Fields inherited from class org.javlo.component.properties.AbstractPropertiesComponent

Fields inherited from class org.javlo.component.core.AbstractVisualComponent

Fields inherited from interface org.javlo.component.core.IContentVisualComponent

Constructor Summary

Method Summary

Methods inherited from class org.javlo.component.properties.AbstractPropertiesComponent

Methods inherited from class org.javlo.component.core.AbstractVisualComponent

Methods inherited from class java.lang.Object

Field Detail

TYPE

TEXT

SMALL_TEXT

Constructor Detail

Heading

Method Detail

getType

getFields

prepareView

getEditXHTMLCode

getDepth

getTextTitle

getTextLabel

getViewXHTMLCode

getTitle

getTag

isListable

getSearchLevel

getHexColor

init

init

initContent

getSubTitle

getSubTitleLevel

getLabelLevel

getXHTMLId

getInlineStyle

getXHTMLConfig

getSpecialPreviewCssId

isHiddable

getForcedPrefixViewXHTMLCode

getSuffixViewXHTMLCode

isRealContent

isNoLinkable

isContentCachable

performEdit

isDefaultValue

getFontAwesome

main

isValueTranslatable