DynamicPDF by ceTe Software

com.cete.dynamicpdf.pageelements.charting
Class LegendList

java.lang.Object
  extended by com.cete.dynamicpdf.pageelements.charting.LegendList

public class LegendList
extends java.lang.Object

Represents a List of Legends.

Licensing:
This is a DynamicPDF Generator Enterprise Edition feature. One of the following licenses is required for non-evaluation usage:


Method Summary
 Legend add()
          Creates and adds that Legend to legend list.
 Legend add(float x, float y, float width, float height)
          Creates the and adds that Legend to legend list.
 LayOut getLabelsLayout()
          Gets the labels layout of the legends.
 LayOut getLayout()
          Gets the layout of the legends.
 Legend getLegend(int index)
          Gets the Legend based on the given index.
 LegendPlacement getPlacement()
          Gets the placement of the legends.
 void setLabelsLayout(LayOut layout)
          Sets the labels layout of the legends.
 void setLayout(LayOut layout)
          Sets the layout of the legends.
 void setPlacement(LegendPlacement legendPlacement)
          Sets the placement of the legends.
 int size()
          Returns the number of legends in the Legend list.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getPlacement

public LegendPlacement getPlacement()
Gets the placement of the legends.

Returns:
LegendPlacement The placement of the legends.

setPlacement

public void setPlacement(LegendPlacement legendPlacement)
Sets the placement of the legends.

Parameters:
legendPlacement - The placement of the legends.

getLayout

public LayOut getLayout()
Gets the layout of the legends.

Returns:
LayOut The layout of the legends.

setLayout

public void setLayout(LayOut layout)
Sets the layout of the legends.

Parameters:
layout - The layout of the legends.

getLabelsLayout

public LayOut getLabelsLayout()
Gets the labels layout of the legends.

Returns:
LayOut The labels layout of the legends.

setLabelsLayout

public void setLabelsLayout(LayOut layout)
Sets the labels layout of the legends.

Parameters:
layout - The labels layout of the legends.

add

public Legend add(float x,
                  float y,
                  float width,
                  float height)
Creates the and adds that Legend to legend list.

Parameters:
x - x co-ordinate of the Legend.
y - y co-ordinate of the Legend.
width - The width of the Legend.
height - The height of the Legend.
Returns:
The created Legend
See Also:
Legend

add

public Legend add()
Creates and adds that Legend to legend list.

Returns:
The created Legend
See Also:
Legend

getLegend

public Legend getLegend(int index)
Gets the Legend based on the given index.

Parameters:
index - index of the Legend
Returns:
The Legend of the given index.

size

public int size()
Returns the number of legends in the Legend list.

Returns:
int The number of legends in the legend list.

DynamicPDF by ceTe Software

API Reference for DynamicPDF v10.04 for Java generated on September 25, 2019
© Copyright 2019, ceTe Software