net.infonode.properties.gui.util
Class ShapedPanelProperties

java.lang.Object
  extended by net.infonode.properties.propertymap.PropertyMapContainer
      extended by net.infonode.properties.gui.util.ShapedPanelProperties

public class ShapedPanelProperties
extends PropertyMapContainer

Properties and property values for a shaped panel, which is a panel that can have a ShapedBorder and a ComponentPainter.

Version:
$Revision: 1.11 $
Author:
$Author: jesper $

Field Summary
static BooleanProperty CLIP_CHILDREN
          If true the child components of the shaped panel are clipped with the border shape.
static ComponentPainterProperty COMPONENT_PAINTER
          ComponentPainter that paints the shaped panel background.
static DirectionProperty DIRECTION
          The direction of the shaped panel.
static BooleanProperty HORIZONTAL_FLIP
          If true the shaped panel is flipped horizontally.
static BooleanProperty OPAQUE
          If true the shaped panel is opaque.
static PropertyMapGroup PROPERTIES
          Property group for all shaped panel properties.
static BooleanProperty VERTICAL_FLIP
          If true the shaped panel is flipped vertically.
 
Constructor Summary
ShapedPanelProperties()
          Creates an empty property object.
ShapedPanelProperties(PropertyMap map)
          Creates a property map containing the map.
ShapedPanelProperties(ShapedPanelProperties inheritFrom)
          Creates a property object that inherit values from another property object.
 
Method Summary
 ShapedPanelProperties addSuperObject(ShapedPanelProperties properties)
          Adds a super object from which property values are inherited.
 boolean getClipChildren()
          Returns true the child components of the shaped panel are clipped with the border shape.
 ComponentPainter getComponentPainter()
          Gets the painter that paints the shaped panel background.
 Direction getDirection()
          Gets the direction of the shaped panel.
 boolean getHorizontalFlip()
          Returns true if the shaped panel is flipped horizontally.
 boolean getOpaque()
          Returns true if the shaped panel should be opaque.
 boolean getVerticalFlip()
          Returns true if the shaped panel is flipped vertically.
 ShapedPanelProperties removeSuperObject()
          Removes the last added super object.
 ShapedPanelProperties removeSuperObject(ShapedPanelProperties superObject)
          Removes the given super object.
 ShapedPanelProperties setClipChildren(boolean clipChildren)
          Set to true if the child components of the shaped panel should be clipped with the border shape.
 ShapedPanelProperties setComponentPainter(ComponentPainter painter)
          Sets the painter that paints the shaped panel background.
 ShapedPanelProperties setDirection(Direction direction)
          Sets the direction of the shaped panel.
 ShapedPanelProperties setHorizontalFlip(boolean flip)
          Set to true if the shaped panel should be flipped horizontally.
 ShapedPanelProperties setOpaque(boolean opaque)
          Set to true if the shaped panel should be opaque.
 ShapedPanelProperties setVerticalFlip(boolean flip)
          Set to true if the shaped panel should be flipped vertically.
 
Methods inherited from class net.infonode.properties.propertymap.PropertyMapContainer
getMap
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PROPERTIES

public static final PropertyMapGroup PROPERTIES
Property group for all shaped panel properties.


OPAQUE

public static final BooleanProperty OPAQUE
If true the shaped panel is opaque.

Since:
ITP 1.4.0

HORIZONTAL_FLIP

public static final BooleanProperty HORIZONTAL_FLIP
If true the shaped panel is flipped horizontally. Used by ComponentPainter's, ShapedBorder's etc.


VERTICAL_FLIP

public static final BooleanProperty VERTICAL_FLIP
If true the shaped panel is flipped vertically. Used by ComponentPainter's, ShapedBorder's etc.


CLIP_CHILDREN

public static final BooleanProperty CLIP_CHILDREN
If true the child components of the shaped panel are clipped with the border shape.


COMPONENT_PAINTER

public static final ComponentPainterProperty COMPONENT_PAINTER
ComponentPainter that paints the shaped panel background.


DIRECTION

public static final DirectionProperty DIRECTION
The direction of the shaped panel. Used by ComponentPainter's, ShapedBorder's etc.

Constructor Detail

ShapedPanelProperties

public ShapedPanelProperties()
Creates an empty property object.


ShapedPanelProperties

public ShapedPanelProperties(PropertyMap map)
Creates a property map containing the map.

Parameters:
map - the property map

ShapedPanelProperties

public ShapedPanelProperties(ShapedPanelProperties inheritFrom)
Creates a property object that inherit values from another property object.

Parameters:
inheritFrom - the object from which to inherit property values
Method Detail

addSuperObject

public ShapedPanelProperties addSuperObject(ShapedPanelProperties properties)
Adds a super object from which property values are inherited.

Parameters:
properties - the object from which to inherit property values
Returns:
this

removeSuperObject

public ShapedPanelProperties removeSuperObject()
Removes the last added super object.

Returns:
this

removeSuperObject

public ShapedPanelProperties removeSuperObject(ShapedPanelProperties superObject)
Removes the given super object.

Parameters:
superObject - super object to remove
Returns:
this

setOpaque

public ShapedPanelProperties setOpaque(boolean opaque)
Set to true if the shaped panel should be opaque.

Parameters:
opaque - true for opaque, otherwise false
Since:
ITP 1.4.0

getOpaque

public boolean getOpaque()
Returns true if the shaped panel should be opaque.

Returns:
true for opaque, otherwise false
Since:
ITP 1.4.0

setHorizontalFlip

public ShapedPanelProperties setHorizontalFlip(boolean flip)
Set to true if the shaped panel should be flipped horizontally. Used by ComponentPainter's, ShapedBorder's etc.

Parameters:
flip - true if the shaped panel should be flipped vertically
Returns:
this

getHorizontalFlip

public boolean getHorizontalFlip()
Returns true if the shaped panel is flipped horizontally. Used by ComponentPainter's, ShapedBorder's etc.

Returns:
true if the shaped panel is flipped horizontally

setVerticalFlip

public ShapedPanelProperties setVerticalFlip(boolean flip)
Set to true if the shaped panel should be flipped vertically. Used by ComponentPainter's, ShapedBorder's etc.

Parameters:
flip - true if the shaped panel should be flipped horizontally
Returns:
this

getVerticalFlip

public boolean getVerticalFlip()
Returns true if the shaped panel is flipped vertically. Used by ComponentPainter's, ShapedBorder's etc.

Returns:
true if the shaped panel is flipped vertically

setClipChildren

public ShapedPanelProperties setClipChildren(boolean clipChildren)
Set to true if the child components of the shaped panel should be clipped with the border shape.

Parameters:
clipChildren - true if the child components of the shaped panel should be clipped with the border shape
Returns:
this

getClipChildren

public boolean getClipChildren()
Returns true the child components of the shaped panel are clipped with the border shape.

Returns:
true the child components of the shaped panel are clipped with the border shape

setComponentPainter

public ShapedPanelProperties setComponentPainter(ComponentPainter painter)
Sets the painter that paints the shaped panel background.

Parameters:
painter - the painter that paints the shaped panel background, null for none
Returns:
this

getComponentPainter

public ComponentPainter getComponentPainter()
Gets the painter that paints the shaped panel background.

Returns:
the painter that paints the shaped panel background, null if none

setDirection

public ShapedPanelProperties setDirection(Direction direction)
Sets the direction of the shaped panel. Used by ComponentPainter's, ShapedBorder's etc.

Parameters:
direction - the direction of the shaped panel
Returns:
this

getDirection

public Direction getDirection()
Gets the direction of the shaped panel. Used by ComponentPainter's, ShapedBorder's etc.

Returns:
the direction of the shaped panel