/*****************************************************************
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
****************************************************************/
package org.apache.cayenne.modeler.editor;
import java.awt.BorderLayout;
import java.awt.Color;
import java.awt.Component;
import java.awt.Font;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.util.ArrayList;
import java.util.Collection;
import java.util.EventObject;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import javax.swing.Icon;
import javax.swing.ImageIcon;
import javax.swing.JButton;
import javax.swing.JComboBox;
import javax.swing.JPanel;
import javax.swing.JPopupMenu;
import javax.swing.JTable;
import javax.swing.JToolBar;
import javax.swing.event.ChangeEvent;
import javax.swing.event.ListSelectionEvent;
import javax.swing.event.ListSelectionListener;
import javax.swing.table.DefaultTableCellRenderer;
import javax.swing.table.TableCellEditor;
import javax.swing.table.TableColumn;
import org.apache.cayenne.configuration.DataChannelDescriptor;
import org.apache.cayenne.map.DataMap;
import org.apache.cayenne.map.Embeddable;
import org.apache.cayenne.map.ObjAttribute;
import org.apache.cayenne.map.ObjEntity;
import org.apache.cayenne.map.event.AttributeEvent;
import org.apache.cayenne.map.event.EntityEvent;
import org.apache.cayenne.map.event.ObjAttributeListener;
import org.apache.cayenne.map.event.ObjEntityListener;
import org.apache.cayenne.modeler.Application;
import org.apache.cayenne.modeler.ProjectController;
import org.apache.cayenne.modeler.action.ActionManager;
import org.apache.cayenne.modeler.action.CopyAttributeAction;
import org.apache.cayenne.modeler.action.CreateAttributeAction;
import org.apache.cayenne.modeler.action.CutAttributeAction;
import org.apache.cayenne.modeler.action.ObjEntityCounterpartAction;
import org.apache.cayenne.modeler.action.ObjEntitySyncAction;
import org.apache.cayenne.modeler.action.PasteAction;
import org.apache.cayenne.modeler.action.RemoveAttributeAction;
import org.apache.cayenne.modeler.dialog.objentity.ObjAttributeInfoDialog;
import org.apache.cayenne.modeler.event.AttributeDisplayEvent;
import org.apache.cayenne.modeler.event.EntityDisplayEvent;
import org.apache.cayenne.modeler.event.ObjEntityDisplayListener;
import org.apache.cayenne.modeler.event.TablePopupHandler;
import org.apache.cayenne.modeler.pref.TableColumnPreferences;
import org.apache.cayenne.modeler.util.CayenneTable;
import org.apache.cayenne.modeler.util.ModelerUtil;
import org.apache.cayenne.modeler.util.PanelFactory;
import org.apache.cayenne.modeler.util.UIUtil;
import org.apache.cayenne.modeler.util.combo.AutoCompletion;
/**
* Detail view of the ObjEntity attributes.
*
*/
public class ObjEntityAttributeTab extends JPanel implements ObjEntityDisplayListener,
ObjEntityListener, ObjAttributeListener, ExistingSelectionProcessor {
protected ProjectController mediator;
protected CayenneTable table;
private TableColumnPreferences tablePreferences;
JButton resolve;
public ObjEntityAttributeTab(ProjectController mediator) {
this.mediator = mediator;
init();
initController();
}
private void init() {
this.setLayout(new BorderLayout());
JToolBar toolBar = new JToolBar();
ActionManager actionManager = Application.getInstance().getActionManager();
toolBar.add(actionManager.getAction(CreateAttributeAction.class).buildButton());
toolBar.add(actionManager.getAction(ObjEntitySyncAction.class).buildButton());
toolBar.add(actionManager.getAction(ObjEntityCounterpartAction.class).buildButton());
toolBar.addSeparator();
Icon ico = ModelerUtil.buildIcon("icon-info.gif");
resolve = new JButton();
resolve.setIcon(ico);
resolve.setToolTipText("Edit Attribute");
toolBar.add(resolve);
toolBar.addSeparator();
toolBar.add(actionManager.getAction(RemoveAttributeAction.class).buildButton());
toolBar.addSeparator();
toolBar.add(actionManager.getAction(CutAttributeAction.class).buildButton());
toolBar.add(actionManager.getAction(CopyAttributeAction.class).buildButton());
toolBar.add(actionManager.getAction(PasteAction.class).buildButton());
add(toolBar, BorderLayout.NORTH);
table = new CayenneTable();
table.setDefaultRenderer(String.class, new CellRenderer());
tablePreferences = new TableColumnPreferences(
ObjAttributeTableModel.class,
"objEntity/attributeTable");
// Create and install a popup
JPopupMenu popup = new JPopupMenu();
popup.add(actionManager.getAction(RemoveAttributeAction.class).buildMenu());
popup.addSeparator();
popup.add(actionManager.getAction(CutAttributeAction.class).buildMenu());
popup.add(actionManager.getAction(CopyAttributeAction.class).buildMenu());
popup.add(actionManager.getAction(PasteAction.class).buildMenu());
TablePopupHandler.install(table, popup);
add(PanelFactory.createTablePanel(table, null), BorderLayout.CENTER);
}
private void initController() {
mediator.addObjEntityDisplayListener(this);
mediator.addObjEntityListener(this);
mediator.addObjAttributeListener(this);
table.getSelectionModel().addListSelectionListener(new ListSelectionListener() {
public void valueChanged(ListSelectionEvent e) {
processExistingSelection(e);
}
});
ActionListener resolver = new ActionListener() {
public void actionPerformed(ActionEvent e) {
int row = table.getSelectedRow();
if (row < 0) {
return;
}
ObjAttributeTableModel model = (ObjAttributeTableModel) table.getModel();
// ... show dialog...
new ObjAttributeInfoDialog(mediator, row, model).startupAction();
/**
* This is required for a table to be updated properly
*/
table.cancelEditing();
// need to refresh selected row... do this by unselecting/selecting the
// row
table.getSelectionModel().clearSelection();
table.select(row);
}
};
resolve.addActionListener(resolver);
ActionManager actionManager = Application.getInstance().getActionManager();
actionManager.setupCutCopyPaste(
table,
CutAttributeAction.class,
CopyAttributeAction.class);
}
public void initComboBoxes(ObjAttributeTableModel model) {
List<String> embeddableNames = new ArrayList<String>();
List<String> typeNames = new ArrayList<String>();
Iterator it = ((DataChannelDescriptor) mediator.getProject().getRootNode())
.getDataMaps()
.iterator();
while (it.hasNext()) {
DataMap dataMap = (DataMap) it.next();
Iterator<Embeddable> embs = dataMap.getEmbeddables().iterator();
while (embs.hasNext()) {
Embeddable emb = (Embeddable) embs.next();
embeddableNames.add(emb.getClassName());
}
}
String[] registeredTypes = ModelerUtil.getRegisteredTypeNames();
for (int i = 0; i < registeredTypes.length; i++) {
typeNames.add(registeredTypes[i]);
}
typeNames.addAll(embeddableNames);
TableColumn typeColumn = table.getColumnModel().getColumn(
ObjAttributeTableModel.OBJ_ATTRIBUTE_TYPE);
JComboBox javaTypesCombo = Application.getWidgetFactory().createComboBox(
typeNames.toArray(),
false);
AutoCompletion.enable(javaTypesCombo, false, true);
typeColumn.setCellEditor(Application.getWidgetFactory().createCellEditor(
javaTypesCombo));
if (model.getEntity().getDbEntity() != null) {
Collection<String> nameAttr = ModelerUtil.getDbAttributeNames(mediator, model
.getEntity()
.getDbEntity());
model.setCellEditor(nameAttr, table);
model.setComboBoxes(nameAttr, ObjAttributeTableModel.DB_ATTRIBUTE);
}
}
/**
* Selects a specified attribute.
*/
public void selectAttributes(ObjAttribute[] attrs) {
ModelerUtil.updateActions(
attrs.length,
RemoveAttributeAction.class,
CutAttributeAction.class,
CopyAttributeAction.class);
ObjAttributeTableModel model = (ObjAttributeTableModel) table.getModel();
List listAttrs = model.getObjectList();
int[] newSel = new int[attrs.length];
for (int i = 0; i < attrs.length; i++) {
newSel[i] = listAttrs.indexOf(attrs[i]);
}
table.select(newSel);
}
public void processExistingSelection(EventObject e) {
// hasn't been initialized yet, nothing to do
if (!(table.getModel() instanceof ObjAttributeTableModel)) {
return;
}
if (e instanceof ChangeEvent) {
table.clearSelection();
}
ObjAttribute[] attrs = new ObjAttribute[0];
if (table.getSelectedRow() >= 0) {
ObjAttributeTableModel model = (ObjAttributeTableModel) table.getModel();
int[] sel = table.getSelectedRows();
attrs = new ObjAttribute[sel.length];
for (int i = 0; i < sel.length; i++) {
attrs[i] = model.getAttribute(sel[i]);
}
if (sel.length == 1) {
// scroll table
UIUtil.scrollToSelectedRow(table);
resolve.setEnabled(true);
}
else {
resolve.setEnabled(false);
}
}
else {
resolve.setEnabled(false);
}
AttributeDisplayEvent ev = new AttributeDisplayEvent(
this,
attrs,
mediator.getCurrentObjEntity(),
mediator.getCurrentDataMap(),
(DataChannelDescriptor) mediator.getProject().getRootNode());
mediator.fireObjAttributeDisplayEvent(ev);
}
public void objAttributeChanged(AttributeEvent e) {
rebuildTable((ObjEntity) e.getEntity());
table.select(e.getAttribute());
}
public void objAttributeAdded(AttributeEvent e) {
rebuildTable((ObjEntity) e.getEntity());
table.select(e.getAttribute());
}
public void objAttributeRemoved(AttributeEvent e) {
ObjAttributeTableModel model = (ObjAttributeTableModel) table.getModel();
int ind = model.getObjectList().indexOf(e.getAttribute());
model.removeRow(e.getAttribute());
table.select(ind);
}
public void currentObjEntityChanged(EntityDisplayEvent e) {
if (e.getSource() == this) {
return;
}
ObjEntity entity = (ObjEntity) e.getEntity();
// Important: process event even if this is the same entity,
// since the inheritance structure might have changed
if (entity != null) {
rebuildTable(entity);
}
// if an entity was selected on a tree,
// unselect currently selected row
if (e.isUnselectAttributes()) {
table.clearSelection();
}
}
protected void rebuildTable(ObjEntity entity) {
if (table.getEditingRow() != -1 && table.getEditingColumn() != -1) {
TableCellEditor cellEditor = table.getCellEditor(table.getEditingRow(), table.getEditingColumn());
cellEditor.stopCellEditing();
}
ObjAttributeTableModel model = new ObjAttributeTableModel(entity, mediator, this);
table.setModel(model);
table.setRowHeight(25);
table.setRowMargin(3);
setUpTableStructure(model);
}
protected void setUpTableStructure(ObjAttributeTableModel model) {
int inheritanceColumnWidth = 30;
Map<Integer, Integer> minSizes = new HashMap<Integer, Integer>();
Map<Integer, Integer> maxSizes = new HashMap<Integer, Integer>();
minSizes.put(ObjAttributeTableModel.INHERITED, inheritanceColumnWidth);
maxSizes.put(ObjAttributeTableModel.INHERITED, inheritanceColumnWidth);
initComboBoxes(model);
tablePreferences.bind(
table,
minSizes,
maxSizes,
null,
ObjAttributeTableModel.OBJ_ATTRIBUTE,
true);
}
/**
* Refreshes attributes view for the updated entity
*/
public void objEntityChanged(EntityEvent e) {
if (e.getSource() == this) {
return;
}
if (!(table.getModel() instanceof ObjAttributeTableModel)) {
// probably means this panel hasn't been loaded yet...
return;
}
ObjAttributeTableModel model = (ObjAttributeTableModel) table.getModel();
if (model.getDbEntity() != ((ObjEntity) e.getEntity()).getDbEntity()) {
model.resetDbEntity();
setUpTableStructure(model);
}
}
public void objEntityAdded(EntityEvent e) {
if (e.getSource() == this) {
return;
}
this.rebuildTable((ObjEntity) e.getEntity());
}
public void objEntityRemoved(EntityEvent e) {
}
// custom renderer used for inherited attributes highlighting
final class CellRenderer extends DefaultTableCellRenderer {
@Override
public Component getTableCellRendererComponent(
JTable table,
Object value,
boolean isSelected,
boolean hasFocus,
int row,
int column) {
super.getTableCellRendererComponent(
table,
value,
isSelected,
hasFocus,
row,
column);
ObjAttributeTableModel model = (ObjAttributeTableModel) table.getModel();
column = table.getColumnModel().getColumn(column).getModelIndex();
ObjAttribute attribute = model.getAttribute(row);
if (column != ObjAttributeTableModel.INHERITED) {
if (!model.isCellEditable(row, column)) {
setForeground(Color.GRAY);
}
else {
setForeground(isSelected && !hasFocus ? table
.getSelectionForeground() : table.getForeground());
}
if (attribute.isInherited()) {
Font font = getFont();
Font newFont = font.deriveFont(Font.ITALIC);
setFont(newFont);
}
setIcon(null);
}
else {
if (attribute.isInherited()) {
ImageIcon objEntityIcon = ModelerUtil.buildIcon("icon-override.gif");
setIcon(objEntityIcon);
}
setText("");
}
setBackground(isSelected && !hasFocus
? table.getSelectionBackground()
: table.getBackground());
return this;
}
}
}