();
this.selectAllLocation = LOCATION_BOTTOM;
}
public String getCaption() {
return caption;
}
/**
* The table caption.
*
* @property
*/
public void setCaption(String caption) {
this.caption = caption;
}
public String getSummary() {
return summary;
}
/**
* Sets the summary attribute of the generated table.
*
* @property
*/
public void setSummary(String summary) {
this.summary = summary;
}
public String getColumnClasses() {
return columnClasses;
}
/**
* The classes to be used in the table columns. You can separate classes
* with commas. The value "class1" means that all columns will have the
* specified class. The value "class1,class2" means that columns will have
* "class1" or "class2" as their class depending of their position. The
* first column will have "class1", the second "class2", the third "class1",
* etc. The only way to specify a class for the first and last column is to
* give empty classes to all the middle columns. So if you have 3 columns, a
* value of "class1,,class2" would put "class1" in the first column and
* "class2" in the third and last column.
*
* @property
*/
public void setColumnClasses(String columnClasses) {
this.columnClasses = columnClasses;
}
public String getHeaderClasses() {
return headerClasses;
}
/**
* The value of the class attribute of each cell in the table's header.
* There is repetition as in {@linkplain #setColumnClasses(String)
* columnClasses} or {@linkplain #setRowClasses(String) rowClasses}.
*
* @property
*/
public void setHeaderClasses(String headerClasses) {
this.headerClasses = headerClasses;
}
public String getRowClasses() {
return rowClasses;
}
/**
* With this property you can choose if you want to display headers or not
* in the table
*
* @property
*/
public boolean getDisplayHeaders() {
return displayHeaders;
}
public void setDisplayHeaders(boolean displayHeaders) {
this.displayHeaders = displayHeaders;
}
/**
* The classes to be used for each row in the table. In a similar way to
* {@link #setColumnClasses(String) columnClasses} you can use a repeating
* pattern for the classes. A value like "gray," could make each alternating
* row be shaded.
*
* @property
*/
public void setRowClasses(String rowClasses) {
this.rowClasses = rowClasses;
}
public String getSuffixes() {
return this.suffixes;
}
/**
* This property allows you to specify a string to be included as a suffix
* of each cell in the table. The suffix value can have a repeating pattern
* as {@linkplain #setRowClasses(String) rowClasses}. This means that, for
* the example above, a suffix of "years old" would produce
* rows like:
*
*
*
* | Name A |
* 20 years old |
* Female |
* Edit |
* Delete |
*
*
*
* @property
*/
public void setSuffixes(String suffixes) {
this.suffixes = suffixes;
}
public String getPrefixes() {
return this.prefixes;
}
/**
* This property is similar to {@linkplain #setSuffixes(String) suffixes}
* with the difference that the text is inlcuded as prefix of each cell
* content.
*
* @property
*/
public void setPrefixes(String prefixes) {
this.prefixes = prefixes;
}
private String getStringPart(String string, int index) {
if (string == null) {
return null;
}
String[] stringParts = string.split(",");
return stringParts[index % stringParts.length];
}
protected TableLink getTableLink(String name) {
TableLink tableLink = this.links.get(name);
if (tableLink == null) {
tableLink = new TableLink(name);
this.links.put(name, tableLink);
this.sortedLinks.add(tableLink);
}
return tableLink;
}
protected TableLink getTableLink(int order) {
Collections.sort(this.sortedLinks);
return this.sortedLinks.get(order);
}
protected int getSortedLinksSize() {
return this.sortedLinks.size();
}
public String getLink(String name) {
return getTableLink(name).getLink();
}
/**
* The Counter property indicates the property that should be getted to
* receive a number that will be displayed in the setted format right after
* the label
*
* @property
*/
public void setCounter(String name, String value) {
getTableLink(name).setCounter(value);
}
public String getCounter(String name) {
return getTableLink(name).getCounter();
}
/**
* The link property indicates the page to were the control link will point.
* All params will be appended to this link.
*
* @property
*/
public void setLink(String name, String value) {
getTableLink(name).setLink(value);
}
public String getModule(String name) {
return getTableLink(name).getModule();
}
/**
* By default the link property will be mapped to the current module. You
* can override that with this property.
*
* @property
*/
public void setModule(String name, String value) {
getTableLink(name).setModule(value);
}
public String getParam(String name) {
return getTableLink(name).getParam();
}
/**
* The param property allows you to indicate will values of the
* object shown in a given row should be used to configure the link
* specified.
*
*
* Imagine you want to add and link that sends you to a page were you can
* edit the object. The link forwards to an action and that action needs to
* know which is the object you want ot edit. Supposing that each object as
* an id you may have a configuration similar to:
*
*
* link(edit) = "/edit.do"
* param(edit) = "id"
*
*
* The result will be a link that will point to
* <module>/edit.do?id=<object id>: were the id
* param will be different for each object shown in the table.
*
*
* The param property supports two more features. It allows you
* to choose the name of the link parameter and explicitly give new
* parameters. You can specify several parameters by separating the with a
* comma. The full syntax of the param property is:
*
*
* <slot>[/<name>]?[=<value>]?
*
*
*
* slot- specifies the name of the object's slot from were the value will be
* retrieved. In the example above each object needed to have a
*
getId() method.
*
* name- specifies the name of the parameters that will appended to the link.
* If this parts is not given the slot name will be used.
*
* value- allows you to override the value of the parameters. If you specify
* this part then
slot does not need to be a real slot of the
* object.
*
*
* @property
*/
public void setParam(String name, String value) {
getTableLink(name).setParam(value);
}
public String getKey(String name) {
return getTableLink(name).getKey();
}
/**
* The resource key that will be used to find the link name, that is, the
* name that will appear in the table.
*
* @property
*/
public void setKey(String name, String value) {
getTableLink(name).setKey(value);
}
public String getBundle(String name) {
return getTableLink(name).getBundle();
}
/**
* If the module's default bundle is not to be used you can indicate the
* alternative bundle with this property.
*
* @property
*/
public void setBundle(String name, String value) {
getTableLink(name).setBundle(value);
}
public String getText(String name) {
return getTableLink(name).getText();
}
/**
* An alternative to the {@link #setKey(String, String) key} property is
* specifying the text to appear directly. Oviously this approach does not
* work well with internationalized interfaces.
*
* @property
*/
public void setText(String name, String value) {
getTableLink(name).setText(value);
}
public String getOrder(String name) {
return getTableLink(name).getOrder();
}
/**
* As the container make no guarantees about the order properties are set in
* the implementation we can't rely on the order links appear defined in the
* page. You can use this attribute to explicitly indicate the order link
* should appear. The value is not important and it's only used for an
* alfabethic comparison. Both the following examples indicate that the
* links should appear in the order: a, c, b.
*
* Example 1:
*
*
* order(a) = "1"
* order(b) = "3"
* order(c) = "2"
*
*
*
* Example 2:
*
*
* order(a) = "first"
* order(b) = "second"
* order(c) = "third"
*
*
* @property
*/
public void setOrder(String name, String value) {
getTableLink(name).setOrder(value);
}
public boolean isExcludedFromFirst(String name) {
return getTableLink(name).isExcludeFromFirst();
}
/**
* This property allows you to exclude a control link from appearing in the
* first line of the generated table.
*
* @property
*/
public void setExcludedFromFirst(String name, String value) {
getTableLink(name).setExcludeFromFirst(new Boolean(value));
}
public boolean isExcludedFromLast(String name) {
return getTableLink(name).isExcludeFromLast();
}
/**
* Specifies the name of the property that will consulted to determine if
* the link should be visible or not. By default all links are visible.
*
* This can be used to have some links that depend on domain logic.
*
* @property
*/
public void setVisibleIf(String name, String value) {
getTableLink(name).setVisibleIf(value);
}
public String getVisibleIf(String name) {
return getTableLink(name).getVisibleIf();
}
/**
* This property does the same work as visibleIf but does the opposite
* logic. If true then the link will not be shown.
*
* @property
*/
public void setVisibleIfNot(String name, String value) {
getTableLink(name).setVisibleIfNot(value);
}
public String getVisibleIfNot(String name) {
return getTableLink(name).getVisibleIfNot();
}
/**
* Specifies the icon for the link
*
* @param name
* @return
*/
public String getIcon(String name) {
return getTableLink(name).getIcon();
}
public void setIcon(String name, String value) {
getTableLink(name).setIcon(value);
}
/**
* This property allows you to exclude a control link from appearing in the
* last line of the generated table.
*
* @property
*/
public void setExcludedFromLast(String name, String value) {
getTableLink(name).setExcludeFromLast(new Boolean(value));
}
public String getSortBy() {
return this.sortBy;
}
/**
* With this property you can set the criteria used to sort the collection
* beeing presented. The accepted syntax for the criteria can be seen in
* {@link RenderUtils#sortCollectionWithCriteria(Collection, String)}.
*
* @property
*/
public void setSortBy(String sortBy) {
this.sortBy = sortBy;
}
public boolean isGroupLinks() {
return groupLinks;
}
/**
* Specifies if the control links ares grouped in a single cell of the
* table. The linkGroupSeparator will be used to separate the control links.
*
* @property
*/
public void setGroupLinks(boolean groupLinks) {
this.groupLinks = groupLinks;
}
public String getLinkGroupSeparator() {
return linkGroupSeparator;
}
/**
* Specifies the separator between links when these are grouped
*
* @property
*/
public void setLinkGroupSeparator(String linkGroupSeparator) {
this.linkGroupSeparator = linkGroupSeparator;
}
public boolean isRowForLinks() {
return this.rowForLinks;
}
/**
* Indicates that the control links should be generated in their own row.
* This forces the links to be grouped and the
* {@link #setLinkGroupSeparator(String) link group separator} to be used so
* you should define that.
*
* @property
*/
public void setRowForLinks(boolean rowForLinks) {
this.rowForLinks = rowForLinks;
setGroupLinks(true);
}
public boolean isCheckable() {
return this.checkable;
}
/**
* This property indicates that each element wil be checkable. This means
* that a check box will be generated in each row allowing to select that
* row. The user will be responsible for wrapping the whole table in a form
* and submiting the form.
*
* @property
*/
public void setCheckable(boolean checkable) {
this.checkable = checkable;
}
public String getCheckboxName() {
return this.checkboxName;
}
/**
* Selects the name of the checkbox when it's generated.
*
* @property
*/
public void setCheckboxName(String checkboxName) {
this.checkboxName = checkboxName;
}
public String getCheckboxValue() {
return this.checkboxValue;
}
/**
* The check box value is in fact a property of the object beeing displayed
* in the row. This is usefull, for example, to have as value an identificer
* of the object.
*
* @property
*/
public void setCheckboxValue(String checkboxValue) {
this.checkboxValue = checkboxValue;
}
public boolean isSelectAllShown() {
return this.selectAllShown;
}
/**
* Indicates that a link to select all checkboxes should be included in the
* presentation. This property is only valid when the
* {@link #setCheckable(boolean) checkable} is true.
*
* @property
*/
public void setSelectAllShown(boolean selectAllShown) {
this.selectAllShown = selectAllShown;
}
public String getSelectAllLocation() {
return this.selectAllLocation;
}
/**
* Chooses where the link should be placed. You can indicate the locations
* as text and the options are top, bottom, or
* both.
*
*
* Example:
* selectAllLocation=both
* selectAllLocation=top, bottom
* selectAllLocation=bottom (the default)
*
* @property
*/
public void setSelectAllLocation(String selectAllLocation) {
this.selectAllLocation = selectAllLocation;
if (this.selectAllLocation != null) {
this.selectAllLocation = this.selectAllLocation.toLowerCase();
}
}
public String getLinkFormat(String name) {
return getTableLink(name).getLinkFormat();
}
/**
* The linkFormat property indicates the format of the control link. The
* params should be inserted in format. When this property is set, the link
* and param properties are ignored
*
*
* Example 1:
*
*
* someAction.do?method=viewDetails&idInternal=${idInternal}
*
*
*
* Example 2:
*
*
* someAction/${someProperty}/${otherProperty}
*
*
* @property
*/
public void setLinkFormat(String name, String value) {
getTableLink(name).setLinkFormat(value);
}
public String getCustomLink(String name) {
return getTableLink(name).getCustom();
}
/**
* If this property is specified all the others are ignored. This property
* allows you to specify the exact content to show as a link. Then content
* will be parsed with the same rules that apply to
* {@link #setLinkFormat(String, String) linkFormat}.
*
* @property
*/
public void setCustomLink(String name, String value) {
getTableLink(name).setCustom(value);
}
public String getContextRelative(String name) {
return Boolean.toString(getTableLink(name).isContextRelative());
}
/**
* The contextRelative property indicates if the specified link is relative
* to the current context or is an external link (e.g.
* https://anotherserver.com/anotherScript)
*
* @property
*/
public void setContextRelative(String name, String value) {
getTableLink(name).setContextRelative(Boolean.parseBoolean(value));
}
public String getHasContext(String name) {
return Boolean.toString(getTableLink(name).getHasContext());
}
/**
* The hasContext property indicates if the specified link should use
* context information
*
* @property
*/
public void setHasContext(String name, String value) {
getTableLink(name).setHasContext(Boolean.parseBoolean(value));
}
/**
* The confirmationTitleKey property indicates the key of the confirmation
* title to show
*
* @property
*/
public void setConfirmationTitleKey(String name, String value) {
getTableLink(name).setConfirmationTitleKey(value);
}
public String getConfirmationTitleKey(String name) {
return getTableLink(name).getConfirmationTitleKey();
}
/**
* The confirmationKey property indicates the key of the confirmation
* message to show
*
* @property
*/
public void setConfirmationKey(String name, String value) {
getTableLink(name).setConfirmationKey(value);
}
public String getConfirmationKey(String name) {
return getTableLink(name).getConfirmationKey();
}
/**
* The confirmationBundle property indicates the bundle for the confirmation
* key message to show
*
* @property
*/
public void setConfirmationBundle(String name, String value) {
getTableLink(name).setConfirmationBundle(value);
}
public String getConfirmationBundle(String name) {
return getTableLink(name).getConfirmationBundle();
}
public String getConfirmationArgs(String name) {
return getTableLink(name).getConfirmationArgs();
}
/**
* The confirmationArgs property indicates the arguments for a link
* confirmation.
*
* @property
*/
public void setConfirmationArgs(String name, String value) {
getTableLink(name).setConfirmationArgs(value);
}
public String getBlankTarget(String name) {
return Boolean.toString(getTableLink(name).getBlankTarget());
}
/**
* The blankTarget property set blank target for a link.
*
* @property
*/
public void setBlankTarget(String name, String value) {
getTableLink(name).setBlankTarget(Boolean.parseBoolean(value));
}
public String getTarget(String name) {
return getTableLink(name).getTarget();
}
/**
* The target property indicates the arguments for a link target. Using
* setBlankTarget will override this value.
*
* @property
*/
public void setTarget(String name, String value) {
getTableLink(name).setTarget(value);
}
protected int getNumberOfLinkColumns() {
if (isRowForLinks()) {
return 0;
} else if (isGroupLinks() && this.links.size() > 0) {
return 1;
} else {
return this.links.size();
}
}
protected int getNumberOfLinks() {
return this.links.size();
}
public ColumnCss getColumnCss(String name) {
ColumnCss columnCss = this.columnCss.get(name);
if (columnCss == null) {
columnCss = new ColumnCss();
this.columnCss.put(name, columnCss);
}
return columnCss;
}
public void setUseCssIf(String name, String property) {
getColumnCss(name).setUseIf(property);
}
public String getUseCssIf(String name) {
return getColumnCss(name).getUseIf();
}
public void setUseCssIfNot(String name, String property) {
getColumnCss(name).setUseIfNot(property);
}
public String getUseCssIfNot(String name) {
return getColumnCss(name).getUseIfNot();
}
public void setColumn(String name, int column) {
getColumnCss(name).setColumnNumber(column);
}
public int getColumn(String name) {
return getColumnCss(name).getColumnNumber();
}
public void setConditionalColumnClass(String name, String cssClasses) {
getColumnCss(name).setStyleClass(cssClasses);
}
public String getConditionalColumnClass(String name) {
return getColumnCss(name).getStyleClass();
}
public Boolean getRenderCompliantTable() {
return renderCompliantTable;
}
public void setRenderCompliantTable(Boolean renderCompliantTable) {
this.renderCompliantTable = renderCompliantTable;
}
public int getPageSize() {
return pageSize;
}
public void setPageSize(int pageSize) {
this.pageSize = pageSize;
this.pagedLayout = true;
}
public String getPagingAction() {
return pagingAction;
}
public void setPagingAction(String pagingAction) {
this.pagingAction = pagingAction;
this.pagedLayout = true;
}
public int getActualPage() {
return actualPage;
}
public void setActualPage(int actualPage) {
this.actualPage = actualPage;
}
public String getPagerClasses() {
return pagerClasses;
}
public void setPagerClasses(String pagerClasses) {
this.pagerClasses = pagerClasses;
}
public List getColumnCssFor(int columnIndex) {
List csses = new ArrayList();
for (ColumnCss columnCss : this.columnCss.values()) {
if (columnCss.getColumnNumber() == columnIndex) {
csses.add(columnCss);
}
}
return csses;
}
public boolean isConfirmationUsed() {
for (TableLink link : links.values()) {
if (link.getConfirmationKey() != null) {
return true;
}
}
return false;
}
@Override
protected Layout getLayout(Object object, Class type) {
Collection sortedCollection = RenderUtils.sortCollectionWithCriteria((Collection) object, getSortBy());
Collection pagedSortedCollection = checkForPager(sortedCollection);
if (pagedSortedCollection != null) {
sortedCollection = pagedSortedCollection;
}
return new CollectionTabularLayout(sortedCollection);
}
protected Collection checkForPager(Collection sortedCollection) {
Collection result = null;
if (pagedLayout) {
pager = new CollectionPager(sortedCollection, pageSize);
numberOfPages = pager.getNumberOfPages();
final Integer page = actualPage == 0 ? Integer.valueOf(1) : Integer.valueOf(actualPage);
result = pager.getPage(page);
}
return result;
}
public class CollectionTabularLayout extends TabularLayout {
List metaObjects;
@Override
public HtmlComponent createComponent(Object object, Class type) {
if (pagedLayout) {
HtmlBlockContainer htmlBlockContainer = new HtmlBlockContainer();
HtmlComponent linksComponent = generateLinksComponent(object);
htmlBlockContainer.addChild(linksComponent);
htmlBlockContainer.addChild(super.createComponent(object, type));
htmlBlockContainer.addChild(linksComponent);
return htmlBlockContainer;
}
return super.createComponent(object, type);
}
@Override
public void applyStyle(HtmlComponent component) {
if (pagedLayout) {
component.getChild(new Predicate() {
@Override
public boolean evaluate(Object arg0) {
return arg0 instanceof HtmlTable;
}
}).setClasses(getClasses());
} else {
component.setClasses(getClasses());
}
component.setStyle(getStyle());
component.setTitle(getTitle());
super.applyStyle(component);
}
public CollectionTabularLayout(Collection object) {
this.metaObjects = getMetaObjects(object);
}
private List getMetaObjects(Collection collection) {
List metaObjects = new ArrayList();
MetaObject contextMetaObject = getContext().getMetaObject();
if (contextMetaObject instanceof MetaObjectCollection) {
// reuse meta objects
MetaObjectCollection multipleMetaObject = (MetaObjectCollection) getContext().getMetaObject();
for (Object object : collection) {
for (MetaObject metaObject : multipleMetaObject.getAllMetaObjects()) {
if (object.equals(metaObject.getObject())) {
metaObjects.add(metaObject);
break;
}
}
}
} else {
Schema schema = getContext().getSchema();
for (Object object : collection) {
metaObjects.add(MetaObjectFactory.createObject(object, schema));
}
}
return metaObjects;
}
@Override
public HtmlComponent createLayout(Object object, Class type) {
HtmlComponent component = super.createLayout(object, type);
setExtraComponentOptions(object, component, type);
if (component instanceof HtmlTable) {
((HtmlTable) component).setRenderCompliantTable(getRenderCompliantTable());
}
if (isConfirmationUsed()) {
HtmlBlockContainer container = new HtmlBlockContainer();
addScripts(container);
container.addChild(component);
component = container;
}
if (isCheckable() && isSelectAllShown()) {
HtmlBlockContainer container = new HtmlBlockContainer();
HtmlComponent selectAllComponent = createInvertSelectionLink();
if (String.valueOf(getSelectAllLocation()).contains(LOCATION_TOP)
|| String.valueOf(getSelectAllLocation()).contains(LOCATION_BOTH)) {
container.addChild(selectAllComponent);
}
container.addChild(component);
if (String.valueOf(getSelectAllLocation()).contains(LOCATION_BOTTOM)
|| String.valueOf(getSelectAllLocation()).contains(LOCATION_BOTH)) {
container.addChild(selectAllComponent);
}
return container;
} else {
return component;
}
}
protected void setExtraComponentOptions(Object object, HtmlComponent component, Class type) {
if (component instanceof HtmlTable) {
((HtmlTable) component).setRenderCompliantTable(getRenderCompliantTable());
}
}
protected void addScripts(HtmlContainer container) {
HtmlLink link = new HtmlLink();
link.setModuleRelative(false);
link.setContextRelative(true);
String[] scriptNames = new String[] { "jquery.ui.draggable.js", "jquery.alerts.js", "alertHandlers.js" };
for (String script : scriptNames) {
addSingleScript(container, link, script);
}
}
private void addSingleScript(HtmlContainer container, HtmlLink link, String scriptName) {
link.setUrl("/javaScript/" + scriptName);
HtmlScript script = new HtmlScript("text/javascript", link.calculateUrl(), true);
container.addChild(script);
}
private HtmlComponent createInvertSelectionLink() {
HtmlInlineContainer container = new HtmlInlineContainer();
HtmlScript script = new HtmlScript();
script.setContentType("text/javascript");
script.setConditional(true);
script.setScript("function invertSelectionAll(n) {" + " var allChecked = true;"
+ " var elements = document.getElementsByName(n);" + "\n"
+ " for (var index=0; index 0 : false;
}
@Override
protected int getNumberOfColumns() {
if (this.metaObjects.size() > 0) {
MetaObject metaObject = this.metaObjects.get(0);
return metaObject.getSlots().size() + getNumberOfLinkColumns() + (isCheckable() ? 1 : 0);
} else {
return 0;
}
}
@Override
protected int getNumberOfRows() {
if (isRowForLinks()) {
return this.metaObjects.size() * 2;
} else {
return this.metaObjects.size();
}
}
protected MetaObject getObject(int index) {
return this.metaObjects.get(index);
}
@Override
protected HtmlComponent getHeaderComponent(int columnIndex) {
if (columnIndex == 0 && isCheckable()) {
return new HtmlText();
} else if (columnIndex < getNumberOfColumns() - getNumberOfLinkColumns()) {
HtmlLabel label = new HtmlLabel();
MetaSlot metaSlot = getObject(0).getSlots().get(columnIndex - (isCheckable() ? 1 : 0));
label.setFor(metaSlot.getKey().toString());
label.setTitle(metaSlot.getTitle());
HtmlText text = new HtmlText();
text.setEscaped(false);
if (!metaSlot.isReadOnly()) {
text.setText(getLabel(columnIndex) + (metaSlot.isRequired() ? " (*)" : ""));
} else {
text.setText(getLabel(columnIndex));
}
label.setBody(text);
return label;
} else {
return new HtmlText();
}
}
private String getHeaderToolTip(final int columnIndex) {
MetaSlot metaSlot = this.metaObjects.get(0).getSlots().get(columnIndex - (isCheckable() ? 1 : 0));
String headerToolTip = metaSlot.getProperties() == null ? StringUtils.EMPTY : metaSlot.getProperties().getProperty(
"headerToolTip");
if (!StringUtils.isEmpty(headerToolTip)) {
return " [?]"
+ RenderUtils.getResourceString(metaSlot.getBundle(), headerToolTip) + "";
}
return StringUtils.EMPTY;
}
protected String getLabel(int columnIndex) {
int realIndex = columnIndex - (isCheckable() ? 1 : 0);
if (realIndex >= 0) {
return getObject(0).getSlots().get(realIndex).getLabel() + getHeaderToolTip(columnIndex);
} else {
return "";
}
}
@Override
protected void costumizeCell(HtmlTableCell cell, int rowIndex, int columnIndex) {
super.costumizeCell(cell, rowIndex, columnIndex);
if (isRowForLinks() && rowIndex % 2 == 1) { // links in isolated row
cell.setColspan(getNumberOfColumns());
}
}
@Override
protected HtmlComponent getComponent(int rowIndex, int columnIndex) {
int objectRow = isRowForLinks() ? rowIndex / 2 : rowIndex;
MetaObject object = getObject(objectRow);
getContext().setMetaObject(object);
if (isRowForLinks() && rowIndex % 2 == 1) { // links in isolated row
return generateLinkComponent(object, rowIndex, columnIndex);
}
if (columnIndex == 0 && isCheckable()) {
HtmlCheckBox checkBox = new HtmlCheckBox();
checkBox.setName(getCheckboxName());
if (getCheckboxValue() != null) {
Object realObject = object.getObject();
try {
String checkBoxValue = String.valueOf(PropertyUtils.getProperty(realObject, getCheckboxValue()));
boolean checked = false;
String[] existingValues = getContext().getViewState().getRequest().getParameterValues(getCheckboxName());
if (existingValues != null) {
for (int i = 0; i < existingValues.length; i++) {
String value = existingValues[i];
if (value.equals(checkBoxValue)) {
checked = true;
break;
}
}
}
checkBox.setChecked(checked);
checkBox.setUserValue(checkBoxValue);
} catch (Exception e) {
throw new RuntimeException("could not set check box value by reading property '" + getCheckboxValue()
+ "' from object " + realObject, e);
}
}
return checkBox;
} else if (columnIndex < getNumberOfColumns() - getNumberOfLinkColumns()) {
return generateObjectComponent(columnIndex - (isCheckable() ? 1 : 0), object);
} else {
return generateLinkComponent(object, rowIndex, columnIndex - (getNumberOfColumns() - getNumberOfLinkColumns()));
}
}
@Override
protected String getCellClasses(int rowIndex, int columnIndex) {
int objectRow = isRowForLinks() ? rowIndex / 2 : rowIndex;
MetaObject object = getObject(objectRow);
if (isRowForLinks() && rowIndex % 2 == 1) {
// links dont support classes yet
return null;
}
if (columnIndex == 0 && isCheckable()) {
// checkboxes dont support classes yet
return null;
} else if (columnIndex < getNumberOfColumns() - getNumberOfLinkColumns()) {
String styleClass = null;
for (ColumnCss columnCss : getColumnCssFor(columnIndex)) {
if (canApplyConditionalClasses(object, columnCss)) {
styleClass = ((styleClass != null) ? styleClass + " " : "") + columnCss.getStyleClass();
}
}
return styleClass;
}
return null;
}
protected HtmlComponent generateObjectComponent(int columnIndex, MetaObject object) {
MetaSlot slot = getSlotUsingName(object, columnIndex);
if (slot == null) {
return new HtmlText();
}
HtmlComponent component = renderSlot(slot);
component = wrapPrefixAndSuffix(component, columnIndex);
return component;
}
private boolean canApplyConditionalClasses(MetaObject metaObject, ColumnCss columnCss) {
Boolean useIf = ((columnCss.getUseIf() != null) && (Boolean) RendererPropertyUtils.getProperty(
metaObject.getObject(), columnCss.getUseIf(), false));
Boolean useIfNot = ((columnCss.getUseIfNot() != null) && (Boolean) RendererPropertyUtils.getProperty(
metaObject.getObject(), columnCss.getUseIfNot(), false));
return useIf || !useIfNot;
}
/**
* As the renderer uses the first object as a reference to build the
* header and fecth the information from all the objects in the
* collection we can have troubles when the collection contains objects
* of different types.
*
* In this case we can't assume that all objects have the same slots
* (because of an unspecified schema). So we have to search slots by
* name and hope that it makes sense in the table.
*/
protected MetaSlot getSlotUsingName(MetaObject object, int columnIndex) {
MetaObject referenceObject = getObject(0);
MetaSlot referenceSlot = referenceObject.getSlots().get(columnIndex);
MetaSlot directSlot = object.getSlots().get(columnIndex); // common
// case
if (directSlot.getName().equals(referenceSlot.getName())) {
return directSlot;
}
for (MetaSlot slot : object.getSlots()) {
if (slot.getName().equals(referenceSlot.getName())) {
return slot;
}
}
return null;
}
protected HtmlComponent generateLinkComponent(MetaObject object, int rowIndex, int number) {
if (isGroupLinks() || isRowForLinks()) {
HtmlInlineContainer container = new HtmlInlineContainer();
container.setIndented(false);
boolean includeSeparator = false;
for (int i = 0; i < getNumberOfLinks(); i++) {
HtmlComponent component = generateSingleLinkComponent(object, rowIndex, i);
if (component != null) {
if (includeSeparator) {
container.addChild(new HtmlText(getLinkGroupSeparator(), false));
}
container.addChild(component);
includeSeparator = true;
}
}
return container;
} else {
HtmlComponent component = generateSingleLinkComponent(object, rowIndex, number);
return component == null ? new HtmlText() : component;
}
}
protected HtmlComponent generateSingleLinkComponent(MetaObject object, int rowIndex, int number) {
TableLink tableLink = getTableLink(number);
if (rowIndex == 0 && tableLink.isExcludeFromFirst()) {
return null;
}
if (rowIndex == getNumberOfRows() - 1 && tableLink.isExcludeFromLast()) {
return null;
}
return tableLink.generateLink(object.getObject());
}
protected HtmlComponent wrapPrefixAndSuffix(HtmlComponent component, int columnIndex) {
HtmlInlineContainer container = null;
String prefix = getStringPart(getPrefixes(), columnIndex);
if (prefix != null) {
container = new HtmlInlineContainer();
container.addChild(new HtmlText(prefix));
container.addChild(component);
}
String suffix = getStringPart(getSuffixes(), columnIndex);
if (suffix != null) {
if (container != null) {
container.addChild(new HtmlText(suffix));
} else {
container = new HtmlInlineContainer();
container.addChild(component);
container.addChild(new HtmlText(suffix));
}
}
return container != null ? container : component;
}
}
public HtmlComponent generateLinksComponent(Object object) {
HtmlBlockContainer container = new HtmlBlockContainer();
if (actualPage == 1) {
HtmlInlineContainer spanBack = new HtmlInlineContainer();
HtmlText goBack = new HtmlText("<<");
spanBack.addChild(goBack);
container.addChild(spanBack);
HtmlInlineContainer spanPrev = new HtmlInlineContainer();
HtmlText goPrev = new HtmlText("<");
spanPrev.addChild(goPrev);
container.addChild(spanPrev);
} else {
HtmlLink linkBack = new HtmlLink();
linkBack.setText("<<");
linkBack.setUrl(getPagingAction() + "&actualPage=1");
container.addChild(linkBack);
HtmlLink linkPrev = new HtmlLink();
linkPrev.setText("<");
linkPrev.setUrl(getPagingAction() + "&actualPage=" + (getActualPage() - 1));
container.addChild(linkPrev);
}
HtmlLink linkPages;
int start = 0;
if (actualPage < 3) {
start = 1;
} else if (actualPage > numberOfPages - 3) {
start = numberOfPages - 4;
} else {
start = actualPage - 2;
}
int end = start + 4;
if (end > numberOfPages) {
end = numberOfPages;
}
for (int i = start; i <= end; i++) {
if (i == actualPage) {
HtmlInlineContainer spanPage = new HtmlInlineContainer();
HtmlText presentPage = new HtmlText(String.valueOf(i));
spanPage.addChild(presentPage);
container.addChild(spanPage);
continue;
}
linkPages = new HtmlLink();
linkPages.setText(String.valueOf(i));
linkPages.setUrl(getPagingAction() + "&actualPage=" + String.valueOf(i));
container.addChild(linkPages);
}
if (actualPage == numberOfPages) {
HtmlInlineContainer spanNext = new HtmlInlineContainer();
HtmlText goNext = new HtmlText(">");
spanNext.addChild(goNext);
container.addChild(spanNext);
HtmlInlineContainer spanForth = new HtmlInlineContainer();
HtmlText goForth = new HtmlText(">>");
spanForth.addChild(goForth);
container.addChild(spanForth);
} else {
HtmlLink linkNext = new HtmlLink();
linkNext.setText(">");
linkNext.setUrl(getPagingAction() + "&actualPage=" + (getActualPage() + 1));
container.addChild(linkNext);
HtmlLink linkForth = new HtmlLink();
linkForth.setText(">>");
linkForth.setUrl(getPagingAction() + "&actualPage=" + numberOfPages);
container.addChild(linkForth);
}
container.setClasses(getPagerClasses());
return container;
}
public static class ColumnCss {
private int columnNumber;
private String useIf;
private String useIfNot;
private String styleClass;
public int getColumnNumber() {
return columnNumber;
}
public void setColumnNumber(int columnNumber) {
this.columnNumber = columnNumber;
}
public String getUseIf() {
return useIf;
}
public void setUseIf(String useIf) {
this.useIf = useIf;
}
public String getStyleClass() {
return styleClass;
}
public void setStyleClass(String styleClass) {
this.styleClass = styleClass;
}
public String getUseIfNot() {
return useIfNot;
}
public void setUseIfNot(String useIfNot) {
this.useIfNot = useIfNot;
}
}
public static class TableLink implements Comparable {
private String name;
private String link;
private String module;
private String param;
private String text;
private String key;
private String bundle;
private String order;
private boolean excludeFromFirst;
private boolean excludeFromLast;
private String linkFormat;
private Boolean contextRelative;
private Boolean hasContext = false;
private String custom;
private String visibleIf;
private String visibleIfNot;
private String confirmationKey;
private String confirmationBundle;
private String confirmationArgs;
private String confirmationTitleKey;
private String icon;
private String counter;
private Boolean blankTarget = false;
private String target;
public String getConfirmationTitleKey() {
return confirmationTitleKey;
}
public void setConfirmationTitleKey(String confirmationTitle) {
this.confirmationTitleKey = confirmationTitle;
}
public TableLink() {
super();
this.excludeFromFirst = false;
this.excludeFromLast = false;
}
public TableLink(String name) {
this.name = name;
}
public String getName() {
return this.name;
}
public void setName(String name) {
this.name = name;
}
public String getBundle() {
return this.bundle;
}
public void setBundle(String bundle) {
this.bundle = bundle;
}
public String getKey() {
return this.key;
}
public void setKey(String key) {
this.key = key;
}
public String getLink() {
return this.link;
}
public void setLink(String link) {
this.link = link;
}
public String getModule() {
return this.module;
}
public void setModule(String module) {
this.module = module;
}
public String getParam() {
return this.param;
}
public void setParam(String param) {
this.param = param;
}
public String getText() {
return this.text;
}
public void setText(String text) {
this.text = text;
}
public String getOrder() {
return this.order;
}
public void setOrder(String order) {
this.order = order;
}
public boolean isExcludeFromFirst() {
return this.excludeFromFirst;
}
public void setExcludeFromFirst(boolean excludeFromFirst) {
this.excludeFromFirst = excludeFromFirst;
}
public boolean isExcludeFromLast() {
return this.excludeFromLast;
}
public void setExcludeFromLast(boolean excludeFromLast) {
this.excludeFromLast = excludeFromLast;
}
public String getLinkFormat() {
return linkFormat;
}
public void setLinkFormat(String linkFormat) {
this.linkFormat = linkFormat;
}
public String getVisibleIf() {
return this.visibleIf;
}
public void setVisibleIf(String visibleIf) {
this.visibleIf = visibleIf;
}
public String getVisibleIfNot() {
return this.visibleIfNot;
}
public void setVisibleIfNot(String visibleIfNot) {
this.visibleIfNot = visibleIfNot;
}
public Boolean isContextRelative() {
return contextRelative;
}
public void setContextRelative(Boolean contextRelative) {
this.contextRelative = contextRelative;
}
public boolean isContextRelativeSet() {
return this.contextRelative != null;
}
public Boolean getHasContext() {
return hasContext;
}
public void setHasContext(Boolean hasContext) {
this.hasContext = hasContext;
}
public String getCustom() {
return this.custom;
}
public void setCustom(String custom) {
this.custom = custom;
}
public String getConfirmationKey() {
return confirmationKey;
}
public void setConfirmationKey(String confirmationKey) {
this.confirmationKey = confirmationKey;
}
public String getConfirmationBundle() {
return confirmationBundle;
}
public void setConfirmationBundle(String confirmationBundle) {
this.confirmationBundle = confirmationBundle;
}
public String getConfirmationArgs() {
return confirmationArgs;
}
public void setConfirmationArgs(String confirmationArgs) {
this.confirmationArgs = confirmationArgs;
}
public Boolean getBlankTarget() {
return blankTarget;
}
public void setBlankTarget(Boolean blankTarget) {
this.blankTarget = blankTarget;
}
public String getTarget() {
return target;
}
public void setTarget(String target) {
this.target = target;
}
public String getIcon() {
return this.icon;
}
public void setIcon(final String value) {
this.icon = value;
}
@Override
public int compareTo(TableLink other) {
if (getOrder() == null) {
return 0;
}
if (other.getOrder() == null) {
return 0;
}
return getOrder().compareTo(other.getOrder());
}
public HtmlComponent generateLink(Object object) {
if (getVisibleIf() != null) {
try {
Boolean visible = (Boolean) RendererPropertyUtils.getProperty(object, this.getVisibleIf(), false);
if (visible != null && !visible) {
return null;
}
} catch (ClassCastException e) {
e.printStackTrace();
}
}
if (getVisibleIfNot() != null) {
try {
Boolean notVisible = (Boolean) RendererPropertyUtils.getProperty(object, getVisibleIfNot(), false);
if (notVisible != null && notVisible) {
return null;
}
} catch (ClassCastException e) {
e.printStackTrace();
}
}
if (getCustom() != null) {
return new HtmlText(RenderUtils.getFormattedProperties(getCustom(), object), false);
} else {
final HtmlLink link = getHasContext() ? new HtmlLinkWithPreprendedComment(RequestRewriter.HAS_CONTEXT_PREFIX)
: new HtmlLink();
if (isContextRelativeSet()) {
link.setContextRelative(isContextRelative());
}
if (getBlankTarget().booleanValue()) {
link.setTarget(Target.BLANK);
} else if (getTarget() != null && !getTarget().isEmpty()) {
link.setTarget(getTarget());
}
if (getIcon() != null && !getIcon().equals("none")) {
HtmlLink forImage = new HtmlLink();
forImage.setModuleRelative(false);
forImage.setContextRelative(true);
forImage.setUrl("/images/" + getIcon() + ".gif");
HtmlImage image = new HtmlImage();
image.setSource(forImage.calculateUrl());
image.setDescription(getLinkText(this, object));
link.setBody(image);
} else {
link.setText(getLinkText(this, object));
}
link.setModule(getModule());
if (getLinkFormat() != null) {
link.setUrl(RenderUtils.getFormattedProperties(getLinkFormat(), object));
} else {
link.setUrl(getLink());
setLinkParameters(object, link, this);
}
if (getConfirmationKey() != null) {
String arguments = getConfirmationArgs() != null ? getConfirmationArgs() : "";
String[] argumentsArray = arguments.split(",");
String[] formattedArgsArray = new String[argumentsArray.length];
for (int i = 0; i < argumentsArray.length; i++) {
formattedArgsArray[i] = RenderUtils.getFormattedProperties(argumentsArray[i], object);
}
if (link.getId() == null) {
link.setId(getName() + "-" + object.hashCode());
}
final String confirmationMessage = getConfirmationBundle() != null ? RenderUtils.getResourceString(
getConfirmationBundle(), getConfirmationKey(), formattedArgsArray) : RenderUtils
.getResourceString(getConfirmationKey());
final String confirmationTitle = getConfirmationBundle() != null ? RenderUtils.getResourceString(
getConfirmationBundle(), getConfirmationTitleKey()) : RenderUtils
.getResourceString(getConfirmationTitleKey());
HtmlInlineContainer container = new HtmlInlineContainer();
container.addChild(link);
String scriptText = "linkConfirmationHook('" + link.getId() + "','"
+ (confirmationMessage != null ? confirmationMessage : "") + "', '"
+ (confirmationTitle != null ? confirmationTitle : "") + "');";
HtmlScript script = new HtmlScript();
script.setContentType("text/javascript");
script.setScript(scriptText);
container.addChild(script);
return container;
}
return link;
}
}
public String getLinkText(TableLink tableLink, Object object) {
String text = tableLink.getText();
if (text != null) {
return text;
}
String key = tableLink.getKey();
String bundle = tableLink.getBundle();
if (key == null) {
return tableLink.getName();
}
text = RenderUtils.getResourceString(bundle, key);
if (text == null) {
text = tableLink.getName();
}
return getCounter() != null ? text + RenderUtils.getFormattedProperties(getCounter(), object) : text;
}
protected void setLinkParameters(Object object, HtmlLink link, TableLink tableLink) {
String linkParam = tableLink.getParam();
if (linkParam == null) {
return;
}
String parameters[] = tableLink.getParam().split(",");
// "a", "a=b", "a/b", "a/b=c"
for (int i = 0; i < parameters.length; i++) {
String name = parameters[i];
String slotName;
String realName;
String customValue;
String[] parameterParts = name.split("=", -1);
if (parameterParts.length >= 1) {
String[] nameParts = parameterParts[0].split("/");
slotName = nameParts[0];
if (nameParts.length == 2) {
realName = nameParts[1];
} else {
realName = slotName;
}
if (parameterParts.length > 1) {
customValue = parameterParts[1];
} else {
customValue = null;
}
} else {
slotName = parameterParts[0];
realName = parameterParts[0];
customValue = null;
}
try {
String value = customValue != null ? customValue : String
.valueOf(PropertyUtils.getProperty(object, slotName));
if (value != null) {
link.setParameter(realName, value);
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
public void setCounter(String counter) {
this.counter = counter;
}
public String getCounter() {
return counter;
}
}
}