Head (Struts 2 jQuery Plugin 4.0.3 API)

java.lang.Object
- org.apache.struts2.components.Component
- - org.apache.struts2.components.UIBean
  - - org.apache.struts2.components.Head
    - - com.jgeppert.struts2.jquery.components.Head

```
public class Head
extends org.apache.struts2.components.Head
```
The "head" tag renders required JavaScript code to configure jQuery and is required in order to use any of the tags included in the jQuery plugin.

Some tags like the "datepicker" can use different locales, to use a locale that is different from the request locale.

The "locale" attribute configures jQuery locale for datepicker. Default is "en" you can use all locales that are bundled with jQuery. e.g. "de, "fr", " ja", ...

Examples
```
 <%@ taglib prefix="sj" uri="/struts-jquery-tags" %>
 <head>
   <title>My page</title>
   <sj:head/>
 </head>
 
```
```
 <%@ taglib prefix="sj" uri="/struts-jquery-tags" %>
 <head>
   <title>My page</title>
   <sj:head compressed="false" locale="de" jquerytheme="cupertino"/>
 </head>
 
```
Author:

Johannes Geppert

Field Summary

Fields
Modifier and Type	Field	Description
`protected String`	`ajaxcache`
`protected String`	`ajaxhistory`
`protected String`	`compressed`
`protected String`	`customBasepath`
`protected String`	`debug`
`protected String`	`defaultErrorText`
`protected String`	`defaultIndicator`
`protected String`	`defaultLoadingText`
`protected String`	`jquery`
`protected String`	`jquerytheme`
`protected String`	`jqueryui`
`protected String`	`loadAtOnce`
`protected String`	`loadFromGoogle`
`protected String`	`locale`
`protected String`	`scriptPath`
`static String`	`TEMPLATE`

Fields inherited from class org.apache.struts2.components.Component
actionMapper, COMPONENT_STACK, devMode, parameters, stack, standardAttributesMap, throwExceptionOnELFailure

Fields inherited from class org.apache.struts2.components.UIBean
accesskey, cssClass, cssErrorClass, cssErrorStyle, cssStyle, defaultTemplateDir, defaultUITheme, disabled, dynamicAttributes, errorPosition, id, javascriptTooltip, key, label, labelPosition, labelSeparator, name, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onmousedown, onmousemove, onmouseout, onmouseover, onmouseup, onselect, request, requiredLabel, requiredPosition, response, tabindex, template, templateDir, templateEngineManager, templateSuffix, theme, title, tooltip, tooltipConfig, tooltipCssClass, tooltipDelay, tooltipIconPath, uiThemeExpansionToken, value

Constructor Summary

Constructors
Constructor	Description
`Head(com.opensymphony.xwork2.util.ValueStack stack, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`evaluateParams()`
`protected String`	`getDefaultTemplate()`
`String`	`getTheme()`
`boolean`	`isJqueryui()`
`void`	`setAjaxcache(String ajaxcache)`
`void`	`setAjaxhistory(String ajaxhistory)`
`void`	`setCompressed(String compressed)`
`void`	`setCustomBasepath(String customBasepath)`
`void`	`setDebug(String debug)`
`void`	`setDefaultErrorText(String defaultErrorText)`
`void`	`setDefaultIndicator(String defaultIndicator)`
`void`	`setDefaultLoadingText(String defaultLoadingText)`
`void`	`setDefaultLocale(String val)`
`void`	`setJquery(String jquery)`
`void`	`setJquerytheme(String jquerytheme)`
`void`	`setJqueryui(String jqueryui)`
`void`	`setLoadAtOnce(String loadAtOnce)`
`void`	`setLoadFromGoogle(String loadFromGoogle)`
`void`	`setLocale(String locale)`
`void`	`setScriptPath(String scriptPath)`
`void`	`setTheme(String theme)`

Methods inherited from class org.apache.struts2.components.Component
addAllParameters, addParameter, altSyntax, completeExpressionIfAltSyntax, determineActionURL, determineNamespace, end, fieldError, findAncestor, findString, findString, findStringIfAltSyntax, findValue, findValue, findValue, getComponentStack, getParameters, getStack, getStandardAttributes, isValidTagAttribute, popComponentStack, setActionMapper, setDevMode, setThrowExceptionsOnELFailure, setUrlHelper, start, stripExpressionIfAltSyntax, toString, usesBody

Methods inherited from class org.apache.struts2.components.Head
setEncoding

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

Methods inherited from class org.apache.struts2.components.UIBean
addFormParameter, buildTemplateName, copyParams, enableAncestorFormCustomOnsubmit, end, ensureAttributeSafelyNotEscaped, escape, evaluateExtraParams, evaluateNameValue, getId, getTemplate, getTemplateDir, getTooltipConfig, getValueClassType, mergeTemplate, populateComponentHtmlId, setAccesskey, setClass, setCssClass, setCssErrorClass, setCssErrorStyle, setCssStyle, setDefaultTemplateDir, setDefaultUITheme, setDisabled, setDynamicAttributes, setErrorPosition, setId, setJavascriptTooltip, setKey, setLabel, setLabelposition, setLabelSeparator, setName, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setRequiredLabel, setRequiredPosition, setStyle, setTabindex, setTemplate, setTemplateDir, setTemplateEngineManager, setTitle, setTooltip, setTooltipConfig, setTooltipCssClass, setTooltipDelay, setTooltipIconPath, setUIThemeExpansionToken, setValue

Field Detail

TEMPLATE
```
public static final String TEMPLATE
```
See Also:

Constant Field Values

compressed
```
protected String compressed
```

locale
```
protected String locale
```

jquery
```
protected String jquery
```

jquerytheme
```
protected String jquerytheme
```

jqueryui
```
protected String jqueryui
```

customBasepath
```
protected String customBasepath
```

loadFromGoogle
```
protected String loadFromGoogle
```

ajaxcache
```
protected String ajaxcache
```

ajaxhistory
```
protected String ajaxhistory
```

defaultIndicator
```
protected String defaultIndicator
```

defaultLoadingText
```
protected String defaultLoadingText
```

defaultErrorText
```
protected String defaultErrorText
```

loadAtOnce
```
protected String loadAtOnce
```

debug
```
protected String debug
```

scriptPath
```
protected String scriptPath
```

Constructor Detail

Head

public Head(com.opensymphony.xwork2.util.ValueStack stack,
            javax.servlet.http.HttpServletRequest request,
            javax.servlet.http.HttpServletResponse response)

Method Detail

getDefaultTemplate
```
protected String getDefaultTemplate()
```
Overrides:

getDefaultTemplate in class org.apache.struts2.components.Head

evaluateParams
```
public void evaluateParams()
```
Overrides:

evaluateParams in class org.apache.struts2.components.Head

setDefaultLocale

public void setDefaultLocale(String val)

setTheme
```
public void setTheme(String theme)
```
Overrides:

setTheme in class org.apache.struts2.components.UIBean

getTheme
```
public String getTheme()
```
Overrides:

getTheme in class org.apache.struts2.components.UIBean

setJquery

public void setJquery(String jquery)

isJqueryui
```
public boolean isJqueryui()
```

setJqueryui

public void setJqueryui(String jqueryui)

setCompressed

public void setCompressed(String compressed)

setJquerytheme

public void setJquerytheme(String jquerytheme)

setLocale

public void setLocale(String locale)

setCustomBasepath

public void setCustomBasepath(String customBasepath)

setLoadFromGoogle

public void setLoadFromGoogle(String loadFromGoogle)

setAjaxcache

public void setAjaxcache(String ajaxcache)

setAjaxhistory

public void setAjaxhistory(String ajaxhistory)

setDefaultIndicator

public void setDefaultIndicator(String defaultIndicator)

setDefaultLoadingText

public void setDefaultLoadingText(String defaultLoadingText)

setDefaultErrorText

public void setDefaultErrorText(String defaultErrorText)

setLoadAtOnce

public void setLoadAtOnce(String loadAtOnce)

setDebug

public void setDebug(String debug)

setScriptPath

public void setScriptPath(String scriptPath)

Class Head

Field Summary

Fields inherited from class org.apache.struts2.components.Component

Fields inherited from class org.apache.struts2.components.UIBean

Constructor Summary

Method Summary

Methods inherited from class org.apache.struts2.components.Component

Methods inherited from class org.apache.struts2.components.Head

Methods inherited from class java.lang.Object

Methods inherited from class org.apache.struts2.components.UIBean

Field Detail

TEMPLATE

compressed

locale

jquery

jquerytheme

jqueryui

customBasepath

loadFromGoogle

ajaxcache

ajaxhistory

defaultIndicator

defaultLoadingText

defaultErrorText

loadAtOnce

debug

scriptPath

Constructor Detail

Head

Method Detail

getDefaultTemplate

evaluateParams

setDefaultLocale

setTheme

getTheme

setJquery

isJqueryui

setJqueryui

setCompressed

setJquerytheme

setLocale

setCustomBasepath

setLoadFromGoogle

setAjaxcache

setAjaxhistory

setDefaultIndicator

setDefaultLoadingText

setDefaultErrorText

setLoadAtOnce

setDebug

setScriptPath