@ResponseStatus(reason="Access Denied",
value=FORBIDDEN)
public class HtmlUiBuilder<T>
extends Object
implements org.springframework.beans.factory.BeanFactoryAware, org.springframework.web.context.ServletContextAware
| Modifier and Type | Field and Description |
|---|---|
protected Map<Class<?>,TypeSerializer> |
classSerializers |
protected String |
idParameterName |
protected String |
idPropertyName |
protected Map<String,String> |
nullLabels |
protected String |
title |
protected String |
typeName |
| Constructor and Description |
|---|
HtmlUiBuilder() |
HtmlUiBuilder(String typeName,
String title) |
HtmlUiBuilder(String typeName,
String title,
String pluralTitle) |
| Modifier and Type | Method and Description |
|---|---|
void |
addKeySerializer(KeySerializer keySerializer) |
protected void |
addListMenuItems(Menu menu,
String prefix) |
void |
addMenuElement(ElementContainer container,
Menu menu) |
Menu |
addMenuItem(Menu menu,
String prefix,
String pageName,
String linkTitle) |
Menu |
addMenuItem(Menu menu,
String prefix,
String pageName,
String linkTitle,
Map<String,Object> parameters) |
Menu |
addMenuItem(Menu menu,
String prefix,
String pageName,
String linkTitle,
String target) |
Menu |
addMenuItem(Menu menu,
String prefix,
String pageName,
String linkTitle,
String target,
Map<String,Object> parameters) |
void |
addMessageView(ElementContainer view,
String messageName,
Map<String,Object> variables) |
void |
addNullLabel(String key,
String label) |
void |
addObjectViewPage(TabElementContainer tabs,
Object object,
String prefix) |
void |
addTabDataTable(TabElementContainer container,
Object builderName,
String pageName,
Map<String,Object> parameters) |
ElementContainer |
createDataTable(javax.servlet.http.HttpServletRequest request,
String pageName,
Map<String,? extends Object> parameters) |
ElementContainer |
createDataTable(javax.servlet.http.HttpServletRequest request,
String pageName,
Map<String,? extends Object> parameters,
Collection<? extends Object> rows) |
Object |
createDataTableHandler(javax.servlet.http.HttpServletRequest request,
String pageName,
Callable<Collection<? extends Object>> rowsCallable) |
Object |
createDataTableHandler(javax.servlet.http.HttpServletRequest request,
String pageName,
Collection<? extends Object> rows) |
Object |
createDataTableHandler(javax.servlet.http.HttpServletRequest request,
String pageName,
Map<String,Object> parameters,
Callable<Collection<? extends Object>> rowsCallable) |
Object |
createDataTableHandler(javax.servlet.http.HttpServletRequest request,
String pageName,
Map<String,Object> parameters,
Collection<? extends Object> rows) |
Object |
createDataTableHandler(String pageName,
Collection<? extends Object> rows) |
Object |
createDataTableHandlerOrRedirect(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
String pageName,
Callable<Collection<? extends Object>> rowsCallable,
Object parentBuilder,
String parentPageName) |
Object |
createDataTableHandlerOrRedirect(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
String pageName,
Collection<? extends Object> rows,
Object parentBuilder,
String parentPageName) |
Map<String,Object> |
createDataTableMap(Collection<? extends Object> records,
String pageName) |
Map<String,Object> |
createDataTableMap(javax.servlet.http.HttpServletRequest request,
Collection<? extends Object> records,
String pageName) |
Map<String,Object> |
createDataTableMap(javax.servlet.http.HttpServletRequest request,
RecordStore recordStore,
Query query,
String pageName) |
ElementContainer |
createDetailView(Object object,
List<KeySerializer> serializers) |
<F extends Form> |
createForm(Object object,
String keyListName)
Create a form for the object using the specified list of fields keys.
|
<F extends Form> |
createForm(Object object,
String formName,
List<String> keys) |
<F extends Form> |
createForm(Object object,
String formName,
String keyList) |
protected T |
createObject() |
Element |
createObjectAddPage(Map<String,Object> defaultValues,
String prefix,
String preInsertMethod) |
Element |
createObjectEditPage(T object,
String prefix) |
<F extends Form> |
createTableForm(Object object,
String keyListName) |
void |
destroy() |
Element |
getAttribute(javax.servlet.http.HttpServletRequest request,
String key)
Create a new field (or element) for the named key.
|
String |
getAttributeInstruction(String key) |
Map<String,String> |
getAttributeInstructions() |
Decorator |
getAttributeLabel(String key,
Element element) |
Map<String,Decorator> |
getAttributeLabels() |
Map<String,Element> |
getAttributes() |
Decorator |
getAttributeTableLabel(String key,
Element element) |
protected org.springframework.beans.factory.BeanFactory |
getBeanFactory() |
<H extends HtmlUiBuilder<?>> |
getBuilder(Class<?> objectClass)
Get the HTML UI Builder for the object's class.
|
<H extends HtmlUiBuilder<?>> |
getBuilder(Object object)
Get the HTML UI Builder for the object's class.
|
<H extends HtmlUiBuilder<?>> |
getBuilder(String typeName)
Get the HTML UI Builder for the class.
|
HtmlUiBuilderFactory |
getBuilderFactory()
Get the factory used to get related HTML UI builders,
|
Map<String,Boolean> |
getDataTableSortOrder(List<String> columnNames,
javax.servlet.http.HttpServletRequest request) |
int |
getDefaultPageSize() |
String |
getIdParameterName() |
String |
getIdPropertyName() |
Object |
getIdValue(Object object) |
List<String> |
getKeyList(String name)
Get the key list with the specified name, or the default if not defined.
|
List<String> |
getKeyList(String name,
String defaultName)
Get the key list with the specified name, or the list for defaultName if
not defined.
|
Map<String,List<String>> |
getKeyLists()
Get the map of key lists.
|
Map<String,KeySerializer> |
getKeySerializers() |
String |
getLabel(String key)
Get the label for the key.
|
String |
getLabel(String key,
Element element) |
Map<String,String> |
getLabels() |
Map<String,List<List<Object>>> |
getListSortOrder() |
List<List<Object>> |
getListSortOrder(String pageName) |
int |
getMaxPageSize() |
String |
getMessage(String messageName) |
String |
getMessage(String messageName,
Map<String,Object> variables) |
Map<String,String> |
getNullLabels() |
Page |
getPage(String path) |
protected Page |
getPage(String prefix,
String name) |
Map<String,Page> |
getPagesByName() |
String |
getPageTitle(String pageName) |
String |
getPageUrl(String name) |
String |
getPageUrl(String name,
Map<String,? extends Object> parameters) |
String |
getPageUrlOld(String name) |
Map<String,String> |
getPageUrls() |
String |
getPluralTitle() |
Object |
getProperty(Object object,
String keyName) |
static javax.servlet.http.HttpServletRequest |
getRequest() |
ResultPager<T> |
getResultPager(Map<String,Object> filter) |
protected List<KeySerializer> |
getSerializers(String viewName) |
protected List<KeySerializer> |
getSerializers(String viewName,
String defaultViewName) |
String |
getTitle() |
String |
getTypeName() |
protected static String |
getUriTemplateVariable(String name) |
static Map<String,String> |
getUriTemplateVariables() |
boolean |
hasPageUrl(String pageName) |
void |
initializeForm(HtmlUiBuilderObjectForm form,
javax.servlet.http.HttpServletRequest request) |
void |
initializeForm(UiBuilderObjectForm form,
javax.servlet.http.HttpServletRequest request) |
protected void |
insertObject(T object) |
static boolean |
isDataTableCallback() |
static boolean |
isDataTableCallback(javax.servlet.http.HttpServletRequest request) |
static boolean |
isHtmlPage(javax.servlet.http.HttpServletRequest request) |
boolean |
isUsePathVariables() |
T |
loadObject(Object id) |
protected void |
notFound(javax.servlet.http.HttpServletResponse response,
String message) |
void |
postInsert(T object) |
void |
postUpdate(T object) |
boolean |
preInsert(Form form,
T object) |
boolean |
preUpdate(Form form,
T object) |
void |
redirectAfterCommit(String url) |
Void |
redirectPage(String pageName) |
Object |
redirectToTab(Object parentBuilder,
String parentPageName,
String tabName) |
void |
referrerRedirect(javax.servlet.http.HttpServletRequest request) |
void |
serialize(XmlWriter out,
Object object,
String key)
Serialize the value represented by the key from the object.
|
void |
serializeLink(XmlWriter out,
Object object,
String key,
String pageName) |
void |
serializeLink(XmlWriter out,
Object object,
String key,
String pageName,
Map<String,String> parameterKeys) |
void |
serializeNullLabel(XmlWriter out,
String key)
Serialize the message where a key has no value.
|
void |
setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory) |
void |
setBuilderFactory(HtmlUiBuilderFactory builderFactory)
Set the factory used to get related HTML UI builders,
|
void |
setDefaultPageSize(int defaultPageSize) |
void |
setFieldInstructions(Map<String,String> fieldInstructions) |
void |
setFields(Map<String,Element> fields) |
void |
setIdParameterName(String idParameterName) |
void |
setIdPropertyName(String idPropertyName) |
void |
setKeyList(String name,
List<String> keyList)
Set the key list with the specified name.
|
void |
setKeyLists(Map<String,List<String>> keyLists)
Set the map of key lists.
|
void |
setLabels(Map<String,String> labels) |
void |
setListSortOrder(Map<String,List<List<Object>>> listSortOrder) |
void |
setMaxPageSize(int maxPageSize) |
void |
setMessages(Map<String,String> messages) |
void |
setNullLabels(Map<String,String> nullLabels) |
void |
setPages(Collection<Page> pages) |
void |
setPagesByName(Map<String,Page> pagesByName) |
String |
setPageTitle(javax.servlet.http.HttpServletRequest request,
String pageName) |
void |
setPageTitleAttribute(javax.servlet.http.HttpServletRequest request,
String pageName) |
void |
setPageUrls(Map<String,String> pageUrls) |
void |
setPluralTitle(String pluralTitle) |
void |
setRollbackOnly(T object) |
void |
setSerializers(Collection<KeySerializer> keySerializers) |
void |
setServletContext(javax.servlet.ServletContext servletContext) |
void |
setTitle(String typeLabel) |
void |
setTypeName(String typeName) |
void |
setUsePathVariables(boolean usePathVariables) |
void |
setValue(Object object,
String key,
Object value) |
protected void |
setView(String name,
List<?> elements) |
void |
setViews(Map<String,List<?>> views) |
protected void |
updateObject(T object) |
boolean |
validateForm(HtmlUiBuilderObjectForm form) |
boolean |
validateForm(UiBuilderObjectForm uiBuilderObjectForm) |
protected Map<Class<?>,TypeSerializer> classSerializers
protected String idParameterName
protected String idPropertyName
protected String title
protected String typeName
public static javax.servlet.http.HttpServletRequest getRequest()
public static boolean isDataTableCallback()
public static boolean isDataTableCallback(javax.servlet.http.HttpServletRequest request)
public static boolean isHtmlPage(javax.servlet.http.HttpServletRequest request)
public void addKeySerializer(KeySerializer keySerializer)
public void addMenuElement(ElementContainer container, Menu menu)
public Menu addMenuItem(Menu menu, String prefix, String pageName, String linkTitle, Map<String,Object> parameters)
public Menu addMenuItem(Menu menu, String prefix, String pageName, String linkTitle, String target)
public Menu addMenuItem(Menu menu, String prefix, String pageName, String linkTitle, String target, Map<String,Object> parameters)
public void addMessageView(ElementContainer view, String messageName, Map<String,Object> variables)
public void addObjectViewPage(TabElementContainer tabs, Object object, String prefix)
public void addTabDataTable(TabElementContainer container, Object builderName, String pageName, Map<String,Object> parameters)
public ElementContainer createDataTable(javax.servlet.http.HttpServletRequest request, String pageName, Map<String,? extends Object> parameters)
public ElementContainer createDataTable(javax.servlet.http.HttpServletRequest request, String pageName, Map<String,? extends Object> parameters, Collection<? extends Object> rows)
public Object createDataTableHandler(javax.servlet.http.HttpServletRequest request, String pageName, Callable<Collection<? extends Object>> rowsCallable)
public Object createDataTableHandler(javax.servlet.http.HttpServletRequest request, String pageName, Collection<? extends Object> rows)
public Object createDataTableHandler(javax.servlet.http.HttpServletRequest request, String pageName, Map<String,Object> parameters, Callable<Collection<? extends Object>> rowsCallable)
public Object createDataTableHandler(javax.servlet.http.HttpServletRequest request, String pageName, Map<String,Object> parameters, Collection<? extends Object> rows)
public Object createDataTableHandler(String pageName, Collection<? extends Object> rows)
public Object createDataTableHandlerOrRedirect(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String pageName, Callable<Collection<? extends Object>> rowsCallable, Object parentBuilder, String parentPageName)
public Object createDataTableHandlerOrRedirect(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String pageName, Collection<? extends Object> rows, Object parentBuilder, String parentPageName)
public Map<String,Object> createDataTableMap(Collection<? extends Object> records, String pageName)
public Map<String,Object> createDataTableMap(javax.servlet.http.HttpServletRequest request, Collection<? extends Object> records, String pageName)
public Map<String,Object> createDataTableMap(javax.servlet.http.HttpServletRequest request, RecordStore recordStore, Query query, String pageName)
public ElementContainer createDetailView(Object object, List<KeySerializer> serializers)
public <F extends Form> F createForm(Object object, String keyListName)
T - The type of form to return.object - The object to create the form for.keyListName - The name of the list of keys for the fields to include
on the form.protected T createObject()
public Element createObjectAddPage(Map<String,Object> defaultValues, String prefix, String preInsertMethod) throws IOException, javax.servlet.ServletException
IOExceptionjavax.servlet.ServletExceptionpublic Element createObjectEditPage(T object, String prefix) throws IOException, javax.servlet.ServletException
IOExceptionjavax.servlet.ServletException@PreDestroy public void destroy()
public Element getAttribute(javax.servlet.http.HttpServletRequest request, String key)
request - The servlet request.key - The field key.protected final org.springframework.beans.factory.BeanFactory getBeanFactory()
public <H extends HtmlUiBuilder<?>> H getBuilder(Class<?> objectClass)
objectClass> - The object class.public <H extends HtmlUiBuilder<?>> H getBuilder(Object object)
object - The object.public <H extends HtmlUiBuilder<?>> H getBuilder(String typeName)
className - The name of the class.public HtmlUiBuilderFactory getBuilderFactory()
public Map<String,Boolean> getDataTableSortOrder(List<String> columnNames, javax.servlet.http.HttpServletRequest request)
public int getDefaultPageSize()
public String getIdParameterName()
public String getIdPropertyName()
public List<String> getKeyList(String name)
name - The name of the key list.public List<String> getKeyList(String name, String defaultName)
name - The name of the key list.defaultName - The name of the default key list to use.public Map<String,List<String>> getKeyLists()
public Map<String,KeySerializer> getKeySerializers()
public String getLabel(String key)
Get the label for the key. The following process is used (in sequence) to get the label for the key.
setLabels(Map)After the first call for a particular key the calculated labels are cached.
key - The key.public int getMaxPageSize()
public String getPluralTitle()
public ResultPager<T> getResultPager(Map<String,Object> filter)
protected List<KeySerializer> getSerializers(String viewName)
protected List<KeySerializer> getSerializers(String viewName, String defaultViewName)
public String getTitle()
public String getTypeName()
public boolean hasPageUrl(String pageName)
public void initializeForm(HtmlUiBuilderObjectForm form, javax.servlet.http.HttpServletRequest request)
public void initializeForm(UiBuilderObjectForm form, javax.servlet.http.HttpServletRequest request)
protected void insertObject(T object)
public boolean isUsePathVariables()
protected void notFound(javax.servlet.http.HttpServletResponse response,
String message)
throws IOException
IOExceptionpublic void postInsert(T object)
public void postUpdate(T object)
public void redirectAfterCommit(String url)
public Object redirectToTab(Object parentBuilder, String parentPageName, String tabName)
public void referrerRedirect(javax.servlet.http.HttpServletRequest request)
public void serialize(XmlWriter out, Object object, String key)
out - The XML writer to serialize to.object - The object to get the value from.key - The key to serialize.IOException - If there was an I/O error serializing the value.public void serializeLink(XmlWriter out, Object object, String key, String pageName, Map<String,String> parameterKeys)
public void serializeNullLabel(XmlWriter out, String key)
out - The XML writer to serialize to.key - The key to serialize the no value message for.IOException - If there was an I/O error serializing the value.public void setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory)
setBeanFactory in interface org.springframework.beans.factory.BeanFactoryAwarepublic void setBuilderFactory(HtmlUiBuilderFactory builderFactory)
builderFactory - The factory.public void setDefaultPageSize(int defaultPageSize)
public void setFieldInstructions(Map<String,String> fieldInstructions)
fieldInstructions - The fieldInstructions to set.public void setIdParameterName(String idParameterName)
idParameterName - The idParameterName to set.public void setIdPropertyName(String idPropertyName)
public void setKeyList(String name, List<String> keyList)
name - The name of the key list.keyList - The key list.public void setKeyLists(Map<String,List<String>> keyLists)
keyLists - The map of key lists.public void setMaxPageSize(int maxPageSize)
public void setNullLabels(Map<String,String> nullLabels)
nullLabels - The nullLabels to set.public void setPages(Collection<Page> pages)
public String setPageTitle(javax.servlet.http.HttpServletRequest request, String pageName)
public void setPageTitleAttribute(javax.servlet.http.HttpServletRequest request,
String pageName)
public void setPluralTitle(String pluralTitle)
public void setRollbackOnly(T object)
public void setSerializers(Collection<KeySerializer> keySerializers)
public void setServletContext(javax.servlet.ServletContext servletContext)
setServletContext in interface org.springframework.web.context.ServletContextAwarepublic void setTitle(String typeLabel)
public void setTypeName(String typeName)
public void setUsePathVariables(boolean usePathVariables)
protected void updateObject(T object)
public boolean validateForm(HtmlUiBuilderObjectForm form)
public boolean validateForm(UiBuilderObjectForm uiBuilderObjectForm)
Copyright © 2015 Revolution Systems Inc.. All rights reserved.