com.esri.arcgis.carto
Class BackgroundTabStyle

java.lang.Object
  com.esri.arcgis.carto.BackgroundTabStyle

All Implemented Interfaces:

IBackgroundTabStyle, IGridLabel, IGridLabel2, IGridLabelExport, IIndexGridTabStyle, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class BackgroundTabStyle
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IIndexGridTabStyle, IBackgroundTabStyle, IGridLabel, IGridLabel2, IGridLabelExport, IPersistStream, java.io.Externalizable

COM Class 'BackgroundTabStyle'. Generated 3/19/2015 1:20:41 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description 'A background tab style grid label for index grids.' 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 =

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.carto.IIndexGridTabStyle

IID, IIDce41c50a_9df9_11d2_aade_000000000000, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IBackgroundTabStyle

IID, IIDce41c50c_9df9_11d2_aade_000000000000, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IGridLabel

IID, IIDce41c501_9df9_11d2_aade_000000000000, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IGridLabel2

IID, IID76b22cba_a25b_41e5_b8ba_f29ae31822bb, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IGridLabelExport

IID, IIDed656e23_e953_11d3_9fda_00c04f6bc78e, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Constructor Summary

BackgroundTabStyle()
Constructs a BackgroundTabStyle using ArcGIS Engine.

BackgroundTabStyle(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
BackgroundTabStyle theBackgroundTabStyle = (BackgroundTabStyle) obj;

Method Summary

IElement	createElement(double labelValue, IPoint location, int axis, IDisplay display) Creates a graphic element for a label on the specified grid axis.
void	draw(double labelValue, IPoint location, int axis, IDisplay display) Draws a label on the specified grid axis.
boolean	equals(java.lang.Object o) Compare this object with another
int	getBackgroundType() The type of the background tab style.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
IColor	getColor() The color of the grid label.
java.lang.String	getDisplayName() The display name for the type of grid label.
java.lang.Object	getEditObject() The interface to an object that can be edited with a property sheet.
Font	getFont() The font used by the grid label.
double	getFontSize() The font size used by the grid label.
IColor	getForegroundColor() The foreground color of the tab.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
double	getLabelOffset() The offset of the grid label from the border in points.
IColor	getOutlineColor() The outline color of the tab.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
double	getThickness() The thickness of the tab in points.
int	hashCode() the hashcode for this object
boolean	isApplies(IMapGrid grid) Indicates if this grid label can be used with the specified map grid.
void	isDirty() isDirty
boolean	isLabelAlignment(int axis) Indicates if the grid label is horizontal (true) or vertical (false) on the specified axis.
void	load(IStream pstm) load
void	prepareDraw(java.lang.String labelValue, double tabWidthPage, int axis) Sets up the tab for drawing.
void	preview(int hDC, tagRECT rectangle) Draws a preview of the grid label into the specified hdc.
void	queryTextExtent(double labelValue, IPoint location, int axis, IDisplay display, IEnvelope extent) Determines the extent of a label's text on the specified grid axis.
void	readExternal(java.io.ObjectInput in)
void	release() Release a BackgroundTabStyle.
void	save(IStream pstm, int fClearDirty) save
void	setBackgroundType(int tabType) The type of the background tab style.
void	setColor(IColor color) The color of the grid label.
void	setEditObject(java.lang.Object ppObject) The interface to an object that can be edited with a property sheet.
void	setFont(Font font) The font used by the grid label.
void	setFontSize(double size) The font size used by the grid label.
void	setForegroundColor(IColor color) The foreground color of the tab.
void	setLabelAlignment(int axis, boolean horizontal) Indicates if the grid label is horizontal (true) or vertical (false) on the specified axis.
void	setLabelOffset(double offsetPoints) The offset of the grid label from the border in points.
void	setOutlineColor(IColor color) The outline color of the tab.
void	setThickness(double thicknessPts) The thickness of the tab in points.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

BackgroundTabStyle

public BackgroundTabStyle()
                   throws java.io.IOException,
                          java.net.UnknownHostException

Constructs a BackgroundTabStyle using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

BackgroundTabStyle

public BackgroundTabStyle(java.lang.Object obj)
                   throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
BackgroundTabStyle theBackgroundTabStyle = (BackgroundTabStyle) obj;

Construct a BackgroundTabStyle using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to BackgroundTabStyle.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a BackgroundTabStyle.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getForegroundColor

public IColor getForegroundColor()
                          throws java.io.IOException,
                                 AutomationException

The foreground color of the tab.

Specified by:

getForegroundColor in interface IIndexGridTabStyle

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setForegroundColor

public void setForegroundColor(IColor color)
                        throws java.io.IOException,
                               AutomationException

The foreground color of the tab.

Specified by:

setForegroundColor in interface IIndexGridTabStyle

Parameters:

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOutlineColor

public IColor getOutlineColor()
                       throws java.io.IOException,
                              AutomationException

The outline color of the tab.

Specified by:

getOutlineColor in interface IIndexGridTabStyle

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOutlineColor

public void setOutlineColor(IColor color)
                     throws java.io.IOException,
                            AutomationException

The outline color of the tab.

Specified by:

setOutlineColor in interface IIndexGridTabStyle

Parameters:

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getThickness

public double getThickness()
                    throws java.io.IOException,
                           AutomationException

The thickness of the tab in points.

Specified by:

getThickness in interface IIndexGridTabStyle

Returns:

The thicknessPts

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setThickness

public void setThickness(double thicknessPts)
                  throws java.io.IOException,
                         AutomationException

The thickness of the tab in points.

Specified by:

setThickness in interface IIndexGridTabStyle

Parameters:

thicknessPts - The thicknessPts (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

prepareDraw

public void prepareDraw(java.lang.String labelValue,
                        double tabWidthPage,
                        int axis)
                 throws java.io.IOException,
                        AutomationException

Sets up the tab for drawing.

Specified by:

prepareDraw in interface IIndexGridTabStyle

Parameters:

labelValue - The labelValue (in)

tabWidthPage - The tabWidthPage (in)

axis - A com.esri.arcgis.carto.esriGridAxisEnum constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBackgroundType

public int getBackgroundType()
                      throws java.io.IOException,
                             AutomationException

The type of the background tab style.

Specified by:

getBackgroundType in interface IBackgroundTabStyle

Returns:

A com.esri.arcgis.carto.esriBackgroundTabType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBackgroundType

public void setBackgroundType(int tabType)
                       throws java.io.IOException,
                              AutomationException

The type of the background tab style.

Specified by:

setBackgroundType in interface IBackgroundTabStyle

Parameters:

tabType - A com.esri.arcgis.carto.esriBackgroundTabType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDisplayName

public java.lang.String getDisplayName()
                                throws java.io.IOException,
                                       AutomationException

The display name for the type of grid label.

Specified by:

getDisplayName in interface IGridLabel

Specified by:

getDisplayName in interface IGridLabel2

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isApplies

public boolean isApplies(IMapGrid grid)
                  throws java.io.IOException,
                         AutomationException

Indicates if this grid label can be used with the specified map grid.

Specified by:

isApplies in interface IGridLabel

Specified by:

isApplies in interface IGridLabel2

Parameters:

grid - A reference to a com.esri.arcgis.carto.IMapGrid (in)

Returns:

The applies

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEditObject

public java.lang.Object getEditObject()
                               throws java.io.IOException,
                                      AutomationException

The interface to an object that can be edited with a property sheet. The object is either the grid label itself or a single editable property.

Specified by:

getEditObject in interface IGridLabel

Specified by:

getEditObject in interface IGridLabel2

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEditObject

public void setEditObject(java.lang.Object ppObject)
                   throws java.io.IOException,
                          AutomationException

The interface to an object that can be edited with a property sheet. The object is either the grid label itself or a single editable property.

Specified by:

setEditObject in interface IGridLabel

Specified by:

setEditObject in interface IGridLabel2

Parameters:

ppObject - A reference to another Object (IUnknown) (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFont

public Font getFont()
             throws java.io.IOException,
                    AutomationException

The font used by the grid label.

Specified by:

getFont in interface IGridLabel

Specified by:

getFont in interface IGridLabel2

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFont

public void setFont(Font font)
             throws java.io.IOException,
                    AutomationException

The font used by the grid label.

Specified by:

setFont in interface IGridLabel

Specified by:

setFont in interface IGridLabel2

Parameters:

font - A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef) (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getColor

public IColor getColor()
                throws java.io.IOException,
                       AutomationException

The color of the grid label.

Specified by:

getColor in interface IGridLabel

Specified by:

getColor in interface IGridLabel2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setColor

public void setColor(IColor color)
              throws java.io.IOException,
                     AutomationException

The color of the grid label.

Specified by:

setColor in interface IGridLabel

Specified by:

setColor in interface IGridLabel2

Parameters:

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLabelOffset

public double getLabelOffset()
                      throws java.io.IOException,
                             AutomationException

The offset of the grid label from the border in points.

Specified by:

getLabelOffset in interface IGridLabel

Specified by:

getLabelOffset in interface IGridLabel2

Returns:

The offsetPoints

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLabelOffset

public void setLabelOffset(double offsetPoints)
                    throws java.io.IOException,
                           AutomationException

The offset of the grid label from the border in points.

Specified by:

setLabelOffset in interface IGridLabel

Specified by:

setLabelOffset in interface IGridLabel2

Parameters:

offsetPoints - The offsetPoints (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isLabelAlignment

public boolean isLabelAlignment(int axis)
                         throws java.io.IOException,
                                AutomationException

Indicates if the grid label is horizontal (true) or vertical (false) on the specified axis.

Specified by:

isLabelAlignment in interface IGridLabel

Specified by:

isLabelAlignment in interface IGridLabel2

Parameters:

axis - A com.esri.arcgis.carto.esriGridAxisEnum constant (in)

Returns:

The horizontal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLabelAlignment

public void setLabelAlignment(int axis,
                              boolean horizontal)
                       throws java.io.IOException,
                              AutomationException

Indicates if the grid label is horizontal (true) or vertical (false) on the specified axis.

Specified by:

setLabelAlignment in interface IGridLabel

Specified by:

setLabelAlignment in interface IGridLabel2

Parameters:

axis - A com.esri.arcgis.carto.esriGridAxisEnum constant (in)

horizontal - The horizontal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryTextExtent

public void queryTextExtent(double labelValue,
                            IPoint location,
                            int axis,
                            IDisplay display,
                            IEnvelope extent)
                     throws java.io.IOException,
                            AutomationException

Determines the extent of a label's text on the specified grid axis.

Specified by:

queryTextExtent in interface IGridLabel

Specified by:

queryTextExtent in interface IGridLabel2

Parameters:

labelValue - The labelValue (in)

location - A reference to a com.esri.arcgis.geometry.IPoint (in)

axis - A com.esri.arcgis.carto.esriGridAxisEnum constant (in)

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

extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

draw

public void draw(double labelValue,
                 IPoint location,
                 int axis,
                 IDisplay display)
          throws java.io.IOException,
                 AutomationException

Draws a label on the specified grid axis.

Specified by:

draw in interface IGridLabel

Specified by:

draw in interface IGridLabel2

Parameters:

labelValue - The labelValue (in)

location - A reference to a com.esri.arcgis.geometry.IPoint (in)

axis - A com.esri.arcgis.carto.esriGridAxisEnum constant (in)

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

preview

public void preview(int hDC,
                    tagRECT rectangle)
             throws java.io.IOException,
                    AutomationException

Draws a preview of the grid label into the specified hdc.

Specified by:

preview in interface IGridLabel

Specified by:

preview in interface IGridLabel2

Parameters:

hDC - The hDC (A COM typedef) (in)

rectangle - A Structure: com.esri.arcgis.system.tagRECT (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFontSize

public double getFontSize()
                   throws java.io.IOException,
                          AutomationException

The font size used by the grid label.

Specified by:

getFontSize in interface IGridLabel2

Returns:

The size

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFontSize

public void setFontSize(double size)
                 throws java.io.IOException,
                        AutomationException

The font size used by the grid label.

Specified by:

setFontSize in interface IGridLabel2

Parameters:

size - The size (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createElement

public IElement createElement(double labelValue,
                              IPoint location,
                              int axis,
                              IDisplay display)
                       throws java.io.IOException,
                              AutomationException

Creates a graphic element for a label on the specified grid axis.

Specified by:

createElement in interface IGridLabelExport

Parameters:

labelValue - The labelValue (in)

location - A reference to a com.esri.arcgis.geometry.IPoint (in)

axis - A com.esri.arcgis.carto.esriGridAxisEnum constant (in)

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException