com.esri.arcgis.carto
Interface ILegendFormat

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ILegendFormatProxy, LegendFormat

public interface ILegendFormat
extends java.io.Serializable

COM Interface 'ILegendFormat'. Generated 3/19/2015 1:20:52 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to members that control formatting information for a legend.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID52aa5bc1_cb21_11d0_87f9_080009ec732a
static int	xxDummy Deprecated. Internal use only

Method Summary

IAreaPatch	getDefaultAreaPatch() Area patch.
ILinePatch	getDefaultLinePatch() Line patch.
double	getDefaultPatchHeight() Patch height in points.
double	getDefaultPatchWidth() Patch width in points.
double	getGroupGap() Vertical distance in points between legend groups.
double	getHeadingGap() Vertical distance in points between a heading and the legend graphics that follow.
double	getHorizontalItemGap() Horizontal distance in points between legend item columns.
double	getHorizontalPatchGap() Horizontal distance in points between a patch and the legend graphics before and after.
double	getLayerNameGap() Vertical distance in points between layer names and the legend graphics that follow.
double	getTextGap() Horizontal distance in points between labels and descriptions.
double	getTitleGap() Vertical distance in points between title and first legend item.
int	getTitlePosition() Legend title position.
ITextSymbol	getTitleSymbol() Text symbol used to draw the legend title.
double	getVerticalItemGap() Vertical distance in points between legend items.
double	getVerticalPatchGap() Vertical distance in points between patches.
boolean	isShowTitle() Indicates if title is visibile.
void	scale(double xScale, double yScale) Multiply all distances, gaps, and size property values on this interface by the specified scale factors.
void	setDefaultAreaPatch(IAreaPatch patch) Area patch.
void	setDefaultLinePatch(ILinePatch patch) Line patch.
void	setDefaultPatchHeight(double height) Patch height in points.
void	setDefaultPatchWidth(double width) Patch width in points.
void	setGroupGap(double gap) Vertical distance in points between legend groups.
void	setHeadingGap(double gap) Vertical distance in points between a heading and the legend graphics that follow.
void	setHorizontalItemGap(double gap) Horizontal distance in points between legend item columns.
void	setHorizontalPatchGap(double gap) Horizontal distance in points between a patch and the legend graphics before and after.
void	setLayerNameGap(double gap) Vertical distance in points between layer names and the legend graphics that follow.
void	setShowTitle(boolean showTitle) Indicates if title is visibile.
void	setTextGap(double gap) Horizontal distance in points between labels and descriptions.
void	setTitleGap(double gap) Vertical distance in points between title and first legend item.
void	setTitlePosition(int pos) Legend title position.
void	setTitleSymbol(ITextSymbol symbol) Text symbol used to draw the legend title.
void	setVerticalItemGap(double gap) Vertical distance in points between legend items.
void	setVerticalPatchGap(double gap) Vertical distance in points between patches.

Field Detail

IID52aa5bc1_cb21_11d0_87f9_080009ec732a

static final int IID52aa5bc1_cb21_11d0_87f9_080009ec732a

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

isShowTitle

boolean isShowTitle()
                    throws java.io.IOException,
                           AutomationException

Indicates if title is visibile.

Returns:

The showTitle

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowTitle

void setShowTitle(boolean showTitle)
                  throws java.io.IOException,
                         AutomationException

Indicates if title is visibile.

Parameters:

showTitle - The showTitle (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTitleSymbol

ITextSymbol getTitleSymbol()
                           throws java.io.IOException,
                                  AutomationException

Text symbol used to draw the legend title.

Returns:

A reference to a com.esri.arcgis.display.ITextSymbol

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTitleSymbol

void setTitleSymbol(ITextSymbol symbol)
                    throws java.io.IOException,
                           AutomationException

Text symbol used to draw the legend title.

Parameters:

symbol - A reference to a com.esri.arcgis.display.ITextSymbol (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTitlePosition

int getTitlePosition()
                     throws java.io.IOException,
                            AutomationException

Legend title position.

Returns:

A com.esri.arcgis.carto.esriRectanglePosition constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTitlePosition

void setTitlePosition(int pos)
                      throws java.io.IOException,
                             AutomationException

Legend title position.

Parameters:

pos - A com.esri.arcgis.carto.esriRectanglePosition constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTitleGap

double getTitleGap()
                   throws java.io.IOException,
                          AutomationException

Vertical distance in points between title and first legend item.

Returns:

The gap

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTitleGap

void setTitleGap(double gap)
                 throws java.io.IOException,
                        AutomationException

Vertical distance in points between title and first legend item.

Parameters:

gap - The gap (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVerticalItemGap

double getVerticalItemGap()
                          throws java.io.IOException,
                                 AutomationException

Vertical distance in points between legend items.

Returns:

The gap

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVerticalItemGap

void setVerticalItemGap(double gap)
                        throws java.io.IOException,
                               AutomationException

Vertical distance in points between legend items.

Parameters:

gap - The gap (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHorizontalItemGap

double getHorizontalItemGap()
                            throws java.io.IOException,
                                   AutomationException

Horizontal distance in points between legend item columns. Used for legends that have more than one column.

Returns:

The gap

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHorizontalItemGap

void setHorizontalItemGap(double gap)
                          throws java.io.IOException,
                                 AutomationException

Horizontal distance in points between legend item columns. Used for legends that have more than one column.

Parameters:

gap - The gap (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerNameGap

double getLayerNameGap()
                       throws java.io.IOException,
                              AutomationException

Vertical distance in points between layer names and the legend graphics that follow.

Returns:

The gap

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLayerNameGap

void setLayerNameGap(double gap)
                     throws java.io.IOException,
                            AutomationException

Vertical distance in points between layer names and the legend graphics that follow.

Parameters:

gap - The gap (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGroupGap

double getGroupGap()
                   throws java.io.IOException,
                          AutomationException

Vertical distance in points between legend groups.

Returns:

The gap

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGroupGap

void setGroupGap(double gap)
                 throws java.io.IOException,
                        AutomationException

Vertical distance in points between legend groups.

Parameters:

gap - The gap (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHeadingGap

double getHeadingGap()
                     throws java.io.IOException,
                            AutomationException

Vertical distance in points between a heading and the legend graphics that follow.

Returns:

The gap

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHeadingGap

void setHeadingGap(double gap)
                   throws java.io.IOException,
                          AutomationException

Vertical distance in points between a heading and the legend graphics that follow.

Parameters:

gap - The gap (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTextGap

double getTextGap()
                  throws java.io.IOException,
                         AutomationException

Horizontal distance in points between labels and descriptions.

Returns:

The gap

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTextGap

void setTextGap(double gap)
                throws java.io.IOException,
                       AutomationException

Horizontal distance in points between labels and descriptions.

Parameters:

gap - The gap (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVerticalPatchGap

double getVerticalPatchGap()
                           throws java.io.IOException,
                                  AutomationException

Vertical distance in points between patches.

Returns:

The gap

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVerticalPatchGap

void setVerticalPatchGap(double gap)
                         throws java.io.IOException,
                                AutomationException

Vertical distance in points between patches.

Parameters:

gap - The gap (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHorizontalPatchGap

double getHorizontalPatchGap()
                             throws java.io.IOException,
                                    AutomationException

Horizontal distance in points between a patch and the legend graphics before and after.

Returns:

The gap

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHorizontalPatchGap

void setHorizontalPatchGap(double gap)
                           throws java.io.IOException,
                                  AutomationException

Horizontal distance in points between a patch and the legend graphics before and after.

Parameters:

gap - The gap (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultPatchWidth

double getDefaultPatchWidth()
                            throws java.io.IOException,
                                   AutomationException

Patch width in points. Can be overridden by the LegendItem.

Returns:

The width

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultPatchWidth

void setDefaultPatchWidth(double width)
                          throws java.io.IOException,
                                 AutomationException

Patch width in points. Can be overridden by the LegendItem.

Parameters:

width - The width (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultPatchHeight

double getDefaultPatchHeight()
                             throws java.io.IOException,
                                    AutomationException

Patch height in points. Can be overridden by the LegendItem.

Returns:

The height

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultPatchHeight

void setDefaultPatchHeight(double height)
                           throws java.io.IOException,
                                  AutomationException

Patch height in points. Can be overridden by the LegendItem.

Parameters:

height - The height (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultLinePatch

ILinePatch getDefaultLinePatch()
                               throws java.io.IOException,
                                      AutomationException

Line patch. Can be overridden by the LegendItem.

Returns:

A reference to a com.esri.arcgis.carto.ILinePatch

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultLinePatch

void setDefaultLinePatch(ILinePatch patch)
                         throws java.io.IOException,
                                AutomationException

Line patch. Can be overridden by the LegendItem.

Parameters:

patch - A reference to a com.esri.arcgis.carto.ILinePatch (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultAreaPatch

IAreaPatch getDefaultAreaPatch()
                               throws java.io.IOException,
                                      AutomationException

Area patch. Can be overridden by the LegendItem.

Returns:

A reference to a com.esri.arcgis.carto.IAreaPatch

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultAreaPatch

void setDefaultAreaPatch(IAreaPatch patch)
                         throws java.io.IOException,
                                AutomationException

Area patch. Can be overridden by the LegendItem.

Parameters:

patch - A reference to a com.esri.arcgis.carto.IAreaPatch (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

scale

void scale(double xScale,
           double yScale)
           throws java.io.IOException,
                  AutomationException

Multiply all distances, gaps, and size property values on this interface by the specified scale factors.

Parameters:

xScale - The xScale (in)

yScale - The yScale (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.