/*
 * @(#)DecoratedFigure.java
 *
 * Copyright (c) 1996-2010 by the original authors of JHotDraw and all its
 * contributors. All rights reserved.
 *
 * You may not use, copy or modify this file, except in compliance with the 
 * license agreement you entered into with the copyright holders. For details
 * see accompanying license terms.
 */

package org.jhotdraw.draw;

import edu.umd.cs.findbugs.annotations.Nullable;


/**
 * A decorated figure can be decorated with another {@link Figure},
 * for example to draw a border around the decorated figure.
 *
 * 
* Design Patterns * *

Decorator
* Decorated figures can be adorned with another figure.
* Component: {@link DecoratedFigure}; Decorator: {@link Figure}. * *

Strategy
* {@code RelativeDecoratorLocator} encapsulates a strategy for locating a * point on a decorator.
* Component: {@link DecoratedFigure}; Strategy: {@link org.jhotdraw.draw.locator.RelativeDecoratorLocator}. * *


* * @author Werner Randelshofer * @version $Id: DecoratedFigure.java 717 2010-11-21 12:30:57Z rawcoder $ */ public interface DecoratedFigure extends Figure { /** * Sets a decorator Figure, for example a visual adornment to this Figure. * Set this to null, if no decorator is desired. * The decorator uses the same logical bounds as this Figure plus * AttributeKeys.DECORATOR_INSETS. The decorator does not handle events. * The decorator is drawn when the figure is drawn. */ public void setDecorator(@Nullable Figure newValue); /** * Gets the decorator for this figure. */ @Nullable public Figure getDecorator(); }

Ads help maintain this website.