* This renderer can be used to do the input of any domain object because you * can configure the concrete service that searches the objects and all objects * are referred to by their internal id. It's recommended that a specialized * service is created for most cases so that it's as efficient as possible. * *
* Example:
*
* If the renderer is used to edit the slot slotA of an object
* A and this property is set the value slotB then when the
* field is submited the renderer will set the value of the text field in
* the slotB of the object A.
*
*
* When you type in the text field an auto completion list is presented.
* Nevertheless an object is only selected when the user selects one element
* from the sugested completions. This means that if the user does not
* select one element after typing some text the value of the slot beeing
* edited will be set to null.
*
* @property
*/
public void setRawSlotName(String rawSlotName) {
this.rawSlotName = rawSlotName;
}
public String getLabelField() {
return this.labelField;
}
/**
* This property allows you tho choose the name of the slot that will be
* used as the presentation of the object. If this proprty has the value
* slotL then the list of suggestions will be a list of values
* obtained by invoking getSlotL in each object.
*
* @property
*/
public void setLabelField(String labelField) {
this.labelField = labelField;
}
public String getFormat() {
return this.format;
}
/**
* Allows you select the presentation format. If not set the value of the
* field given by {@link #setLabelField(String) labelField} is used. See
* {@link pt.ist.fenixWebFramework.renderers.utils.RenderUtils#getFormattedProperties(String, Object)}
* to see the accepted format syntax.
*
* @property
*/
public void setFormat(String format) {
this.format = format;
}
public Integer getMaxCount() {
return this.maxCount;
}
/**
* Limits the number of results that the servlet returns thus the number of
* suggestions given to the user.
*
* @property
*/
public void setMaxCount(Integer maxCount) {
this.maxCount = maxCount;
}
public String getAutoCompleteItemsStyleClass() {
return this.autoCompleteItemsStyleClass;
}
/**
* The html class of results shown.
*
* @property
*/
public void setAutoCompleteItemsStyleClass(String autoCompleteItemsStyleClass) {
this.autoCompleteItemsStyleClass = autoCompleteItemsStyleClass;
}
public String getAutoCompleteStyleClass() {
return this.autoCompleteStyleClass;
}
/**
* The html class of the container of the results shown.
*
* @property
*/
public void setAutoCompleteStyleClass(String autoCompleteStyleClass) {
this.autoCompleteStyleClass = autoCompleteStyleClass;
}
public String getTextFieldStyleClass() {
return this.textFieldStyleClass;
}
/**
* The html class of the text field.
*
* @property
*/
public void setTextFieldStyleClass(String textFieldStyleClass) {
this.textFieldStyleClass = textFieldStyleClass;
}
public String getErrorStyleClass() {
return this.errorStyleClass;
}
/**
* The html class of the error message.
*
* @property
*/
public void setErrorStyleClass(String errorStyleClass) {
this.errorStyleClass = errorStyleClass;
}
public String getSize() {
return this.size;
}
/**
* The size of the text field.
*
* @property
*/
public void setSize(String size) {
this.size = size;
}
public int getMinChars() {
return this.minChars;
}
/**
* The number of characters the user is required to type before any
* suggestion is offered.
*
* @property
*/
public void setMinChars(int minChars) {
this.minChars = minChars;
}
public boolean isIndicatorShown() {
return this.indicatorShown;
}
/**
* When this property is set to true a progress indicator is
* shown during the comunication with the server.
*
* @property
*/
public void setIndicatorShown(boolean indicatorShown) {
this.indicatorShown = indicatorShown;
}
@Override
protected Layout getLayout(Object object, Class type) {
return new Layout() {
@Override
public HtmlComponent createComponent(Object object, Class type) {
HtmlInlineContainer container = new HtmlInlineContainer();
addScripts(container);
MetaSlotKey key = (MetaSlotKey) getContext().getMetaObject().getKey();
HtmlHiddenField valueField = new HtmlHiddenField();
valueField.setTargetSlot(key);
valueField.setId(key.toString() + "_AutoComplete");
valueField.setName(valueField.getId());
container.addChild(valueField);
if (object != null) {
Object oid = RendererPropertyUtils.getProperty(object, getValueField(), false);
valueField.setValue(oid == null ? null : oid.toString());
}
valueField.setConverter(new AutoCompleteConverter());
HtmlHiddenField oldValueField = new HtmlHiddenField();
oldValueField.setId(key.toString() + "_OldValue");
oldValueField.setName(oldValueField.getId());
container.addChild(oldValueField);
HtmlTextInput textField = new HtmlTextInput();
textField.setId(key.toString());
textField.setName(textField.getId());
textField.setClasses(getTextFieldStyleClass());
textField.setSize(getSize());
container.addChild(textField);
if (object != null && getLabelField() != null) {
String label = (String) RendererPropertyUtils.getProperty(object, getLabelField(), false);
textField.setValue(label);
} else if (getRawSlotName() != null) {
Object beanObject = getInputContext().getParentContext().getMetaObject().getObject();
if (beanObject != null) { // protect from a creation context
String rawText = (String) RendererPropertyUtils.getProperty(beanObject, getRawSlotName(), false);
textField.setValue(rawText);
if (rawText != null) {
valueField.setValue(TYPING_VALUE);
}
}
}
if (getRawSlotName() != null) {
textField.setController(new UpdateRawNameController(getRawSlotName()));
}
HtmlText errorMessage = new HtmlText(RenderUtils.getResourceString("fenix.renderers.autocomplete.error"));
errorMessage.setId(key.toString() + "_Error");
errorMessage.setClasses(getErrorStyleClass());
errorMessage.setStyle("display: none;");
container.addChild(errorMessage);
addFinalScript(container, textField.getId());
return container;
}
private void addScripts(HtmlInlineContainer container) {
HtmlLink link = new HtmlLink();
link.setModuleRelative(false);
link.setContextRelative(true);
String[] scriptNames = new String[] { "autoComplete.js", "autoCompleteHandlers.js" };
for (String script : scriptNames) {
addSingleScript(container, link, script);
}
}
private void addSingleScript(HtmlInlineContainer container, HtmlLink link, String scriptName) {
link.setUrl("/javaScript/" + scriptName);
HtmlScript script = new HtmlScript("text/javascript", link.calculateUrl(), true);
container.addChild(script);
}
private void addFinalScript(HtmlInlineContainer container, String textFieldId) {
HtmlLink link = new HtmlLink();
link.setModuleRelative(false);
link.setContextRelative(true);
link.setUrl(SERVLET_URI);
link.setParameter("args", getFormatedArgs());
link.setParameter("labelField", getLabelField());
link.setParameter("valueField", getValueField()); // TODO: allow
// configuration,1
// needs also
// converter
link.setParameter("styleClass", getAutoCompleteItemsStyleClass() == null ? "" : getAutoCompleteItemsStyleClass());
link.setEscapeAmpersand(false);
if (getFormat() != null) {
link.setParameter("format", getFormat());
}
if (getMaxCount() != null) {
link.setParameter("maxCount", String.valueOf(getMaxCount()));
}
String finalUri = link.calculateUrl();
String scriptText = "$(\"input#" + escapeId(textFieldId) + "\").autocomplete(\"" + finalUri + "\", { minChars: "
+ getMinChars() + ", validSelection: false"
+ ", cleanSelection: clearAutoComplete, select: selectElement, after: updateCustomValue});";
HtmlScript script = new HtmlScript();
script.setContentType("text/javascript");
script.setScript(scriptText);
container.addChild(script);
}
private String escapeId(String textFieldId) {
return textFieldId.replace(".", "\\\\.").replaceAll(":", "\\\\\\\\:");
}
private String getFormatedArgs() {
Object object = ((MetaSlot) getInputContext().getMetaObject()).getMetaObject().getObject();
return RenderUtils.getFormattedProperties(getArgs(), object);
}
};
}
private static class UpdateRawNameController extends HtmlController {
private String rawSlotName;
public UpdateRawNameController(String rawSlotName) {
super();
this.rawSlotName = rawSlotName;
}
@Override
public void execute(IViewState viewState) {
HtmlSimpleValueComponent component = (HtmlSimpleValueComponent) getControlledComponent();
updatRawSlot(viewState, component.getValue());
}
private void updatRawSlot(IViewState viewState, String value) {
Object object = viewState.getMetaObject().getObject();
try {
PropertyUtils.setProperty(object, this.rawSlotName, value);
} catch (Exception e) {
e.printStackTrace();
}
}
}
private static class AutoCompleteConverter extends Converter {
public AutoCompleteConverter() {
super();
}
@Override
public Object convert(Class type, Object value) {
if (value == null || "".equals(value)) {
return null;
}
String text = (String) value;
if (text.equals(TYPING_VALUE)) {
return null;
}
String key = text;
return new DomainObjectKeyConverter().convert(type, key);
}
}
}