org.apache.pivot.wtk.effects
Class TagDecorator

java.lang.Object
  extended by org.apache.pivot.wtk.effects.TagDecorator
All Implemented Interfaces:
Decorator

public class TagDecorator
extends Object
implements Decorator

Decorator that allows a caller to attach a "tag" visual to a component.


Constructor Summary
TagDecorator()
           
TagDecorator(Visual tag)
           
TagDecorator(Visual tag, HorizontalAlignment horizontalAlignment, VerticalAlignment verticalAlignment, int xOffset, int yOffset)
           
 
Method Summary
 Bounds getBounds(Component component)
          Returns the bounding area of the decorator.
 HorizontalAlignment getHorizontalAlignment()
           
 Visual getTag()
           
 AffineTransform getTransform(Component component)
          Returns the transformation the decorator applies to the component's coordinate space.
 VerticalAlignment getVerticalAlignment()
           
 int getXOffset()
           
 int getYOffset()
           
 Graphics2D prepare(Component component, Graphics2D graphicsArgument)
          Prepares the graphics context into which the component or prior decorator will paint.
 void setHorizontalAlignment(HorizontalAlignment horizontalAlignment)
           
 void setTag(Visual tag)
           
 void setVerticalAlignment(VerticalAlignment verticalAlignment)
           
 void setXOffset(int xOffset)
           
 void setYOffset(int yOffset)
           
 void update()
          Updates the graphics context into which the component or prior decorator was painted.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TagDecorator

public TagDecorator()

TagDecorator

public TagDecorator(Visual tag)

TagDecorator

public TagDecorator(Visual tag,
                    HorizontalAlignment horizontalAlignment,
                    VerticalAlignment verticalAlignment,
                    int xOffset,
                    int yOffset)
Method Detail

getTag

public Visual getTag()

setTag

public void setTag(Visual tag)

getHorizontalAlignment

public HorizontalAlignment getHorizontalAlignment()

setHorizontalAlignment

public void setHorizontalAlignment(HorizontalAlignment horizontalAlignment)

getVerticalAlignment

public VerticalAlignment getVerticalAlignment()

setVerticalAlignment

public void setVerticalAlignment(VerticalAlignment verticalAlignment)

getXOffset

public int getXOffset()

setXOffset

public void setXOffset(int xOffset)

getYOffset

public int getYOffset()

setYOffset

public void setYOffset(int yOffset)

prepare

public Graphics2D prepare(Component component,
                          Graphics2D graphicsArgument)
Description copied from interface: Decorator
Prepares the graphics context into which the component or prior decorator will paint. This method is called immediately prior to Component.paint(Graphics2D); decorators are called in descending order.

Specified by:
prepare in interface Decorator
Returns:
The graphics context that should be used by the component or prior decorators.

update

public void update()
Description copied from interface: Decorator
Updates the graphics context into which the component or prior decorator was painted. This method is called immediately after Component.paint(Graphics2D); decorators are called in ascending order.

Specified by:
update in interface Decorator

getBounds

public Bounds getBounds(Component component)
Description copied from interface: Decorator
Returns the bounding area of the decorator.

Specified by:
getBounds in interface Decorator
Returns:
The decorator's bounds, relative to the component's origin.

getTransform

public AffineTransform getTransform(Component component)
Description copied from interface: Decorator
Returns the transformation the decorator applies to the component's coordinate space.

Specified by:
getTransform in interface Decorator
Returns:
The decorator's transform.