Flag (FreeCol Code Documentation)

java.lang.Object
- net.sf.freecol.client.gui.panel.Flag

```
public class Flag
extends java.lang.Object
```
This class generates the most common types of flags from a small number of parameters, biased towards flags similar to that of the United States, i.e. flags with a "union", an area filled with stars representing the colonies of the player. Obvious improvements include adding shapes other than stars (e.g. the fleur-de-lys for Quebec) and larger design elements, such as the Southern Cross, or coats of arms. Please feel free to correct any vexillological errors.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Flag.Alignment` The alignment of stripes or other design elements on the flag.
`static class`	`Flag.Background` The "background layer" of the flag, generally one or several squares or triangles of different color.
`static class`	`Flag.Decoration` The "middle layer" of the flag, generally a number of vertical, horizontal or diagonal bars.
`static class`	`Flag.UnionPosition` The position of the "union", which depends on the alignment of the background.
`static class`	`Flag.UnionShape` The shape of the "union", which generally depends on the decoration or background of the flag.

Field Summary

Fields
Modifier and Type	Field and Description
`private Flag.Background`	`background`
`private java.util.List<java.awt.Color>`	`backgroundColors` If the background is striped, the background colors will be used in turn, from top to bottom, or from left to right.
`static double`	`BEND_X`
`static double`	`BEND_Y`
`static double`	`CHEVRON_X`
`static double`	`CROSS_OFFSET` MAGIC NUMBER: the horizontal offset of the vertical bar of the Scandinavian cross.
`private Flag.Decoration`	`decoration`
`static double`	`DECORATION_SIZE` MAGIC NUMBER: the width of decoration elements.
`private java.awt.Color`	`decorationColor`
`static int`	`HEIGHT`
`private static int[][]`	`layout` The distribution of stars in the "union", based on historical flags of the United States.
`static double`	`SQRT_3`
`private static java.awt.geom.GeneralPath`	`star`
`static double`	`STAR_SIZE` MAGIC NUMBER: the size of the stars in the union.
`private java.awt.Color`	`starColor`
`private int`	`stars` The number of stars in the union.
`private int`	`stripes` The number of background stripes.
`private java.awt.Color`	`unionColor`
`private Flag.UnionPosition`	`unionPosition`
`private Flag.UnionShape`	`unionShape`
`static int`	`WIDTH` Width and height are used in the usual sense, not the vexillological sense.

Constructor Summary

Constructors
Constructor and Description
`Flag(Flag.Background background, Flag.Decoration decoration, Flag.UnionPosition unionPosition)`
`Flag(Flag.Background background, Flag.Decoration decoration, Flag.UnionPosition unionPosition, Flag.UnionShape unionShape)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private void`	`center(java.awt.geom.GeneralPath path, double x, double y)` Centers the given path on the given point (x,y).
`private void`	`drawBackground(java.awt.Graphics2D g)`
`private void`	`drawPerBend(java.awt.Graphics2D g, boolean sinister)`
`private void`	`drawPerSaltire(java.awt.Graphics2D g)`
`private void`	`drawQuarters(java.awt.Graphics2D g)`
`private void`	`drawStripes(java.awt.Graphics2D g, Flag.Alignment alignment, int stripes)`
`Flag.Background`	`getBackground()` Returns the background of the flag.
`java.util.List<java.awt.Color>`	`getBackgroundColors()` Returns a `List` of background colors.
`private java.awt.geom.GeneralPath`	`getBend(boolean sinister)`
`private java.awt.geom.GeneralPath`	`getCircleOfStars(double radius)` Returns either a single star, or a circle of stars with the given radius, centered at the origin.
`private java.awt.geom.GeneralPath`	`getCross(Flag.Decoration decoration)`
`Flag.Decoration`	`getDecoration()` Returns the decoration of the flag.
`java.awt.Color`	`getDecorationColor()` Returns the decoration color of the flag.
`java.awt.geom.GeneralPath`	`getGridOfStars(java.awt.geom.Rectangle2D.Double union)`
`java.awt.image.BufferedImage`	`getImage()` Generates an image of the flag.
`private java.awt.geom.GeneralPath`	`getPall()`
`private java.awt.geom.Rectangle2D.Double`	`getRectangle()`
`private java.awt.geom.GeneralPath`	`getRhombus()`
`private static java.awt.geom.GeneralPath`	`getStar()` Return the basic five-point star.
`java.awt.geom.GeneralPath`	`getStar(double x, double y)` Returns a star at the given coordinates (x, y).
`java.awt.geom.GeneralPath`	`getStar(double scale, double x, double y)` Returns a star of the given scale at the given coordinates (x, y).
`java.awt.Color`	`getStarColor()` Returns the star color of the flag.
`int`	`getStars()` Returns the number of stars in the union.
`private double`	`getStripeHeight(Flag.Alignment alignment)` Calculate the height of stripes on the basis of the given alignment.
`int`	`getStripes()` Returns the number of background stripes.
`private double`	`getStripeWidth(Flag.Alignment alignment)` Calculate the width of stripes on the basis of the given alignment.
`private java.awt.geom.GeneralPath`	`getTriangle(Flag.UnionShape unionShape, boolean small)` Returns a triangle of the given shape and size.
`java.awt.Color`	`getUnionColor()` Returns the union color of the flag.
`Flag.UnionPosition`	`getUnionPosition()` Returns the union position of the flag.
`private java.awt.geom.GeneralPath`	`getUnionRectangle(java.awt.geom.Rectangle2D.Double union)` Return the stars in a rectangular "union", distributed according to rules derived from historical flags of the United States.
`private java.awt.geom.GeneralPath`	`getUnionRhombus()`
`Flag.UnionShape`	`getUnionShape()` Returns the union shape of the flag.
`private java.awt.geom.GeneralPath`	`getUnionTriangle(boolean isosceles)`
`Flag`	`setBackground(Flag.Background background)` Sets the background of the flag and returns the flag itself.
`Flag`	`setBackgroundColors(java.awt.Color... colors)` Sets the background colors of the flag and returns the flag itself.
`Flag`	`setBackgroundColors(java.util.List<java.awt.Color> backgroundColors)` Sets the background colors of the flag and returns the flag itself.
`Flag`	`setDecoration(Flag.Decoration decoration)` Sets the decoration of the flag and returns the flag itself.
`Flag`	`setDecorationColor(java.awt.Color decorationColor)` Sets the decoration color of the flag and returns the flag itself.
`Flag`	`setStarColor(java.awt.Color starColor)` Sets the star color of the flag and returns the flag itself.
`Flag`	`setStars(int stars)` Sets the number of stars in the union and returns the flag itself.
`Flag`	`setStripes(int stripes)` Sets the number of background stripes and returns the flag itself.
`Flag`	`setUnionColor(java.awt.Color unionColor)` Sets the union color of the flag and returns the flag itself.
`Flag`	`setUnionPosition(Flag.UnionPosition position)` Sets the union position of the flag and returns the flag itself.
`Flag`	`setUnionShape(Flag.UnionShape shape)` Sets the union shape of the flag and returns the flag itself.
`private java.awt.geom.GeneralPath`	`transformBend(java.awt.geom.GeneralPath triangle)` Flip or rotate a top left triangle so that it fits another corner.
`private java.awt.geom.GeneralPath`	`transformTriangle(java.awt.geom.GeneralPath triangle)` Flip or rotate a left triangle so that it fits another side.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - WIDTH
```
public static final int WIDTH
```
    Width and height are used in the usual sense, not the vexillological sense.
    
    See Also:
    
    Constant Field Values
  - HEIGHT
```
public static final int HEIGHT
```
    See Also:
    
    Constant Field Values
  - SQRT_3
```
public static final double SQRT_3
```
  - DECORATION_SIZE
```
public static final double DECORATION_SIZE
```
    MAGIC NUMBER: the width of decoration elements.
    
    See Also:
    
    Constant Field Values
  - CHEVRON_X
```
public static final double CHEVRON_X
```
  - STAR_SIZE
```
public static final double STAR_SIZE
```
    MAGIC NUMBER: the size of the stars in the union.
    
    See Also:
    
    Constant Field Values
  - CROSS_OFFSET
```
public static final double CROSS_OFFSET
```
    MAGIC NUMBER: the horizontal offset of the vertical bar of the Scandinavian cross.
    
    See Also:
    
    Constant Field Values
  - BEND_X
```
public static final double BEND_X
```
    See Also:
    
    Constant Field Values
  - BEND_Y
```
public static final double BEND_Y
```
  - star
```
private static final java.awt.geom.GeneralPath star
```
  - layout
```
private static final int[][] layout
```
    The distribution of stars in the "union", based on historical flags of the United States. This really should be extended to handle rectangles of different shapes.
  - backgroundColors
```
private java.util.List<java.awt.Color> backgroundColors
```
    If the background is striped, the background colors will be used in turn, from top to bottom, or from left to right. If the background is quartered, the colors will be used clockwise, starting at the top left. If there are more colors than stripes or quarters, the superfluous colors will be ignored.
  - unionColor
```
private java.awt.Color unionColor
```
  - starColor
```
private java.awt.Color starColor
```
  - decorationColor
```
private java.awt.Color decorationColor
```
  - background
```
private Flag.Background background
```
  - decoration
```
private Flag.Decoration decoration
```
  - unionShape
```
private Flag.UnionShape unionShape
```
  - unionPosition
```
private Flag.UnionPosition unionPosition
```
  - stars
```
private int stars
```
    The number of stars in the union. This value is only relevant if the flag contains a union.
  - stripes
```
private int stripes
```
    The number of background stripes. This value is only relevant if the background contains stripes (currently FESSES or PALES).
- Constructor Detail
  - Flag
```
public Flag(Flag.Background background,
            Flag.Decoration decoration,
            Flag.UnionPosition unionPosition)
```
  - Flag
```
public Flag(Flag.Background background,
            Flag.Decoration decoration,
            Flag.UnionPosition unionPosition,
            Flag.UnionShape unionShape)
```
- Method Detail
  - getBackground
```
public Flag.Background getBackground()
```
    Returns the background of the flag.
    
    Returns:
    
    A Background value.
  - setBackground
```
public Flag setBackground(Flag.Background background)
```
    Sets the background of the flag and returns the flag itself.
    
    Parameters:
    
    background - The new Background value.
    
    Returns:
    
    The modified flag.
  - getDecoration
```
public Flag.Decoration getDecoration()
```
    Returns the decoration of the flag.
    
    Returns:
    
    A Decoration value.
  - setDecoration
```
public Flag setDecoration(Flag.Decoration decoration)
```
    Sets the decoration of the flag and returns the flag itself.
    
    Parameters:
    
    decoration - The new Decoration value.
    
    Returns:
    
    The modified flag.
  - getUnionPosition
```
public Flag.UnionPosition getUnionPosition()
```
    Returns the union position of the flag.
    
    Returns:
    
    A UnionPosition value.
  - setUnionPosition
```
public Flag setUnionPosition(Flag.UnionPosition position)
```
    Sets the union position of the flag and returns the flag itself.
    
    Parameters:
    
    position - The new UnionPosition value.
    
    Returns:
    
    The modified flag.
  - getUnionShape
```
public Flag.UnionShape getUnionShape()
```
    Returns the union shape of the flag.
    
    Returns:
    
    A UnionShape value.
  - setUnionShape
```
public Flag setUnionShape(Flag.UnionShape shape)
```
    Sets the union shape of the flag and returns the flag itself.
    
    Parameters:
    
    shape - The new UnionShape value.
    
    Returns:
    
    The modified flag.
  - getBackgroundColors
```
public java.util.List<java.awt.Color> getBackgroundColors()
```
    Returns a List of background colors.
    
    Returns:
    
    A List of background colors.
  - setBackgroundColors
```
public Flag setBackgroundColors(java.util.List<java.awt.Color> backgroundColors)
```
    Sets the background colors of the flag and returns the flag itself.
    
    Parameters:
    
    backgroundColors - A List of background colors.
    
    Returns:
    
    The modified flag.
  - setBackgroundColors
```
public Flag setBackgroundColors(java.awt.Color... colors)
```
    Sets the background colors of the flag and returns the flag itself.
    
    Parameters:
    
    colors - A variable number of background colors.
    
    Returns:
    
    The modified flag.
  - getUnionColor
```
public java.awt.Color getUnionColor()
```
    Returns the union color of the flag.
    
    Returns:
    
    A Color value.
  - setUnionColor
```
public Flag setUnionColor(java.awt.Color unionColor)
```
    Sets the union color of the flag and returns the flag itself.
    
    Parameters:
    
    unionColor - The new Color value.
    
    Returns:
    
    The modified flag.
  - getDecorationColor
```
public java.awt.Color getDecorationColor()
```
    Returns the decoration color of the flag.
    
    Returns:
    
    A Color value.
  - setDecorationColor
```
public Flag setDecorationColor(java.awt.Color decorationColor)
```
    Sets the decoration color of the flag and returns the flag itself.
    
    Parameters:
    
    decorationColor - The new Color value.
    
    Returns:
    
    The modified flag.
  - getStarColor
```
public java.awt.Color getStarColor()
```
    Returns the star color of the flag.
    
    Returns:
    
    A Color value.
  - setStarColor
```
public Flag setStarColor(java.awt.Color starColor)
```
    Sets the star color of the flag and returns the flag itself.
    
    Parameters:
    
    starColor - The new Color value.
    
    Returns:
    
    The modified flag.
  - getStars
```
public int getStars()
```
    Returns the number of stars in the union.
    
    Returns:
    
    The number of stars.
  - setStars
```
public Flag setStars(int stars)
```
    Sets the number of stars in the union and returns the flag itself.
    
    Parameters:
    
    stars - The new number of stars.
    
    Returns:
    
    The modified flag.
  - getStripes
```
public int getStripes()
```
    Returns the number of background stripes.
    
    Returns:
    
    The number of stars.
  - setStripes
```
public Flag setStripes(int stripes)
```
    Sets the number of background stripes and returns the flag itself.
    
    Parameters:
    
    stripes - The new number of background stripes.
    
    Returns:
    
    The modified flag.
  - getImage
```
public java.awt.image.BufferedImage getImage()
```
    Generates an image of the flag.
    
    Returns:
    
    An image of the flag.
  - getUnionRectangle
```
private java.awt.geom.GeneralPath getUnionRectangle(java.awt.geom.Rectangle2D.Double union)
```
    Return the stars in a rectangular "union", distributed according to rules derived from historical flags of the United States.
    
    Parameters:
    
    union - The rectangular area to fill.
    
    Returns:
    
    The union path
  - getUnionTriangle
```
private java.awt.geom.GeneralPath getUnionTriangle(boolean isosceles)
```
  - transformBend
```
private java.awt.geom.GeneralPath transformBend(java.awt.geom.GeneralPath triangle)
```
    Flip or rotate a top left triangle so that it fits another corner.
    
    Parameters:
    
    triangle - The top left triangle.
    
    Returns:
    
    The transformed triangle.
  - transformTriangle
```
private java.awt.geom.GeneralPath transformTriangle(java.awt.geom.GeneralPath triangle)
```
    Flip or rotate a left triangle so that it fits another side.
    
    Parameters:
    
    triangle - The left triangle.
    
    Returns:
    
    The transformed triangle.
  - getUnionRhombus
```
private java.awt.geom.GeneralPath getUnionRhombus()
```
  - getStripeWidth
```
private double getStripeWidth(Flag.Alignment alignment)
```
    Calculate the width of stripes on the basis of the given alignment.
    
    Parameters:
    
    alignment - The alignment of the stripes.
    
    Returns:
    
    The width of the stripes.
  - getStripeHeight
```
private double getStripeHeight(Flag.Alignment alignment)
```
    Calculate the height of stripes on the basis of the given alignment.
    
    Parameters:
    
    alignment - The alignment of the stripes.
    
    Returns:
    
    The height of the stripes.
  - drawBackground
```
private void drawBackground(java.awt.Graphics2D g)
```
  - drawStripes
```
private void drawStripes(java.awt.Graphics2D g,
                         Flag.Alignment alignment,
                         int stripes)
```
  - drawQuarters
```
private void drawQuarters(java.awt.Graphics2D g)
```
  - drawPerBend
```
private void drawPerBend(java.awt.Graphics2D g,
                         boolean sinister)
```
  - drawPerSaltire
```
private void drawPerSaltire(java.awt.Graphics2D g)
```
  - getCross
```
private java.awt.geom.GeneralPath getCross(Flag.Decoration decoration)
```
  - getBend
```
private java.awt.geom.GeneralPath getBend(boolean sinister)
```
  - getPall
```
private java.awt.geom.GeneralPath getPall()
```
  - getTriangle
```
private java.awt.geom.GeneralPath getTriangle(Flag.UnionShape unionShape,
                                              boolean small)
```
    Returns a triangle of the given shape and size. This is a large top left triangle if the given shape is BEND, and a small left triangle if the given shape is CHEVRON or TRIANGLE.
    
    Parameters:
    
    unionShape - The shape of the union.
    
    small - Whether the shape is limited by decorations.
  - getRhombus
```
private java.awt.geom.GeneralPath getRhombus()
```
  - getRectangle
```
private java.awt.geom.Rectangle2D.Double getRectangle()
```
  - getStar
```
private static java.awt.geom.GeneralPath getStar()
```
    Return the basic five-point star.
    
    Returns:
    
    the basic star shape
  - getStar
```
public java.awt.geom.GeneralPath getStar(double x,
                                         double y)
```
    Returns a star at the given coordinates (x, y).
    
    Parameters:
    
    x - The x coordinate of the star.
    
    y - The y coordinate of the star.
  - getStar
```
public java.awt.geom.GeneralPath getStar(double scale,
                                         double x,
                                         double y)
```
    Returns a star of the given scale at the given coordinates (x, y).
    
    Parameters:
    
    scale - The scale of the star.
    
    x - The x coordinate of the star.
    
    y - The y coordinate of the star.
  - center
```
private void center(java.awt.geom.GeneralPath path,
                    double x,
                    double y)
```
    Centers the given path on the given point (x,y).
    
    Parameters:
    
    path - The path to center.
    
    x - The x coordinate of the center.
    
    y - The y coordinate of the center.
  - getCircleOfStars
```
private java.awt.geom.GeneralPath getCircleOfStars(double radius)
```
    Returns either a single star, or a circle of stars with the given radius, centered at the origin.
    
    Parameters:
    
    radius - The radius of the circle.
    
    Returns:
    
    The circle of stars.
  - getGridOfStars
```
public java.awt.geom.GeneralPath getGridOfStars(java.awt.geom.Rectangle2D.Double union)
```

Class Flag

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

WIDTH

HEIGHT

SQRT_3

DECORATION_SIZE

CHEVRON_X

STAR_SIZE

CROSS_OFFSET

BEND_X

BEND_Y

star

layout

backgroundColors

unionColor

starColor

decorationColor

background

decoration

unionShape

unionPosition

stars

stripes

Constructor Detail

Flag

Flag

Method Detail

getBackground

setBackground

getDecoration

setDecoration

getUnionPosition

setUnionPosition

getUnionShape

setUnionShape

getBackgroundColors

setBackgroundColors

setBackgroundColors

getUnionColor

setUnionColor

getDecorationColor

setDecorationColor

getStarColor

setStarColor

getStars

setStars

getStripes

setStripes

getImage

getUnionRectangle

getUnionTriangle

transformBend

transformTriangle

getUnionRhombus

getStripeWidth

getStripeHeight

drawBackground

drawStripes

drawQuarters

drawPerBend

drawPerSaltire

getCross

getBend

getPall

getTriangle

getRhombus

getRectangle

getStar

getStar

getStar

center

getCircleOfStars

getGridOfStars