LayoutTemplate (OpenMRS 1.8.5-SNAPSHOT API)

java.lang.Object
- org.openmrs.layout.web.LayoutTemplate

Direct Known Subclasses:

AddressTemplate, NameTemplate
```
public abstract class LayoutTemplate
extends Object
```
Generic class used by AddressTemplate and NameTemplate layouts

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`codeName`
`protected String`	`country`
`protected String`	`displayName`
`protected Map<String,String>`	`elementDefaults`
`protected Map<String,String>`	`elementRegex`
`protected Map<String,String>`	`elementRegexFormats`
`protected String`	`LAYOUT_TOKEN`
`protected List<String>`	`lineByLineFormat`
`protected int`	`maxTokens`
`protected Map<String,String>`	`nameMappings`
`protected Map<String,String>`	`sizeMappings`

Constructor Summary

Constructors
Constructor and Description

LayoutTemplate()

Constructors
Constructor and Description
`LayoutTemplate()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getCodeName()`
`String`	`getCountry()`
`String`	`getDisplayName()`
`Map<String,String>`	`getElementDefaults()`
`Map<String,String>`	`getElementRegex()` Get the element regular expressions.
`Map<String,String>`	`getElementRegexFormats()` Get the element formats.
`abstract LayoutSupport<?>`	`getLayoutSupportInstance()`
`abstract String`	`getLayoutToken()`
`List<String>`	`getLineByLineFormat()`
`List<List<Map<String,String>>>`	`getLines()`
`int`	`getMaxTokens()`
`Map<String,String>`	`getNameMappings()`
`abstract String`	`getNonLayoutToken()`
`Map<String,String>`	`getSizeMappings()`
`List<String>`	`nonUniqueStringsGoLast(List<String> strListArg)`
`void`	`setCodeName(String codeName)`
`void`	`setCountry(String country)`
`void`	`setDisplayName(String displayName)`
`void`	`setElementDefaults(Map<String,String> elementDefaults)`
`void`	`setElementRegex(Map<String,String> elementRegex)` Set the element regular expressions.
`void`	`setElementRegexFormats(Map<String,String> elementRegexFormats)` Set the element formats.
`void`	`setLineByLineFormat(List<String> lineByLineFormat)`
`void`	`setMaxTokens(int maxTokens)`
`void`	`setNameMappings(Map<String,String> nameMappings)`
`void`	`setSizeMappings(Map<String,String> sizeMappings)`

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

- Field Detail
  - LAYOUT_TOKEN
```
protected final String LAYOUT_TOKEN
```
    See Also:
    
    Constant Field Values
  - displayName
```
protected String displayName
```
  - codeName
```
protected String codeName
```
  - country
```
protected String country
```
  - nameMappings
```
protected Map<String,String> nameMappings
```
  - sizeMappings
```
protected Map<String,String> sizeMappings
```
  - elementDefaults
```
protected Map<String,String> elementDefaults
```
  - elementRegex
```
protected Map<String,String> elementRegex
```
  - elementRegexFormats
```
protected Map<String,String> elementRegexFormats
```
  - lineByLineFormat
```
protected List<String> lineByLineFormat
```
  - maxTokens
```
protected int maxTokens
```
- Constructor Detail
  - LayoutTemplate
```
public LayoutTemplate()
```
- Method Detail
  - getLayoutToken
```
public abstract String getLayoutToken()
```
  - getNonLayoutToken
```
public abstract String getNonLayoutToken()
```
  - getLines
```
public List<List<Map<String,String>>> getLines()
```
  - getCodeName
```
public String getCodeName()
```
    Returns:
    
    the codeName
  - setCodeName
```
public void setCodeName(String codeName)
```
    Parameters:
    
    codeName - the codeName to set
  - getCountry
```
public String getCountry()
```
    Returns:
    
    the country
  - setCountry
```
public void setCountry(String country)
```
    Parameters:
    
    country - the country to set
  - getDisplayName
```
public String getDisplayName()
```
    Returns:
    
    the displayName
  - setDisplayName
```
public void setDisplayName(String displayName)
```
    Parameters:
    
    displayName - the displayName to set
  - getElementDefaults
```
public Map<String,String> getElementDefaults()
```
    Returns:
    
    the elementDefaults
  - setElementDefaults
```
public void setElementDefaults(Map<String,String> elementDefaults)
```
    Parameters:
    
    elementDefaults - the elementDefaults to set
  - getElementRegex
```
public Map<String,String> getElementRegex()
```
    Get the element regular expressions. These can be used to enforce that an element matches a regex.
    
    Returns:
    
    the elementRegex
  - setElementRegex
```
public void setElementRegex(Map<String,String> elementRegex)
```
    Set the element regular expressions. These can be used to enforce that an element matches a regex.
    
    Parameters:
    
    elementRegex - the elementRegex to set
  - getElementRegexFormats
```
public Map<String,String> getElementRegexFormats()
```
    Get the element formats. These can be used to display an example format that an element should look like.
    
    Returns:
    
    the elementFormats
  - setElementRegexFormats
```
public void setElementRegexFormats(Map<String,String> elementRegexFormats)
```
    Set the element formats. These can be used to display an example format that an element should look like.
    
    Parameters:
    
    elementFormats - the elementFormats to set
  - getLineByLineFormat
```
public List<String> getLineByLineFormat()
```
    Returns:
    
    the lineByLineFormat
  - setLineByLineFormat
```
public void setLineByLineFormat(List<String> lineByLineFormat)
```
    Parameters:
    
    lineByLineFormat - the lineByLineFormat to set
  - getMaxTokens
```
public int getMaxTokens()
```
    Returns:
    
    the maxTokens
  - setMaxTokens
```
public void setMaxTokens(int maxTokens)
```
    Parameters:
    
    maxTokens - the maxTokens to set
  - getNameMappings
```
public Map<String,String> getNameMappings()
```
    Returns:
    
    the nameMappings
  - setNameMappings
```
public void setNameMappings(Map<String,String> nameMappings)
```
    Parameters:
    
    nameMappings - the nameMappings to set
  - getSizeMappings
```
public Map<String,String> getSizeMappings()
```
    Returns:
    
    the sizeMappings
  - setSizeMappings
```
public void setSizeMappings(Map<String,String> sizeMappings)
```
    Parameters:
    
    sizeMappings - the sizeMappings to set
  - getLayoutSupportInstance
```
public abstract LayoutSupport<?> getLayoutSupportInstance()
```
  - nonUniqueStringsGoLast
```
public List<String> nonUniqueStringsGoLast(List<String> strListArg)
```

Class LayoutTemplate

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LAYOUT_TOKEN

displayName

codeName

country

nameMappings

sizeMappings

elementDefaults

elementRegex

elementRegexFormats

lineByLineFormat

maxTokens

Constructor Detail

LayoutTemplate

Method Detail

getLayoutToken

getNonLayoutToken

getLines

getCodeName

setCodeName

getCountry

setCountry

getDisplayName

setDisplayName

getElementDefaults

setElementDefaults

getElementRegex

setElementRegex

getElementRegexFormats

setElementRegexFormats

getLineByLineFormat

setLineByLineFormat

getMaxTokens

setMaxTokens

getNameMappings

setNameMappings

getSizeMappings

setSizeMappings

getLayoutSupportInstance

nonUniqueStringsGoLast