Home  Products  Purchase  Downloads  Demos  Forums  Blogs  Ticket  Wiki  API  Corporate


com.aspose.cells
Class LegendEntry

java.lang.Object
  extended by com.aspose.cells.ChartFrame
      extended by com.aspose.cells.LegendEntry

public class LegendEntry
extends ChartFrame

Represents a legend entry in a chart legend. The LegendEntry object is a member of the LegendEntries collection.


Method Summary
 int compareTo(int index)
          Compares this LegendEntry with another one that has given entry index for order.
 int compareTo(LegendEntry entry)
          Compares this LegendEntry with another one for order.
 Area getArea()
          Gets the Area.
 byte getBackgroundMode()
          Gets the display mode of the background.
 Line getBorder()
          Gets the border Line.
 Font getFont()
          Gets the Font of this LegendEntry.
 int getIndex()
          Gets the index of this LegendEntry.
 int getKey()
          Gets the comparable key of this LegendEntry.
 boolean isAutoScaleFont()
          Check whether the text in the object changes font size when the object size changes.
 boolean isDeleted()
          Gets whether the lengend entry is deleted.
 void setAutoScaleFont(boolean isAutoScaleFont)
          Set whether the text in the object changes font size when the object size changes.
 void setBackgroundMode(byte mode)
          Sets the display mode of the background.
 void setDeleted(boolean deleted)
          Sets whether the lengend entry is deleted.
 void setKey(int key)
          Sets the comparable key of this LegendEntry.
 
Methods inherited from class com.aspose.cells.ChartFrame
equals, getAreaOrNull, getBorderOrNull
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getBorder

public Line getBorder()
Gets the border Line. To set the border of corresponding series or chart point, please get the border from corresponding series or chart point and apply settings on it.

Overrides:
getBorder in class ChartFrame
Returns:
Always returns null.

getArea

public Area getArea()
Gets the Area. To set the border of corresponding series or chart point, please get the border from corresponding series or chart point and apply settings on it.

Overrides:
getArea in class ChartFrame
Returns:
Always returns null.

isDeleted

public boolean isDeleted()
Gets whether the lengend entry is deleted.

Returns:
whether the lengend entry is deleted

setDeleted

public void setDeleted(boolean deleted)
Sets whether the lengend entry is deleted.

Parameters:
deleted - whether the lengend entry is deleted

getFont

public Font getFont()
Gets the Font of this LegendEntry.

Returns:
the Font of this LegendEntry.

isAutoScaleFont

public boolean isAutoScaleFont()
Check whether the text in the object changes font size when the object size changes.

Returns:
true if the text in the object changes font size when the object size changes.

setAutoScaleFont

public void setAutoScaleFont(boolean isAutoScaleFont)
Set whether the text in the object changes font size when the object size changes.

Parameters:
isAutoScaleFont - true if the text in the object changes font size when the object size changes.

getBackgroundMode

public byte getBackgroundMode()
Gets the display mode of the background.

Returns:
the display mode of the background.
See Also:
setBackgroundMode(byte)

setBackgroundMode

public void setBackgroundMode(byte mode)
Sets the display mode of the background.

Parameters:
mode - the display mode of the background. It could be one of following:
BackgroundMode.AUTOMATIC
BackgroundMode.TRANSPARENT
BackgroundMode.OPAQUE

getIndex

public int getIndex()
Gets the index of this LegendEntry.

Returns:
the index of this LegendEntry

compareTo

public int compareTo(int index)
Compares this LegendEntry with another one that has given entry index for order.

Parameters:
index - the entry index to be compared with the entry index of this LegendEntry.
Returns:
a negative integer, zero, or a positive integer as the entry index of this LegendEntry is less than, equal to, or greater than the specified entry index.

compareTo

public int compareTo(LegendEntry entry)
Compares this LegendEntry with another one for order.

Parameters:
entry - the LegendEntry to be compared with this one.
Returns:
a negative integer, zero, or a positive integer as the entry index of this LegendEntry is less than, equal to, or greater than the entry index of the specified LegendEntry object.

getKey

public int getKey()
Gets the comparable key of this LegendEntry. Same with getIndex().

Returns:
the comparable key of this LegendEntry, that is the entry index.

setKey

public void setKey(int key)
Sets the comparable key of this LegendEntry. Only for inner usage. Does not make any change for this LegendEntry object.

Parameters:
key - key value.