Chart FX for Java 6.2

SoftwareFX.ChartFX.Map
Class WinnerDelegateEvent

java.lang.Object
  extended byjava.util.EventObject
      extended bySoftwareFX.ChartFX.Map.WinnerDelegateEvent
All Implemented Interfaces:
java.io.Serializable

public final class WinnerDelegateEvent
extends java.util.EventObject

This class models WinnerDelegate events.

The members for the MapDelegateEvent class are accessible within the WinnerCallBack event. These properties allow you to access the RuleDataObj to evaluate the value for selected map region as well assign RuleAttribute objects.

See Also:
Serialized Form

Constructor Summary
WinnerDelegateEvent()
           
 
Method Summary
 java.lang.String getLabel()
          Gets the DataText string for the WinnerDelegateEvent object.
 int getPoint()
          Specifies the index of the WinnerDelegateEvent object in the MapData array.
 double getValue(int series)
          Returns the values for the selected item in the data array for the WinnerDelegateEvent object.
 RuleDataObj getValues()
          Returns a selected item of the data array for the WinnerDelegateEventArgs object.
 int getWinnerSeries()
          Specifies the dominant series of the map data.
 void setValue(int series, double value)
          Returns the values for the selected item in the data array for the WinnerDelegateEvent object.
 void setWinnerSeries(int value)
          Specifies the dominant series of the map data.
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

WinnerDelegateEvent

public WinnerDelegateEvent()
Method Detail

getLabel

public java.lang.String getLabel()

Gets the DataText string for the WinnerDelegateEvent object.

Remarks:
  • This property contains the string from the DataText attribute in the LabelLink for the WinnerDelegateEvent object.

  • See Also:
    getPoint(), getValue(int), getValues(), setWinnerSeries(int)

    getPoint

    public int getPoint()

    Specifies the index of the WinnerDelegateEvent object in the MapData array.

    See Also:
    getLabel(), getValues(), setWinnerSeries(int)

    getValue

    public double getValue(int series)

    Returns the values for the selected item in the data array for the WinnerDelegateEvent object.

    Parameters:
    series - The zero-based index specifying the series.
    See Also:
    getLabel(), getPoint(), setWinnerSeries(int), getValues()

    getValues

    public RuleDataObj getValues()

    Returns a selected item of the data array for the WinnerDelegateEventArgs object.

    Remarks:
  • This property returns an array of values for a specific WinnerDelegateEventArgs. Using the index, you can return a specific value in that array consistent with the series value at that RuleDataObj point. Using conditional expressions, developers may determine which series is the WinnerSeries for a map region.

  • This is a read-only property.

  • See Also:
    getLabel(), getPoint(), setWinnerSeries(int)

    getWinnerSeries

    public int getWinnerSeries()

    Specifies the dominant series of the map data.

    Remarks:
  • This property sets the series to be used for the tooltip information for a region in the map.

  • The Map.setWinnerSeriesType(int) attribute controls the mode in which the winning series is determined (i.e. The max or min value is the winner).

  • The getValues() property may be used to evaluate the data array for a map region.

  • See Also:
    Map.setWinnerSeriesType(int), getLabel(), getPoint(), getValues(), Map

    setValue

    public void setValue(int series,
                         double value)

    Returns the values for the selected item in the data array for the WinnerDelegateEvent object.

    Parameters:
    series - The zero-based index specifying the series.
    See Also:
    getLabel(), getPoint(), setWinnerSeries(int), getValues()

    setWinnerSeries

    public void setWinnerSeries(int value)

    Specifies the dominant series of the map data.

    Remarks:
  • This property sets the series to be used for the tooltip information for a region in the map.

  • The Map.setWinnerSeriesType(int) attribute controls the mode in which the winning series is determined (i.e. The max or min value is the winner).

  • The getValues() property may be used to evaluate the data array for a map region.

  • See Also:
    Map.setWinnerSeriesType(int), getLabel(), getPoint(), getValues(), Map

    http://www.softwarefx.com

    2005 Software FX, Inc. All Rights Reserved. Chart FX is a registered trademark of Software FX, Inc
    All other names are trademarks or registered trademarks of their respective owners.