Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.carto
Interface ILegendItem2

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
HorizontalBarLegendItem, HorizontalLegendItem, ILegendItem2Proxy, NestedLegendItem, VerticalLegendItem
public interface ILegendItem2
extends java.io.Serializable

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

Description: 'Provides access to members that control how a layer appears in a legend. Can be stored in a style.' 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 IID7d23f970_d5a6_4c1c_8618_3cc7b5839efa
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void changeFlowDirection(boolean rightToLeft)
          Indicates if a legend's flow direction changes.
 void createGraphics(IDisplay display, ILegendFormat legendFormat)
          Rebuilds the list of graphics.
 short getColumns()
          Number of columns in the legend item.
 IEnumElement getGraphics()
          List of graphics that represent the legend item.
 int getGroupIndex()
          Zero-based index of the legend group shown by this item.
 ITextSymbol getHeadingSymbol()
          Text symbol used to draw the heading.
 double getHeight()
          Height of the item in points.
 ILayer getLayer()
          Associated layer.
 ITextSymbol getLayerNameSymbol()
          Text symbol used to draw the layer name.
 ILegendClassFormat getLegendClassFormat()
          Default formatting information for the legend classes.
 java.lang.String getName()
          Name of the style.
 double getWidth()
          Width of the item in points.
 boolean isCanDisplay(ILayer layer)
          Indicates if the style is compatible with the specified layer.
 boolean isKeepTogether()
          Indicates if classes must appear in a single column or whether they can be split across multiple columns.
 boolean isNewColumn()
          Indicates if the item starts a new column in the legend.
 boolean isShowDescriptions()
          Indicates if descriptions are visible.
 boolean isShowHeading()
          Indicates if heading is visibile.
 boolean isShowLabels()
          Indicates if labels are visible.
 boolean isShowLayerName()
          Indicates if layer name is visibile.
 void setColumns(short columns)
          Number of columns in the legend item.
 void setGroupIndex(int index)
          Zero-based index of the legend group shown by this item.
 void setHeadingSymbol(ITextSymbol symbol)
          Text symbol used to draw the heading.
 void setKeepTogether(boolean flag)
          Indicates if classes must appear in a single column or whether they can be split across multiple columns.
 void setLayerByRef(ILayer layer)
          Associated layer.
 void setLayerNameSymbol(ITextSymbol symbol)
          Text symbol used to draw the layer name.
 void setLegendClassFormat(ILegendClassFormat format)
          Default formatting information for the legend classes.
 void setNewColumn(boolean flag)
          Indicates if the item starts a new column in the legend.
 void setShowDescriptions(boolean showDescriptions)
          Indicates if descriptions are visible.
 void setShowHeading(boolean showHeading)
          Indicates if heading is visibile.
 void setShowLabels(boolean showLabels)
          Indicates if labels are visible.
 void setShowLayerName(boolean showLayerName)
          Indicates if layer name is visibile.
 

Field Detail

IID7d23f970_d5a6_4c1c_8618_3cc7b5839efa

static final int IID7d23f970_d5a6_4c1c_8618_3cc7b5839efa
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

getName

java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
Name of the style.

Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanDisplay

boolean isCanDisplay(ILayer layer)
                     throws java.io.IOException,
                            AutomationException
Indicates if the style is compatible with the specified layer.

Parameters:
layer - A reference to a com.esri.arcgis.carto.ILayer (in)
Returns:
The result
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayer

ILayer getLayer()
                throws java.io.IOException,
                       AutomationException
Associated layer.

Returns:
A reference to a com.esri.arcgis.carto.ILayer
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLayerByRef

void setLayerByRef(ILayer layer)
                   throws java.io.IOException,
                          AutomationException
Associated layer.

Parameters:
layer - A reference to a com.esri.arcgis.carto.ILayer (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isNewColumn

boolean isNewColumn()
                    throws java.io.IOException,
                           AutomationException
Indicates if the item starts a new column in the legend.

Returns:
The flag
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNewColumn

void setNewColumn(boolean flag)
                  throws java.io.IOException,
                         AutomationException
Indicates if the item starts a new column in the legend.

Parameters:
flag - The flag (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getColumns

short getColumns()
                 throws java.io.IOException,
                        AutomationException
Number of columns in the legend item.

Returns:
The columns
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setColumns

void setColumns(short columns)
                throws java.io.IOException,
                       AutomationException
Number of columns in the legend item.

Parameters:
columns - The columns (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isKeepTogether

boolean isKeepTogether()
                       throws java.io.IOException,
                              AutomationException
Indicates if classes must appear in a single column or whether they can be split across multiple columns.

Returns:
The flag
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setKeepTogether

void setKeepTogether(boolean flag)
                     throws java.io.IOException,
                            AutomationException
Indicates if classes must appear in a single column or whether they can be split across multiple columns.

Parameters:
flag - The flag (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowLayerName

boolean isShowLayerName()
                        throws java.io.IOException,
                               AutomationException
Indicates if layer name is visibile.

Returns:
The showLayerName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowLayerName

void setShowLayerName(boolean showLayerName)
                      throws java.io.IOException,
                             AutomationException
Indicates if layer name is visibile.

Parameters:
showLayerName - The showLayerName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayerNameSymbol

ITextSymbol getLayerNameSymbol()
                               throws java.io.IOException,
                                      AutomationException
Text symbol used to draw the layer name.

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.

setLayerNameSymbol

void setLayerNameSymbol(ITextSymbol symbol)
                        throws java.io.IOException,
                               AutomationException
Text symbol used to draw the layer name.

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.

getGroupIndex

int getGroupIndex()
                  throws java.io.IOException,
                         AutomationException
Zero-based index of the legend group shown by this item. Use -1 to show all legend groups using this item.

Returns:
The index
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGroupIndex

void setGroupIndex(int index)
                   throws java.io.IOException,
                          AutomationException
Zero-based index of the legend group shown by this item. Use -1 to show all legend groups using this item.

Parameters:
index - The index (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowHeading

boolean isShowHeading()
                      throws java.io.IOException,
                             AutomationException
Indicates if heading is visibile.

Returns:
The showHeading
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowHeading

void setShowHeading(boolean showHeading)
                    throws java.io.IOException,
                           AutomationException
Indicates if heading is visibile.

Parameters:
showHeading - The showHeading (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHeadingSymbol

ITextSymbol getHeadingSymbol()
                             throws java.io.IOException,
                                    AutomationException
Text symbol used to draw the heading.

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.

setHeadingSymbol

void setHeadingSymbol(ITextSymbol symbol)
                      throws java.io.IOException,
                             AutomationException
Text symbol used to draw the heading.

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.

getLegendClassFormat

ILegendClassFormat getLegendClassFormat()
                                        throws java.io.IOException,
                                               AutomationException
Default formatting information for the legend classes. Renderer may override.

Returns:
A reference to a com.esri.arcgis.carto.ILegendClassFormat
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLegendClassFormat

void setLegendClassFormat(ILegendClassFormat format)
                          throws java.io.IOException,
                                 AutomationException
Default formatting information for the legend classes. Renderer may override.

Parameters:
format - A reference to a com.esri.arcgis.carto.ILegendClassFormat (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowLabels

boolean isShowLabels()
                     throws java.io.IOException,
                            AutomationException
Indicates if labels are visible.

Returns:
The showLabels
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowLabels

void setShowLabels(boolean showLabels)
                   throws java.io.IOException,
                          AutomationException
Indicates if labels are visible.

Parameters:
showLabels - The showLabels (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowDescriptions

boolean isShowDescriptions()
                           throws java.io.IOException,
                                  AutomationException
Indicates if descriptions are visible.

Returns:
The showDescriptions
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowDescriptions

void setShowDescriptions(boolean showDescriptions)
                         throws java.io.IOException,
                                AutomationException
Indicates if descriptions are visible.

Parameters:
showDescriptions - The showDescriptions (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createGraphics

void createGraphics(IDisplay display,
                    ILegendFormat legendFormat)
                    throws java.io.IOException,
                           AutomationException
Rebuilds the list of graphics. Call whenever the associated layer changes.

Parameters:
display - A reference to a com.esri.arcgis.display.IDisplay (in)
legendFormat - A reference to a com.esri.arcgis.carto.ILegendFormat (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWidth

double getWidth()
                throws java.io.IOException,
                       AutomationException
Width of the item in points. Must call CreateGraphics first.

Returns:
The width
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHeight

double getHeight()
                 throws java.io.IOException,
                        AutomationException
Height of the item in points. Must call CreateGraphics first.

Returns:
The height
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGraphics

IEnumElement getGraphics()
                         throws java.io.IOException,
                                AutomationException
List of graphics that represent the legend item. Must call CreateGraphics first.

Returns:
A reference to a com.esri.arcgis.carto.IEnumElement
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

changeFlowDirection

void changeFlowDirection(boolean rightToLeft)
                         throws java.io.IOException,
                                AutomationException
Indicates if a legend's flow direction changes. Update alignment settings.

Parameters:
rightToLeft - The rightToLeft (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD