com.quinncurtis.chart2djava
Class StandardLegend

java.lang.Object
  extended by com.quinncurtis.chart2djava.ChartObj
      extended by com.quinncurtis.chart2djava.GraphObj
          extended by com.quinncurtis.chart2djava.Legend
              extended by com.quinncurtis.chart2djava.StandardLegend
All Implemented Interfaces:
ChartConstants, java.lang.Cloneable

public class StandardLegend
extends Legend

The StandardLegend class manages a collection LegendItem objects that represent legend items.


Field Summary
 
Fields inherited from interface com.quinncurtis.chart2djava.ChartConstants
ABOVE_CENTERED_PLOTAREA, ABOVE_REFERENCED_TEXT, ABSTRACT_DATASET, ACTUAL_SIZE, ALARM_TRANSITION_DECREASING_FROM_HIGH, ALARM_TRANSITION_DECREASING_TO_LOW, ALARM_TRANSITION_INCREASING_FROM_LOW, ALARM_TRANSITION_INCREASING_TO_HIGH, ALARM_TRANSITION_NONE_HIGH, ALARM_TRANSITION_NONE_LOW, ALARM_TRANSITION_NONE_NORMAL, ALTBARMODE, APRIL, ARC2D_OBJ, ARROW, ARROWPLOT, AUGUST, AUTO_RESIZE_OBJECTS, AUTOAXES_EXACT, AUTOAXES_FAR, AUTOAXES_NEAR, AUTOAXES_STACKED, AUTOAXES_UNSTACKED, AUTOCHART, AUTOSCALE, AXIS, AXIS_CENTER, AXIS_MAX, AXIS_MIN, AXISLABELS, AXISTITLE, BACKGROUND, BACKGROUND_ELLIPSE, BACKGROUND_RECTANGLE, BACKGROUND_ROUNDEDRECTANGLE, BARDATAPOINTVALUE, BARPLOT, BELOW_CENTERED_PLOTAREA, BELOW_REFERENCED_TEXT, BOTH_AXES, BOTTOM_BORDER, BOTTOM_SIDE, BUBBLELEGEND, BUBBLEPLOT, BUBLELEGENDITEM, BUFFERED_IMAGE_RENDERING, BUFFEREDIMAGE, BUSINESSFORMAT, CANDLESTICK, CARTESIAN_COORDINATES, CELL_PLOT, CENTER_GRAPH, CENTER_PLOT, CENTER_RADIUS_BOTTOM, CENTER_RADIUS_LEFT, CENTER_RADIUS_RIGHT, CENTER_RADIUS_TOP, CENTERED_BAR, CHART_FOOTER, CHART_HEADER, CHART_SUBHEAD, CHARTATTRIBUTE, CHARTBRUSHES, CHARTCALENDAR, CHARTPENS, CIRCLE, COLUMN_MAJOR, COMBINE_DATASET_ADD, COMBINE_DATASET_DIVIDE, COMBINE_DATASET_MULTIPLY, COMBINE_DATASET_SUBTRACT, COMBINE_DATASET_X, COMBINE_DATASET_XY, COMBINE_DATASET_Y, CONTOUR_DATASET, CONTOUR_FILL, CONTOUR_LINE, CONTOUR_LINEANDFILL, CONTOUR_LINEPOLYGON, CONTOUR_LINEWALK, CONTOURLINE, COORD_SIZE, CROSS, CROSSOVER_DAY, CROSSOVER_MONTH, CROSSOVER_NONE, CROSSOVER_WEEK, CROSSOVER_YEAR, CURRENCYBUSINESSFORMAT, CURRENCYFORMAT, CUSTOM_POSITION, CUSTOMAXIS, CUSTOMSYMBOL, DATA_MOVEABLE, DATA_TOOLTIP_CUSTOM, DATA_TOOLTIP_GROUP_MULTILINE, DATA_TOOLTIP_OHLC, DATA_TOOLTIP_X, DATA_TOOLTIP_XY_ONELINE, DATA_TOOLTIP_XY_TWOLINE, DATA_TOOLTIP_Y, DATACOMPRESS_AVERAGE, DATACOMPRESS_MAX, DATACOMPRESS_MIN, DATACOMPRESS_MINMAX, DATACOMPRESS_NONE, DATACOMPRESS_SKIP, DATACOMPRESS_SUM, DATACURSOR, DATAVALUE_SYMBOL_SELECTON, DATE, DAY_OF_MONTH, DAY_OF_WEEK, DAY_OF_YEAR, DECEMBER, DECIMALFORMAT, DEFAULTFORMAT, DEV_POS, DIAMOND, DOWNTRIANGLE, EmptyColor, ENGINEERINGFORMAT, ERROR_ARRAY_NEW, ERROR_ARRAY_NEW_STRING, ERROR_AUTOSCALE, ERROR_AUTOSCALE_DATASET, ERROR_AUTOSCALE_DATASET_STRING, ERROR_AUTOSCALE_DATASETSARRAY, ERROR_AUTOSCALE_DATASETSARRAY_STRING, ERROR_AUTOSCALE_STRING, ERROR_AUTOSCALE_TRANSFORM, ERROR_AUTOSCALE_TRANSFORM_STRING, ERROR_AXIS, ERROR_AXIS_STRING, ERROR_AXISLABLES, ERROR_AXISLABLES_STRING, ERROR_AXISRANGE, ERROR_AXISRANGE_STRING, ERROR_AXISTICKS, ERROR_AXISTICKS_STRING, ERROR_BAD_POLYSURFACE, ERROR_BAD_POLYSURFACE_STRING, ERROR_BARDATAVALUE, ERROR_BARDATAVALUE_STRING, ERROR_BORDER, ERROR_BORDER_STRING, ERROR_COMPONENT, ERROR_COMPONENT_STRING, ERROR_CONTOURDATASET, ERROR_CONTOURDATASET_STRING, ERROR_DATASET, ERROR_DATASET_STRING, ERROR_DATASETSIZE, ERROR_DATASETSIZE_STRING, ERROR_DELAUNAY, ERROR_DELAUNAY_STRING, ERROR_FILECLOSE, ERROR_FILECLOSE_STRING, ERROR_FILEIO, ERROR_FILEIO_STRING, ERROR_FILEOPEN, ERROR_FILEOPEN_STRING, ERROR_FILEREAD, ERROR_FILEREAD_STRING, ERROR_FILEWRITE, ERROR_FILEWRITE_STRING, ERROR_FONT, ERROR_FONT_STRING, ERROR_GRID_ROW_COL, ERROR_GRID_ROW_COL_STRING, ERROR_GROUPDATASET, ERROR_GROUPDATASET_STRING, ERROR_IMAGE, ERROR_IMAGE_STRING, ERROR_INVALID_ALARM_EVENT_ARGUEMENT, ERROR_INVALID_ALARM_EVENT_ARGUEMENT_STRING, ERROR_INVALID_ROUNDED_RECTANGLE_ARGUEMENT, ERROR_INVALID_ROUNDED_RECTANGLE_ARGUEMENT_STRING, ERROR_LEGEND, ERROR_LEGEND_STRING, ERROR_LEGENDITEMSYMBOL, ERROR_LEGENDITEMSYMBOL_STRING, ERROR_LEGENDITEMTEXT, ERROR_LEGENDITEMTEXT_STRING, ERROR_NONE, ERROR_NONE_STRING, ERROR_NULL_ANNUNCIATOR_RECT, ERROR_NULL_ANNUNCIATOR_RECT_STRING, ERROR_NULL_METER_INDICATOR, ERROR_NULL_METER_INDICATOR_STRING, ERROR_NULL_PLOT_TEMPLATE, ERROR_NULL_PLOT_TEMPLATE_STRING, ERROR_NULL_PROCESSVAR, ERROR_NULL_PROCESSVAR_STRING, ERROR_NULLBASEAXIS, ERROR_NULLBASEAXIS_STRING, ERROR_NULLVIEWPORT, ERROR_NULLVIEWPORT_STRING, ERROR_OBJ_NEW, ERROR_OBJ_NEW_STRING, ERROR_OBJECTMISMATCH, ERROR_OBJECTMISMATCH_STRING, ERROR_PLOTOBJ, ERROR_PLOTOBJ_STRING, ERROR_POLARAXES, ERROR_POLARAXES_STRING, ERROR_SCALERANGE, ERROR_SCALERANGE_STRING, ERROR_SCALING, ERROR_SCALING_STRING, ERROR_SHAPE, ERROR_SHAPE_STRING, ERROR_SIMPLEDATASET, ERROR_SIMPLEDATASET_STRING, ERROR_SMALLVIEWPORT, ERROR_SMALLVIEWPORT_STRING, ERROR_SUPERZOOM, ERROR_SUPERZOOM_STRING, ERROR_SYMBOL, ERROR_SYMBOL_STRING, ERROR_TEXT, ERROR_TEXT_STRING, ERROR_TIMELABEL, ERROR_TIMELABEL_STRING, ERROR_WRONGAXISTYPE, ERROR_WRONGAXISTYPE_STRING, ERRORBAR, EXPONENTFORMAT, FASTCLIP_X, FASTCLIP_Y, FEBRUARY, FIXED_X_ASPECT_RATIO_CORRECTION, FIXED_Y_ASPECT_RATIO_CORRECTION, FLOATINGBAR, FNP_DIST, FNP_NORMDIST, FNP_NORMX, FNP_NORMY, FNP_X, FNP_Y, FRIDAY, FRONT_FACE_SELECTION, FULL_PLOTAREA_CLIPPING, FULL_POLYSURFACE_SELECTION, GRADIENT_MAPTO_GRAPH_NORMALIZED_COORDINATES, GRADIENT_MAPTO_OBJECT, GRADIENT_MAPTO_PLOT_NORMALIZED_COORDINATES, GRADIENT_MAPTO_PLOT_PHYSICAL_COORDINATES, GRADIENT_NONE, GRAPH_AREA_CLIPPING, GRAPH_BACKGROUND, GRAPHAREA_BOTTOM, GRAPHAREA_LEFT, GRAPHAREA_RIGHT, GRAPHAREA_TOP, GRAPHTITLE, GRID, GRID_ALL, GRID_MAJOR, GRID_MINOR, GROUP_DATASET, GROUPBAR, HBAR, HIGHLIGHT_COLOR, HISTOGRAMPLOT, HORIZ_DIR, HOUR, HOUR_OF_DAY, ICHARTOBJECTPLOT, IMAGE, INHERIT_CLIPPING, INSET_3D_LOOK, INSIDE_BAR, INSIDE_BARBASE, INSIDE_INDICATOR, INSIDE_PLOTAREA_MAX, INSIDE_PLOTAREA_MIN, INSIDE_RADIUS_BOTTOM, INSIDE_RADIUS_TOP, JANUARY, JULY, JUNE, JUSTIFY_CENTER, JUSTIFY_MAX, JUSTIFY_MIN, LABEL_ALL, LABEL_INTERCEPT, LABEL_MAX, LABEL_MIN, LABEL_ORIGIN, LEFT_BORDER, LEFT_BUTTON, LEFT_CENTERED_PLOTAREA, LEFT_REFERENCED_TEXT, LEFT_SIDE, LEGEND, LEGEND_FOOTER, LEGEND_HEADER, LEGEND_SUBHEAD, LEGENDITEM, LIGHT_LOWER_LEFT, LIGHT_LOWER_RIGHT, LIGHT_NONE, LIGHT_STRAIGHT_ON, LIGHT_UPPER_LEFT, LIGHT_UPPER_RIGHT, LINE, LINEAR_AUTOSCALE, LINEAR_SCALE, LINEAR_SCALE_OBJ, LINEARAXIS, LINEGAP, LINEMARKERPLOT, LINEPLOT, LM_S, LOG_AUTOSCALE, LOG_SCALE, LOG_SCALE_OBJ, LOGAXIS, LS_DASH_2_2, LS_DASH_4_2, LS_DASH_4_4, LS_DASH_8_4, LS_DASH_DOT, LS_DOT_1_1, LS_DOT_1_2, LS_DOT_1_4, LS_DOT_1_8, LS_SOLID, MANUAL_RESIZE_OBJECTS, MARCH, MARKER, MARKER_BOX, MARKER_CROSS, MARKER_HLINE, MARKER_HVLINE, MARKER_NULL, MARKER_VLINE, MAX_LOG_VALUE, MAY, METER_LABEL_HORIZONTAL, METER_LABEL_PERPENDICULAR, METER_LABEL_RADIAL_1, METER_LABEL_RADIAL_2, MILLISECOND, MIN_LOG_VALUE, MINUTE, MONDAY, MONTH, MOVE_X, MOVE_XY, MOVE_Y, MOVING_AVERAGE_X, MOVING_AVERAGE_XY, MOVING_AVERAGE_Y, MTICKS, MULTILINE, NEITHER_AXIS, NO_ASPECT_RATIO_CORRECTION, NO_AUTOSCALE, NO_CLIPPING, NO_DATECROSSOVER, NO_FASTCLIP, NO_RESIZE_OBJECTS, NO_SELECTION, NO_STEP, NOOBJECT, NORM_GRAPH_POS, NORM_PLOT_POS, NORM_PROBABILITY_SCALE_OBJ, NOSYMBOL, NOT_MOVEABLE, NOT_SPECIALCONTROL_TYPE, NOVEMBER, NUMERIC_COORDINATE, NUMERICAXISLABELS, NUMERICLABEL, OBJECT_DISABLE, OBJECT_ENABLE, OBJECT_ENABLE_NODRAW, OBJECT_MOVEABLE, OCTOBER, OHLC, OUTSET_3D_LOOK, OUTSIDE_BAR, OUTSIDE_BARBASE, OUTSIDE_INDICATOR, OUTSIDE_PLOTAREA_MAX, OUTSIDE_PLOTAREA_MIN, OUTSIDE_RADIUS_BOTTOM, OUTSIDE_RADIUS_TOP, OVERLAP_LABEL_DELETE, OVERLAP_LABEL_DRAW, OVERLAP_LABEL_STAGGER, PERCENT_NOPERCENTSIGN_FORMAT, PERCENTFORMAT, PHYS_POS, PHYSICAL_COORDINATES, PICTUREBOX_TYPE, PIECHART, PIELABEL_INSLICE, PIELABEL_NONE, PIELABEL_NUMVALUE, PIELABEL_OUTSLICE, PIELABEL_STRING, PIELABEL_STRINGNUMVAL, PLOT_AREA_CLIPPING, PLOT_BACKGROUND, PLOTAREA_CENTER, PLUS, POLAR_AXIS, POLAR_COORDINATES, POLAR_POS, POLARAXES, POLARAXESLABELS, POLARGRID, POLARLINEPLOT, POLARSCATTERPLOT, POLYSURFACE_SQUAREGRID, POLYSURFACE_TRIANGLEGRID, PRE_RENDER_ALL, PRE_RENDER_AXES, PRE_RENDER_NONE, PRE_RENDER_ZORDER_CHANGE, PRINTER_RENDERING, PROBABILITY_AUTOSCALE, PROBABILITY_AXIS, PROBABILITY_COORDINATES, PROBABILITY_SCALE, PROBABILITY_SIGMA_AXIS, PRT_EXACT, PRT_MAX, PRT_PROP, PRT_RECT, RADIOBUTTON_TYPE, RADIUS_BOTTOM, RADIUS_CENTER, RADIUS_LEFT, RADIUS_RIGHT, RADIUS_TOP, rBadDataValue, RENDER_HIGHQUALITY, RENDER_LOWQUALITY, RENDER_STANDARDQUALITY, REPLACE_DATECROSSOVER, RIGHT_BORDER, RIGHT_BUTTON, RIGHT_CENTERED_PLOTAREA, RIGHT_REFERENCED_TEXT, RIGHT_SIDE, ROUNDED_RECTANGLE2D, ROW_MAJOR, RT_3DFRAME, RT_ALARM, RT_ALARM_GREATERTHAN, RT_ALARM_INDICATOR, RT_ALARM_LIMIT_BACKGROUND_INDICATOR, RT_ALARM_LIMIT_LINE_INDICATOR, RT_ALARM_LIMIT_SYMBOL_INDICATOR, RT_ALARM_LOWERTHAN, RT_ALARM_NONE, RT_ALARM_PANEL_METER, RT_ANNUNCIATOR_PLOT, RT_AUTO_BARGRAPH, RT_AUTO_METER, RT_AUTO_SCROLL_GRAPH, RT_AUTOSCALE_X, RT_AUTOSCALE_X_CURRENT_SCALE, RT_AUTOSCALE_X_MAX, RT_AUTOSCALE_X_MIN, RT_AUTOSCALE_X_MINMAX, RT_AUTOSCALE_Y, RT_AUTOSCALE_Y_CURRENT_SCALE, RT_AUTOSCALE_Y_MAX, RT_AUTOSCALE_Y_MIN, RT_AUTOSCALE_Y_MINMAX, RT_BAR_INDICATOR, RT_BAR_NUMERIC_VALUE, RT_BAR_SEGMENTED_SUBTYPE, RT_BAR_SINGLE_SEGMENT_SUBTYPE, RT_BAR_SOLID_SUBTYPE, RT_BAR_TIME_VALUE, RT_BARTAG, RT_BOTTOM_HIGH_ALARM_SYMBOL, RT_BOTTOM_LOW_ALARM_SYMBOL, RT_BOTTOM_SETPOINT_SYMBOL, RT_CEILING_VALUE, RT_COMBO_PROCESSVAR, RT_CONTROL_BUTTON_TYPE, RT_CONTROL_MOMENTARYBUTTON_SUBTYPE, RT_CONTROL_RADIOBUTTON_SUBTYPE, RT_CONTROL_SCROLLBAR_TYPE, RT_CONTROL_TOGGLEBUTTON_SUBTYPE, RT_CONTROL_TRACKBAR_TYPE, RT_CUSTOM_STRING, RT_DATASET, RT_DETALED_DESCRIPTION_STRING, RT_DISPLAY_ALL_ALARMS, RT_DISPLAY_NO_ALARM, RT_DISPLAY_PRIMARY_ALARM, RT_FIXEDEXTENT_AUTOWRAP_AUTOSCROLL, RT_FIXEDEXTENT_MOVINGSTART_AUTOSCROLL, RT_FIXEDNUMPOINT_AUTOSCROLL, RT_FLOOR_VALUE, RT_FORM_CONTROL, RT_FORM_CONTROL_GRID, RT_FORM_CONTROL_PANEL_METER, RT_GEN_SHAPE, RT_GRAPH_OBJ, RT_GROUP_DATASET, RT_GROUP_MULTIVALUE_PLOT, RT_INDICATOR_COLOR_CHANGE_ON_ALARM, RT_INDICATOR_COLOR_NO_ALARM_CHANGE, RT_INDICATORRECT_CONTROL_SIZE, RT_LEFT_HIGH_ALARM_SYMBOL, RT_LEFT_LOW_ALARM_SYMBOL, RT_LEFT_SETPOINT_SYMBOL, RT_MAXEXTENT_FIXEDSTART_AUTOSCROLL, RT_METER_ARC_BAND_SUBTYPE, RT_METER_ARC_FLAT_CAP, RT_METER_ARC_INDICATOR, RT_METER_ARC_RADIUS_CAP, RT_METER_ARC_WEDGE_WIDTH_CAP, RT_METER_AXIS, RT_METER_AXIS_LABELS, RT_METER_COORDINATES, RT_METER_FACEPLATE, RT_METER_INDICATOR, RT_METER_NEEDLE_ARROW_SUBTYPE, RT_METER_NEEDLE_INDICATOR, RT_METER_NEEDLE_PIEWEDGE_SUBTYPE, RT_METER_NEEDLE_SIMPLE_SUBTYPE, RT_METER_SEGMENTED_ARC_SUBTYPE, RT_METER_SINGLE_SEGMENT_ARC_SUBTYPE, RT_METER_SINGLE_SYMBOL_SUBTYPE, RT_METER_STRING_AXIS_LABELS, RT_METER_SYMBOL_ARC_SUBTYPE, RT_METER_SYMBOL_INDICATOR, RT_MIN_CONTROL_SIZE, RT_MONOTONIC_X_MODE, RT_MULTIALARM_INDICATOR, RT_MULTIBAR_INDICATOR, RT_MULTIPOINTER_INDICATOR, RT_MULTIVALUE_ANNUNCIATOR, RT_MULTIVALUE_INDICATOR, RT_NMETER, RT_NO_ALARM_LIMIT_INDICATOR, RT_NO_AUTOSCALE_X, RT_NO_AUTOSCALE_Y, RT_NO_SYMBOL, RT_NOT_MONOTONIC_X_MODE, RT_NUMERIC_PANEL_METER, RT_ORIG_CONTROL_SIZE, RT_PIDCONTROL, RT_PLOT, RT_POINTER_INDICATOR, RT_POINTER_SUBTYPE, RT_PROCESSVAR, RT_PROCESSVAR_ALARM, RT_RIGHT_HIGH_ALARM_SYMBOL, RT_RIGHT_LOW_ALARM_SYMBOL, RT_RIGHT_SETPOINT_SYMBOL, RT_ROUND_VALUE, RT_SCROLL_FRAME, RT_SETPOINT_VALUE, RT_SHAPE_ELLIPSE, RT_SHAPE_RECTANGLE, RT_SHAPE_ROUNDEDRECTANGLE, RT_SHORT_DESCRIPTION_STRING, RT_SIMPLE_DATASET, RT_SIMPLE_SINGLEVALUE_PLOT, RT_SINGLE_CHANNEL_PANEL_METER, RT_SINGLE_VALUE_INDICATOR, RT_STRING_PANEL_METER, RT_SYMBOL, RT_TAG_STRING, RT_TEXT_BACKGROUND_COLOR_CHANGE_ON_ALARM, RT_TEXTFRAME, RT_TIME_GROUP_DATASET, RT_TIME_PANEL_METER, RT_TIME_SIMPLE_DATASET, RT_TOP_HIGH_ALARM_SYMBOL, RT_TOP_LOW_ALARM_SYMBOL, RT_TOP_SETPOINT_SYMBOL, RT_TRACKBAR_HORIZONTAL_CENTER_POINTER, RT_TRACKBAR_HORIZONTAL_DOWN_POINTER, RT_TRACKBAR_VERTICAL_CENTER_POINTER, RT_TRACKBAR_VERTICAL_RIGHT_POINTER, RT_UNIQUEID_STRING, RT_UNITS_STRING, RTPID_POSITIONCONTROL, RTPID_VELOCITYCONTROL, SATURDAY, SCALE_FACTOR_SIZE, SCATTERPLOT, SCIENTIFICFORMAT, SCREEN_RENDERING, SCROLLBAR_TYPE, SECOND, SECONDSPERDAY, SEPTEMBER, SHADOW_COLOR, SHAPE, SIGMA_FORMAT, SIMPLE_DATASET, SIMPLE_PLOTAREA_CLIPPING, SIMPLEBUTTON_TYPE, SIMPLECOLORMODE, SIMPLEGRADIENTMODE, SIZE_BUBBLE_AREA, SIZE_BUBBLE_RADIUS, sizeOfDouble, SQUARE, STACKEDBAR, STACKEDLINE, STAR, STEP_END, STEP_NO_RISE_LINE, STEP_START, STRINGAXISLABELS, STRINGLABEL, SUNDAY, SYMBOL, TEXT, THURSDAY, TICK_MAJOR, TICK_MINOR, TICKS, TIME_AUTOSCALE, TIME_COORDINATE, TIME_COORDINATES, TIME_GROUP_DATASET, TIME_SCALE, TIME_SCALE_OBJ, TIME_SIMPLE_DATASET, TIMEAXIS, TIMEAXIS_10MINUTEMINUTE, TIMEAXIS_10SECONDSECOND, TIMEAXIS_10YEARYEAR, TIMEAXIS_12HOURHOUR, TIMEAXIS_15MINUTEMINUTE, TIMEAXIS_15SECONDSECOND, TIMEAXIS_20YEAR5YEAR, TIMEAXIS_2HOURHOUR, TIMEAXIS_2MINUTEMINUTE, TIMEAXIS_2SECONDSECOND, TIMEAXIS_30MINUTEMINUTE, TIMEAXIS_30SECONDSECOND, TIMEAXIS_4HOURHOUR, TIMEAXIS_50YEAR10YEAR, TIMEAXIS_5MINUTEMINUTE, TIMEAXIS_5SECONDSECOND, TIMEAXIS_5YEARYEAR, TIMEAXIS_8HOURHOUR, TIMEAXIS_DAY, TIMEAXIS_DAY12HOUR, TIMEAXIS_DAY2HOUR, TIMEAXIS_DAY4HOUR, TIMEAXIS_DAY8HOUR, TIMEAXIS_DAYHOUR, TIMEAXIS_HOUR, TIMEAXIS_HOUR10MINUTE, TIMEAXIS_HOUR15MINUTE, TIMEAXIS_HOUR2MINUTE, TIMEAXIS_HOUR30MINUTE, TIMEAXIS_HOUR5MINUTE, TIMEAXIS_HOURMINUTE, TIMEAXIS_MILLISECOND, TIMEAXIS_MILLISECOND1, TIMEAXIS_MILLISECOND2, TIMEAXIS_MILLISECOND3, TIMEAXIS_MINUTE, TIMEAXIS_MINUTE10SECOND, TIMEAXIS_MINUTE15SECOND, TIMEAXIS_MINUTE2SECOND, TIMEAXIS_MINUTE30SECOND, TIMEAXIS_MINUTE5SECOND, TIMEAXIS_MINUTESECOND, TIMEAXIS_MONTH, TIMEAXIS_MONTHDAY, TIMEAXIS_MONTHWEEK, TIMEAXIS_QUARTER, TIMEAXIS_QUARTERMONTH, TIMEAXIS_SECOND, TIMEAXIS_SECONDMILLISECOND, TIMEAXIS_WEEK, TIMEAXIS_WEEKDAY, TIMEAXIS_YEAR, TIMEAXIS_YEARMONTH, TIMEAXIS_YEARQUARTER, TIMEAXISLABELS, TIMEBASE_DAY, TIMEBASE_HOUR, TIMEBASE_MILLISECOND, TIMEBASE_MINUTE, TIMEBASE_MONTH, TIMEBASE_SECOND, TIMEBASE_TICKS, TIMEBASE_WEEK, TIMEBASE_YEAR, TIMEDATEFORMAT, TIMEDATEFORMAT_12HM, TIMEDATEFORMAT_12HMS, TIMEDATEFORMAT_12HMSD, TIMEDATEFORMAT_12HMSDD, TIMEDATEFORMAT_24HM, TIMEDATEFORMAT_24HMS, TIMEDATEFORMAT_24HMSD, TIMEDATEFORMAT_24HMSDD, TIMEDATEFORMAT_D, TIMEDATEFORMAT_DDD, TIMEDATEFORMAT_DDDD, TIMEDATEFORMAT_DMY, TIMEDATEFORMAT_DMY2000, TIMEDATEFORMAT_M, TIMEDATEFORMAT_MDY, TIMEDATEFORMAT_MDY2000, TIMEDATEFORMAT_MMM, TIMEDATEFORMAT_MMMM, TIMEDATEFORMAT_MS, TIMEDATEFORMAT_MSD, TIMEDATEFORMAT_MSDD, TIMEDATEFORMAT_MSDDD, TIMEDATEFORMAT_MY, TIMEDATEFORMAT_MY2000, TIMEDATEFORMAT_NONE, TIMEDATEFORMAT_Q, TIMEDATEFORMAT_STANDARD, TIMEDATEFORMAT_Y, TIMEDATEFORMAT_Y2000, TIMELABEL, TOP_BORDER, TOP_SIDE, TRACKBAR_TYPE, TransparentColor, TUESDAY, UNDECIMBER, UNDER_DATECROSSOVER, UPTRIANGLE, USER_COORD_MAX, USER_COORDINATES, USER_POS, USERGRADIENTMODE, USERTEXTUREMODE, VBAR, VERT_DIR, WEDNESDAY, WEEK_5D, WEEK_7D, WEEK_OF_MONTH, WEEK_OF_YEAR, WORKING_COORDINATES, WORLD_COORDINATES, X_AXIS, XY_MAXZ_PLANE, XY_MINZ_PLANE, XY_PLANE, XZ_MAXY_PLANE, XZ_MINY_PLANE, XZ_PLANE, Y_AXIS, YEAR, YZ_MAXX_PLANE, YZ_MINX_PLANE, YZ_PLANE, Z_AXIS, ZOOM
 
Constructor Summary
StandardLegend()
          The default Legend constructor.
StandardLegend(double rx, double ry, ChartAttribute attrib, int nlayout1mode)
          an StandardLegend constructor that initializes the position, size, color attributes, and layout mode of the legend.
StandardLegend(double rx, double ry, double rwidth, double rheight, ChartAttribute attrib, int nlayout1mode)
          A StandardLegend constructor that initializes the position, size, color attributes, and layout mode of the legend.
 
Method Summary
 int addLegendItem(LegendItem legenditem)
          Add a legend item to the current legend, using another legend item as the source.
 int addLegendItem(java.lang.String stext, ChartPlot chartobj, int ngroup, java.awt.Font thefont)
          Add a legend item to the current legend, specifying the legend item text, symbol, the associated PlotObj object, the group number of the attributes to copy in the PlotObject, and font.
 int addLegendItem(java.lang.String stext, java.awt.geom.GeneralPath symbolshape, ChartAttribute attrib, java.awt.Font thefont)
          Add a legend item to the current legend, specifying the legend item text, symbol, attributes and font.
 int addLegendItem(java.lang.String stext, java.awt.geom.GeneralPath symbolshape, GraphObj chartobj, java.awt.Font thefont)
          Add a legend item to the current legend, specifying the legend item text, symbol, attributes and font.
 int addLegendItem(java.lang.String stext, GraphObj chartobj, java.awt.Font thefont)
          Add a legend item to the current legend, specifying the legend item text, symbol, the associated GraphObj object, and font.
 int addLegendItem(java.lang.String stext, int nsymbol, ChartAttribute attrib, java.awt.Font thefont)
          Add a legend item to the current legend, specifying the legend item text, symbol, attributes and font.
 int addLegendItem(java.lang.String stext, int nsymbol, ChartPlot chartobj, int ngroup, java.awt.Font thefont)
          Add a legend item to the current legend, specifying the legend item text, symbol, the associated PlotObj object, the group number of the attributes to copy in the PlotObject, and font.
 int addLegendItem(java.lang.String stext, int nsymbol, GraphObj chartobj, java.awt.Font thefont)
          Add a legend item to the current legend, specifying the legend item text, symbol, the associated GraphObj object, and font.
 boolean checkIntersection(ChartPoint2D testpoint, NearestPointData np)
          The checkIntersection method.
 java.lang.Object clone()
          Returns an object that is a clone of this StandardLegend object.
 void copy(StandardLegend source)
          Copies the source legend object.
 void draw(java.awt.Graphics2D g2)
          The draw method for this class.
 int errorCheck(int nerror)
          Checks the legend object for common errors.
 double getLayoutMode()
          Returns the legend item layout mode.
 LegendItem getLegendItem(int itemnum)
          Returns the LegendItem object at the specified index.
 int getNumLegendItems()
          Returns the number of legend items in the current legend.
 void setChartObjScale(PhysicalCoordinates transform)
          Sets the reference to the PhysicalCoordinates object that the chart object is placed in.
 void setLayoutMode(int layout1mode)
          Sets the legend item layout mode.
 void setLegendItem(LegendItem legenditem, int itemnum)
          Set an LegendItem object in the legendItems list.
 void setLegendItemUniformTextColor(java.awt.Color color)
          Sets a uniform color for legend item text.
 
Methods inherited from class com.quinncurtis.chart2djava.Legend
addLegendGeneralText, addLegendGeneralText, addLegendGeneralText, copy, getAutoSizeLegendRectangle, getHorizontalSpacing, getInnerLegendRectangle, getLegendBorderRect, getLegendGeneralText, getLegendHeight, getLegendWidth, getSize, getVerticalSpacing, initLegendPosition, setAutoSizeLegendRectangle, setHorizontalSpacing, setLegendBorderRect, setLegendHeight, setLegendWidth, setSize, setVerticalSpacing
 
Methods inherited from class com.quinncurtis.chart2djava.GraphObj
addInternalObjects, copy, defaultcheckIntersection, getBoundingBox, getChartObjAttributes, getChartObjClipping, getChartObjComponent, getChartObjEnable, getChartObjScale, getColor, getDefaultChartFont, getIntersectionTestDistance, getLineColor, getLineStyle, getLineWidth, getLocation, getLocation, getLocation, getMoveableType, getPositionType, getResizeMultiplier, getUpdateFlag, getZOrder, moveRel, prePlot, setChartObjAttributes, setChartObjClipping, setChartObjComponent, setChartObjEnable, setColor, setDefaultChartFont, setIntersectionTestDistance, setLineColor, setLineStyle, setLineWidth, setLocation, setLocation, setLocation, setLocation, setLocation, setPositionType, setResizeMultiplier, setUpdateFlag, setZOrder, TypeSafeVectorCopy
 
Methods inherited from class com.quinncurtis.chart2djava.ChartObj
copy, getChartObjIDCntr, getChartObjType, getThisChartObjID, TypeSafeVectorCopy
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StandardLegend

public StandardLegend()
The default Legend constructor.


StandardLegend

public StandardLegend(double rx,
                      double ry,
                      ChartAttribute attrib,
                      int nlayout1mode)
an StandardLegend constructor that initializes the position, size, color attributes, and layout mode of the legend.

Parameters:
rx - The x-position, in chart normalized coordinates, of the legend rectangle.
ry - The y-position, in chart normalized coordinates, of the legend rectangle.
attrib - Specifies the out1line color, out1line line style, and fill color for the legend rectangle.
nlayout1mode - Specifies if the legend has a horizontal, or vertical layout. Use one of the orientation constants: HORIZ_DIR (row major) or VERT_DIR (column major).

StandardLegend

public StandardLegend(double rx,
                      double ry,
                      double rwidth,
                      double rheight,
                      ChartAttribute attrib,
                      int nlayout1mode)
A StandardLegend constructor that initializes the position, size, color attributes, and layout mode of the legend.

Parameters:
rx - The x-position, in chart normalized coordinates, of the legend rectangle.
ry - The y-position, in chart normalized coordinates, of the legend rectangle.
rwidth - The width, in chart normalized coordinates, of the legend rectangle.
rheight - The height, in chart normalized coordinates, of the legend rectangle.
attrib - Specifies the out1line color, out1line line style, and fill color for the legend rectangle.
nlayout1mode - Specifies if the legend has a horizontal, or vertical layout. Use one of the orientation constants: HORIZ_DIR (row major) or VERT_DIR (column major).
Method Detail

addLegendItem

public int addLegendItem(LegendItem legenditem)
Add a legend item to the current legend, using another legend item as the source.

Parameters:
legenditem - Specifies the legend item that is the source.
Returns:
Returns the current number of legend items.

addLegendItem

public int addLegendItem(java.lang.String stext,
                         ChartPlot chartobj,
                         int ngroup,
                         java.awt.Font thefont)
Add a legend item to the current legend, specifying the legend item text, symbol, the associated PlotObj object, the group number of the attributes to copy in the PlotObject, and font.

Parameters:
stext - Specifies the text string for the legend item.
chartobj - The color and fill attributes for the legend item are copied from the attributes of this Plot object.
ngroup - The group number of the attributes to copy in the associated Plot object.
thefont - Specifies the text font for the legend item.
Returns:
Returns the current number of legend items.

addLegendItem

public int addLegendItem(java.lang.String stext,
                         java.awt.geom.GeneralPath symbolshape,
                         ChartAttribute attrib,
                         java.awt.Font thefont)
Add a legend item to the current legend, specifying the legend item text, symbol, attributes and font.

Parameters:
stext - Specifies the text string for the legend item.
symbolshape - Specifies a user defined shape to use as the legend item symbol.
attrib - Specifies the ChartAttribute object to get the color and fill attributes of the legend item.
thefont - Specifies the text font for the legend item.
Returns:
Returns the current number of legend items.

addLegendItem

public int addLegendItem(java.lang.String stext,
                         java.awt.geom.GeneralPath symbolshape,
                         GraphObj chartobj,
                         java.awt.Font thefont)
Add a legend item to the current legend, specifying the legend item text, symbol, attributes and font.

Parameters:
stext - Specifies the text string for the legend item.
symbolshape - Specifies a user defined shape to use as the legend item symbol.
chartobj - The color and fill attributes for the legend item are copied from the attributes of this chart object.
thefont - Specifies the text font for the legend item.
Returns:
Returns the current number of legend items.

addLegendItem

public int addLegendItem(java.lang.String stext,
                         GraphObj chartobj,
                         java.awt.Font thefont)
Add a legend item to the current legend, specifying the legend item text, symbol, the associated GraphObj object, and font.

Parameters:
stext - Specifies the text string for the legend item.
chartobj - The color and fill attributes for the legend item are copied from the attributes of this chart object.
thefont - Specifies the text font for the legend item.
Returns:
Returns the current number of legend items.

addLegendItem

public int addLegendItem(java.lang.String stext,
                         int nsymbol,
                         ChartAttribute attrib,
                         java.awt.Font thefont)
Add a legend item to the current legend, specifying the legend item text, symbol, attributes and font.

Parameters:
stext - Specifies the text string for the legend item.
nsymbol - Specifies the symbol for the legend item. Use one of the chart symbol constants: NOSYMBOL, SQUARE, TRIANGLE, DIAMOND, CROSS, PLUS, STAR, LINE, HBAR , VBAR, BAR3D, or CIRCLE.
attrib - Specifies the ChartAttribute object to get the color and fill attributes of the legend item.
thefont - Specifies the text font for the legend item.
Returns:
Returns the current number of legend items.

addLegendItem

public int addLegendItem(java.lang.String stext,
                         int nsymbol,
                         ChartPlot chartobj,
                         int ngroup,
                         java.awt.Font thefont)
Add a legend item to the current legend, specifying the legend item text, symbol, the associated PlotObj object, the group number of the attributes to copy in the PlotObject, and font.

Parameters:
stext - Specifies the text string for the legend item.
nsymbol - Specifies the symbol for the legend item. Use one of the chart symbol constants: NOSYMBOL, SQUARE, TRIANGLE, DIAMOND, CROSS, PLUS, STAR, LINE, HBAR , VBAR, BAR3D, or CIRCLE.
chartobj - The color and fill attributes for the legend item are copied from the attributes of this Plot object.
ngroup - The group number of the attributes to copy in the associated Plot object.
thefont - Specifies the text font for the legend item.
Returns:
Returns the current number of legend items.

addLegendItem

public int addLegendItem(java.lang.String stext,
                         int nsymbol,
                         GraphObj chartobj,
                         java.awt.Font thefont)
Add a legend item to the current legend, specifying the legend item text, symbol, the associated GraphObj object, and font.

Parameters:
stext - Specifies the text string for the legend item.
nsymbol - Specifies the symbol for the legend item. Use one of the chart symbol constants: NOSYMBOL, SQUARE, TRIANGLE, DIAMOND, CROSS, PLUS, STAR, LINE, HBAR , VBAR, BAR3D, or CIRCLE.
chartobj - The color and fill attributes for the legend item are copied from the attributes of this chart object.
thefont - Specifies the text font for the legend item.
Returns:
Returns the current number of legend items.

checkIntersection

public boolean checkIntersection(ChartPoint2D testpoint,
                                 NearestPointData np)
The checkIntersection method. It test to see if the test point is within the intersectionTestDistance of the object location. Returns true if the test point intersects the object.

Overrides:
checkIntersection in class Legend
Parameters:
testpoint - The test point
np - Nearest point information for data based objects.
Returns:
Returns true if the test point intersects the object.

clone

public java.lang.Object clone()
Returns an object that is a clone of this StandardLegend object.

Specified by:
clone in class GraphObj
Returns:
Returns a clone of this StandardLegend object.

copy

public void copy(StandardLegend source)
Copies the source legend object.

Parameters:
source - The source legend object.

draw

public void draw(java.awt.Graphics2D g2)
The draw method for this class. The legend rectangle is drawn first, then the legend headers. The legend items are drawn next. Last, the legend footer is drawn.

Overrides:
draw in class Legend
Parameters:
g2 - The graphics context.

errorCheck

public int errorCheck(int nerror)
Checks the legend object for common errors.

Overrides:
errorCheck in class Legend
Parameters:
nerror - Current error state
Returns:
Returns an error code.

getLayoutMode

public double getLayoutMode()
Returns the legend item layout mode. The legend items are laid out in a row major orientation, or a column major orientation.

Returns:
Returns the legend layout mode. Use one of the orientation constants: HORIZ_DIR (row major) or VERT_DIR (column major).

getLegendItem

public LegendItem getLegendItem(int itemnum)
Returns the LegendItem object at the specified index.

Parameters:
itemnum - The index of the LegendItem in the legendItems list.
Returns:
Returns the LegendItem object at the specified index.

getNumLegendItems

public int getNumLegendItems()
Returns the number of legend items in the current legend.

Returns:
Returns the number of legend items in the current legend.

setChartObjScale

public void setChartObjScale(PhysicalCoordinates transform)
Sets the reference to the PhysicalCoordinates object that the chart object is placed in. It overrides the GraphObj version because this is a compound object that needs to update the ChartText and LegendItem objects within.

Overrides:
setChartObjScale in class Legend
Parameters:
transform - A reference to the PhysicalCoordinates object that the chart object is placed in

setLayoutMode

public void setLayoutMode(int layout1mode)
Sets the legend item layout mode. The legend items are laid out in a row major orientation, or a column major orientation.

Parameters:
layout1mode - Sets the legend layout mode. Use one of the orientation constants: HORIZ_DIR (row major) or VERT_DIR (column major).

setLegendItem

public void setLegendItem(LegendItem legenditem,
                          int itemnum)
Set an LegendItem object in the legendItems list.

Parameters:
legenditem - The LegendItem that will override an existing LegendItem in the legendItems list.
itemnum - The index in the legendItems list where the LegendItem will be placed.

setLegendItemUniformTextColor

public void setLegendItemUniformTextColor(java.awt.Color color)
Sets a uniform color for legend item text. If null the text assumes the color of the associated legend item symbol.