net.sf.latexdraw.actions
Enum ShapeProperties

java.lang.Object
  extended by java.lang.Enum<ShapeProperties>
      extended by net.sf.latexdraw.actions.ShapeProperties
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<ShapeProperties>

public enum ShapeProperties
extends java.lang.Enum<ShapeProperties>

Defines shape properties.

This file is part of LaTeXDraw.
Copyright (c) 2005-2012 Arnaud BLOUIN

LaTeXDraw is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
LaTeXDraw is distributed without any warranty; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

05/19/2010

Since:
3.0
Author:
Arnaud BLOUIN

Enum Constant Summary
ARC_END_ANGLE
          Modification of the end angle of arcs.
ARC_START_ANGLE
          Modification of the start angle of arcs.
ARC_STYLE
          Modification of the style of arcs.
ARROW_BRACKET_NUM
          The bracket num of arrows.
ARROW_DOT_SIZE_DIM
          The dot size dim of arrows.
ARROW_DOT_SIZE_NUM
          The dot size dim of arrows.
ARROW_INSET
          The inset of arrows.
ARROW_LENGTH
           
ARROW_R_BRACKET_NUM
          The round bracket num of arrows.
ARROW_SIZE_DIM
          The size dim of arrows.
ARROW_SIZE_NUM
          The size num of arrows.
ARROW_T_BAR_SIZE_DIM
          The t bar num of arrows.
ARROW_T_BAR_SIZE_NUM
          The t bar num of arrows.
ARROW1_STYLE
          Defines if the shape has a first arrow.
ARROW2_STYLE
          Defines if the shape has a second arrow.
AXES_LABELS_DIST
          The increment of the axes' labels.
AXES_LABELS_INCR
          The increment of the axes' labels.
AXES_LABELS_SHOW
          How the labels of axes are displayed.
AXES_SHOW_ORIGIN
          Show/Hide the origin of the axes.
AXES_STYLE
          The style of axes.
AXES_TICKS_SHOW
          How the ticks of axes are displayed.
AXES_TICKS_SIZE
          The size of the ticks of axes.
AXES_TICKS_STYLE
          The style of the ticks of axes.
BORDER_POS
          Modification of the border position of a shape.
COLOUR_DBLE_BORD
          Modification of the colour of the double borders of a shape.
COLOUR_FILLING
          Modification of the colour of the filling of a shape.
COLOUR_GRADIENT_END
          Modification of the colour of the end gradient of a shape.
COLOUR_GRADIENT_START
          Modification of the colour of the start gradient of a shape.
COLOUR_HATCHINGS
          Modification of the colour of the hatchings of a shape.
COLOUR_LINE
          Modification of the colour of the borders of a shape.
COLOUR_SHADOW
          Modification of colour of the shadow of a shape.
DBLE_BORDERS
          Defines if a shape must have double borders.
DBLE_BORDERS_SIZE
          Modification of the size of the double borders of a shape.
DOT_FILLING_COL
          Modification of the filling colour of a dot.
DOT_SIZE
          Modification of the size of dots.
DOT_STYLE
          Modification of the style of a dot.
FILLING_STYLE
          Modification of the filling style of a shape.
GRAD_ANGLE
          Modification of the gradient angle a shape.
GRAD_MID_POINT
          Modification of the middle point of the gradient a shape.
GRID_END
          Modification of the starting position of grids.
GRID_LABEL_POSITION_X
          The X-coordinate of the grid's labels.
GRID_LABEL_POSITION_Y
          The Y-coordinate of the grid's labels.
GRID_ORIGIN
          Modification of the starting position of grids.
GRID_SIZE_LABEL
          The size of the labels of grids.
GRID_START
          Modification of the starting position of grids.
HATCHINGS_ANGLE
          Modification of the hatchings angle of shapes.
HATCHINGS_SEP
          Modification of the hatching spacing a shape.
HATCHINGS_WIDTH
          Modification of the hatchings width a shape.
LINE_STYLE
          Modification of the line style of a shape.
LINE_THICKNESS
          Modification of the thickness of the borders of a shape.
ROTATION_ANGLE
          Modification of the rotation angle a shape.
ROUND_CORNER_VALUE
          Modification of the round corner value of a shape.
SHADOW
          Defines if a shape must have a shadow.
SHADOW_ANGLE
          Modification of the angle of the shadow of a shape.
SHADOW_SIZE
          Modification of the size of the shadow of a shape.
TEXT
          Modification of the text.
TEXT_POSITION
          Modification of the position of texts.
 
Method Summary
abstract  java.lang.String getMessage()
           
abstract  java.util.List<?> getPropertyValues(IGroup group)
           
 boolean isPropertySupported(IGroup group)
           
abstract  boolean isValueValid(java.lang.Object obj)
           
abstract  void setPropertyValue(IGroup group, java.lang.Object value)
          Sets the given value of the property to the given group.
abstract  void setPropertyValueList(IGroup group, java.util.List<?> values)
          Sets the given values of the property to the given group.
static ShapeProperties valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static ShapeProperties[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

AXES_SHOW_ORIGIN

public static final ShapeProperties AXES_SHOW_ORIGIN
Show/Hide the origin of the axes.


AXES_LABELS_DIST

public static final ShapeProperties AXES_LABELS_DIST
The increment of the axes' labels.


AXES_LABELS_INCR

public static final ShapeProperties AXES_LABELS_INCR
The increment of the axes' labels.


AXES_LABELS_SHOW

public static final ShapeProperties AXES_LABELS_SHOW
How the labels of axes are displayed.


AXES_TICKS_SHOW

public static final ShapeProperties AXES_TICKS_SHOW
How the ticks of axes are displayed.


AXES_TICKS_SIZE

public static final ShapeProperties AXES_TICKS_SIZE
The size of the ticks of axes.


AXES_TICKS_STYLE

public static final ShapeProperties AXES_TICKS_STYLE
The style of the ticks of axes.


AXES_STYLE

public static final ShapeProperties AXES_STYLE
The style of axes.


GRID_LABEL_POSITION_X

public static final ShapeProperties GRID_LABEL_POSITION_X
The X-coordinate of the grid's labels.


GRID_LABEL_POSITION_Y

public static final ShapeProperties GRID_LABEL_POSITION_Y
The Y-coordinate of the grid's labels.


GRID_SIZE_LABEL

public static final ShapeProperties GRID_SIZE_LABEL
The size of the labels of grids.


ARROW_T_BAR_SIZE_DIM

public static final ShapeProperties ARROW_T_BAR_SIZE_DIM
The t bar num of arrows.


ARROW_T_BAR_SIZE_NUM

public static final ShapeProperties ARROW_T_BAR_SIZE_NUM
The t bar num of arrows.


ARROW_DOT_SIZE_NUM

public static final ShapeProperties ARROW_DOT_SIZE_NUM
The dot size dim of arrows.


ARROW_DOT_SIZE_DIM

public static final ShapeProperties ARROW_DOT_SIZE_DIM
The dot size dim of arrows.


ARROW_BRACKET_NUM

public static final ShapeProperties ARROW_BRACKET_NUM
The bracket num of arrows.


ARROW_R_BRACKET_NUM

public static final ShapeProperties ARROW_R_BRACKET_NUM
The round bracket num of arrows.


ARROW_SIZE_NUM

public static final ShapeProperties ARROW_SIZE_NUM
The size num of arrows.


ARROW_SIZE_DIM

public static final ShapeProperties ARROW_SIZE_DIM
The size dim of arrows.


ARROW_LENGTH

public static final ShapeProperties ARROW_LENGTH

ARROW_INSET

public static final ShapeProperties ARROW_INSET
The inset of arrows.


GRID_END

public static final ShapeProperties GRID_END
Modification of the starting position of grids.


GRID_ORIGIN

public static final ShapeProperties GRID_ORIGIN
Modification of the starting position of grids.


GRID_START

public static final ShapeProperties GRID_START
Modification of the starting position of grids.


ARC_START_ANGLE

public static final ShapeProperties ARC_START_ANGLE
Modification of the start angle of arcs.


ARC_END_ANGLE

public static final ShapeProperties ARC_END_ANGLE
Modification of the end angle of arcs.


ARC_STYLE

public static final ShapeProperties ARC_STYLE
Modification of the style of arcs.


ARROW2_STYLE

public static final ShapeProperties ARROW2_STYLE
Defines if the shape has a second arrow.


ARROW1_STYLE

public static final ShapeProperties ARROW1_STYLE
Defines if the shape has a first arrow.


ROTATION_ANGLE

public static final ShapeProperties ROTATION_ANGLE
Modification of the rotation angle a shape.


TEXT_POSITION

public static final ShapeProperties TEXT_POSITION
Modification of the position of texts.


TEXT

public static final ShapeProperties TEXT
Modification of the text.


HATCHINGS_ANGLE

public static final ShapeProperties HATCHINGS_ANGLE
Modification of the hatchings angle of shapes.


HATCHINGS_WIDTH

public static final ShapeProperties HATCHINGS_WIDTH
Modification of the hatchings width a shape.


HATCHINGS_SEP

public static final ShapeProperties HATCHINGS_SEP
Modification of the hatching spacing a shape.


GRAD_ANGLE

public static final ShapeProperties GRAD_ANGLE
Modification of the gradient angle a shape.


GRAD_MID_POINT

public static final ShapeProperties GRAD_MID_POINT
Modification of the middle point of the gradient a shape.


ROUND_CORNER_VALUE

public static final ShapeProperties ROUND_CORNER_VALUE
Modification of the round corner value of a shape.


COLOUR_FILLING

public static final ShapeProperties COLOUR_FILLING
Modification of the colour of the filling of a shape.


COLOUR_LINE

public static final ShapeProperties COLOUR_LINE
Modification of the colour of the borders of a shape.


COLOUR_HATCHINGS

public static final ShapeProperties COLOUR_HATCHINGS
Modification of the colour of the hatchings of a shape.


DBLE_BORDERS

public static final ShapeProperties DBLE_BORDERS
Defines if a shape must have double borders.


DBLE_BORDERS_SIZE

public static final ShapeProperties DBLE_BORDERS_SIZE
Modification of the size of the double borders of a shape.


COLOUR_DBLE_BORD

public static final ShapeProperties COLOUR_DBLE_BORD
Modification of the colour of the double borders of a shape.


SHADOW

public static final ShapeProperties SHADOW
Defines if a shape must have a shadow.


SHADOW_SIZE

public static final ShapeProperties SHADOW_SIZE
Modification of the size of the shadow of a shape.


SHADOW_ANGLE

public static final ShapeProperties SHADOW_ANGLE
Modification of the angle of the shadow of a shape.


COLOUR_SHADOW

public static final ShapeProperties COLOUR_SHADOW
Modification of colour of the shadow of a shape.


COLOUR_GRADIENT_START

public static final ShapeProperties COLOUR_GRADIENT_START
Modification of the colour of the start gradient of a shape.


COLOUR_GRADIENT_END

public static final ShapeProperties COLOUR_GRADIENT_END
Modification of the colour of the end gradient of a shape.


LINE_THICKNESS

public static final ShapeProperties LINE_THICKNESS
Modification of the thickness of the borders of a shape.


FILLING_STYLE

public static final ShapeProperties FILLING_STYLE
Modification of the filling style of a shape.


BORDER_POS

public static final ShapeProperties BORDER_POS
Modification of the border position of a shape.


LINE_STYLE

public static final ShapeProperties LINE_STYLE
Modification of the line style of a shape.


DOT_FILLING_COL

public static final ShapeProperties DOT_FILLING_COL
Modification of the filling colour of a dot.


DOT_STYLE

public static final ShapeProperties DOT_STYLE
Modification of the style of a dot.


DOT_SIZE

public static final ShapeProperties DOT_SIZE
Modification of the size of dots.

Method Detail

values

public static ShapeProperties[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (ShapeProperties c : ShapeProperties.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static ShapeProperties valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

isPropertySupported

public boolean isPropertySupported(IGroup group)
Parameters:
group - The group to test.
Returns:
True if the given group supports the calling property.
Since:
3.0

setPropertyValue

public abstract void setPropertyValue(IGroup group,
                                      java.lang.Object value)
Sets the given value of the property to the given group.

Parameters:
group - The group to modify.
value - The new value of the property to set.
Since:
3.0

setPropertyValueList

public abstract void setPropertyValueList(IGroup group,
                                          java.util.List<?> values)
Sets the given values of the property to the given group. The size of the list must equals the number of shapes of the group. If a shape of the group must not be set, its corresponding value in the list must be null.

Parameters:
group - The group to modify.
values - The set of new values of the property to set.
Since:
3.0

getPropertyValues

public abstract java.util.List<?> getPropertyValues(IGroup group)
Parameters:
group - The group to explore.
Returns:
The list of property values of the shapes of the given group.
Since:
3.0

getMessage

public abstract java.lang.String getMessage()
Returns:
The title of the properties.
Since:
3.0

isValueValid

public abstract boolean isValueValid(java.lang.Object obj)
Parameters:
obj - The new value to test.
Returns:
True if the given value can be set to the shape property.
Since:
3.0