// $Id: FigInterface.java 127 2010-09-25 22:23:13Z marcusvnac $
// Copyright (c) 1996-2008 The Regents of the University of California. All
// Rights Reserved. Permission to use, copy, modify, and distribute this
// software and its documentation without fee, and without a written
// agreement is hereby granted, provided that the above copyright notice
// and this paragraph appear in all copies. This software program and
// documentation are copyrighted by The Regents of the University of
// California. The software program and documentation are supplied "AS
// IS", without any accompanying services from The Regents. The Regents
// does not warrant that the operation of the program will be
// uninterrupted or error-free. The end-user understands that the program
// was developed for research purposes and is advised not to rely
// exclusively on the program for any reason. IN NO EVENT SHALL THE
// UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
// SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
// ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
// THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
// SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
// PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
// CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
// UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
package org.argouml.uml.diagram.static_structure.ui;
import java.awt.Dimension;
import java.awt.Rectangle;
//#if defined(LOGGING)
//@#$LPS-LOGGING:GranularityType:Import
import org.apache.log4j.Logger;
//#endif
import org.argouml.model.Model;
import org.argouml.ui.targetmanager.TargetManager;
import org.argouml.uml.diagram.ArgoDiagram;
import org.argouml.uml.diagram.DiagramSettings;
import org.tigris.gef.base.Editor;
import org.tigris.gef.base.Globals;
import org.tigris.gef.base.Selection;
import org.tigris.gef.graph.GraphModel;
import org.tigris.gef.presentation.Fig;
/**
* Class to display graphics for a UML Interface in a diagram.
* <p>
* An Interface may show compartments for stereotypes
* and operations. Attributes are not supported in ArgoUML.
*/
public class FigInterface extends FigClassifierBox {
//#if defined(LOGGING)
//@#$LPS-LOGGING:GranularityType:Field
private static final Logger LOG = Logger.getLogger(FigInterface.class);
//#endif
/**
* Main constructor for a {@link FigInterface}.
*
* Parent {@link org.argouml.uml.diagram.ui.FigNodeModelElement}
* will have created the main box {@link #getBigPort()} and
* its name {@link #getNameFig()} and stereotype
* (@link #getStereotypeFig()}. This constructor
* creates a box for the operations.<p>
*
* The properties of all these graphic elements are adjusted
* appropriately. The main boxes are all filled and have outlines.<p>
*
* For reasons I don't understand the stereotype is created in a box
* with lines. So we have to created a blanking rectangle to overlay the
* bottom line, and avoid three compartments showing.<p>
*
* <em>Warning</em>. Much of the graphics positioning is hard coded. The
* overall figure is placed at location (10,10).
* The stereotype compartment is created 15 pixels high
* in the parent, but we change it to 19 pixels, 1 more than
* ({@link #STEREOHEIGHT} here. The operations box is created at 19 pixels,
* 2 more than {@link #ROWHEIGHT}.<p>
*
* CAUTION: This constructor (with no arguments) is the only one
* that does enableSizeChecking(false), all others must set it true.
* This is because this constructor is the only one called when loading
* a project. In this case, the parsed size must be maintained.<p>
* @deprecated for 0.27.3 by tfmorris. Use
* {@link #FigInterface(Object, Rectangle, DiagramSettings)}.
*/
@SuppressWarnings("deprecation")
@Deprecated
public FigInterface() {
initialize();
}
/**
* Initialization common to multiple constructors. This can be merged back
* into the last constructor when the deprecated ones have been removed.
*/
private void initialize() {
getStereotypeFig().setKeyword("interface");
// Put all the bits together, suppressing bounds calculations until
// we're all done for efficiency.
enableSizeChecking(false);
setSuppressCalcBounds(true);
Dimension size = new Dimension(0, 0);
addFig(getBigPort());
addFig(getStereotypeFig());
addChildDimensions(size, getStereotypeFig());
addFig(getNameFig());
addChildDimensions(size, getNameFig());
addFig(getOperationsFig());
addChildDimensions(size, getOperationsFig());
addFig(borderFig);
setSuppressCalcBounds(false);
// Set the bounds of the figure to the total of the above
enableSizeChecking(true);
setBounds(X0, Y0, size.width, size.height);
}
/**
* Constructor for use if this figure is created for an
* existing interface node in the metamodel.
*
* @param gm Not actually used in the current implementation
*
* @param node The UML object being placed.
* @deprecated for 0.27.3 by tfmorris. Use
* {@link #FigInterface(Object, Rectangle, DiagramSettings)}.
*/
@SuppressWarnings("deprecation")
@Deprecated
public FigInterface(@SuppressWarnings("unused") GraphModel gm,
Object node) {
this();
setOwner(node);
enableSizeChecking(true);
}
/**
* Construct an Interface fig
*
* @param owner owning UML element
* @param bounds position and size
* @param settings rendering settings
*/
public FigInterface(Object owner, Rectangle bounds,
DiagramSettings settings) {
super(owner, bounds, settings);
initialize();
}
/*
* @see org.tigris.gef.presentation.Fig#makeSelection()
*/
@Override
public Selection makeSelection() {
return new SelectionInterface(this);
}
/**
* Gets the minimum size permitted for an interface on the diagram.<p>
*
* Parts of this are hardcoded.<p>
*
* @return the size of the minimum bounding box.
*/
@Override
public Dimension getMinimumSize() {
// Use "aSize" to build up the minimum size. Start with the size of the
// name compartment and build up.
Dimension aSize = getNameFig().getMinimumSize();
aSize.height += NAME_V_PADDING * 2;
aSize.height = Math.max(NAME_FIG_HEIGHT, aSize.height);
// If we have a stereotype displayed, then allow some space for that
// (width and height)
aSize = addChildDimensions(aSize, getStereotypeFig());
aSize = addChildDimensions(aSize, getOperationsFig());
// we want to maintain a minimum width for Interfaces
aSize.width = Math.max(WIDTH, aSize.width);
return aSize;
}
/*
* @see org.tigris.gef.presentation.Fig#translate(int, int)
*/
@Override
public void translate(int dx, int dy) {
super.translate(dx, dy);
Editor ce = Globals.curEditor();
if (ce != null) {
Selection sel = ce.getSelectionManager().findSelectionFor(this);
if (sel instanceof SelectionClass) {
((SelectionClass) sel).hideButtons();
}
}
}
/*
* @see org.tigris.gef.presentation.Fig#setEnclosingFig(org.tigris.gef.presentation.Fig)
*/
@Override
public void setEnclosingFig(Fig encloser) {
Fig oldEncloser = getEnclosingFig();
if (encloser == null
|| (encloser != null
&& !Model.getFacade().isAInstance(encloser.getOwner()))) {
super.setEnclosingFig(encloser);
}
if (!(Model.getFacade().isAModelElement(getOwner()))) {
return;
}
/* If this fig is not visible, do not adapt the UML model!
* This is used for deleting. See issue 3042.
*/
if (!isVisible()) {
return;
}
Object me = getOwner();
Object m = null;
try {
// If moved into an Package
if (encloser != null
&& oldEncloser != encloser
&& Model.getFacade().isAPackage(encloser.getOwner())) {
Model.getCoreHelper().setNamespace(me, encloser.getOwner());
}
// If default Namespace is not already set
if (Model.getFacade().getNamespace(me) == null
&& (TargetManager.getInstance().getTarget()
instanceof ArgoDiagram)) {
m =
((ArgoDiagram) TargetManager.getInstance().getTarget())
.getNamespace();
Model.getCoreHelper().setNamespace(me, m);
}
} catch (Exception e) {
//#if defined(LOGGING)
//@#$LPS-LOGGING:GranularityType:Statement
LOG.error("could not set package due to:" + e
+ "' at " + encloser, e);
//#endif
}
// The next if-clause is important for the Deployment-diagram
// it detects if the enclosing fig is a component, in this case
// the container will be set for the owning Interface
if (encloser != null
&& (Model.getFacade().isAComponent(encloser.getOwner()))) {
moveIntoComponent(encloser);
super.setEnclosingFig(encloser);
}
}
/**
* USED BY PGML.tee.
* @return the class name and bounds together with compartment
* visibility.
*/
@Override
public String classNameAndBounds() {
return super.classNameAndBounds()
+ "operationsVisible=" + isOperationsVisible();
}
/**
* Sets the bounds, but the size will be at least the one returned by
* {@link #getMinimumSize()}, unless checking of size is disabled.<p>
*
* If the required height is bigger, then the additional height is
* equally distributed among all figs (i.e. compartments), such that the
* cumulated height of all visible figs equals the demanded height<p>.
*
* Some of this has "magic numbers" hardcoded in.<p>
*
* @param x Desired X coordinate of upper left corner
*
* @param y Desired Y coordinate of upper left corner
*
* @param w Desired width of the FigInterface
*
* @param h Desired height of the FigInterface
*/
@Override
protected void setStandardBounds(final int x, final int y, final int w,
final int h) {
// Save our old boundaries (needed later), and get minimum size
// info.
Rectangle oldBounds = getBounds();
// set bounds of big box
getBigPort().setBounds(x, y, w, h);
borderFig.setBounds(x, y, w, h);
int currentHeight = 0;
if (getStereotypeFig().isVisible()) {
int stereotypeHeight = getStereotypeFig().getMinimumSize().height;
getStereotypeFig().setBounds(
x,
y,
w,
stereotypeHeight);
currentHeight = stereotypeHeight;
}
int nameHeight = getNameFig().getMinimumSize().height;
getNameFig().setBounds(x, y + currentHeight, w, nameHeight);
currentHeight += nameHeight;
if (getOperationsFig().isVisible()) {
int operationsY = y + currentHeight;
int operationsHeight = (h + y) - operationsY - 1;
getOperationsFig().setBounds(
x,
operationsY,
w,
operationsHeight);
}
// Now force calculation of the bounds of the figure, update the edges
// and trigger anyone who's listening to see if the "bounds" property
// has changed.
calcBounds();
updateEdges();
firePropChange("bounds", oldBounds, getBounds());
}
}