com.esri.arcgis.carto
Class BackgroundStyleGalleryClass

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

All Implemented Interfaces:

IStyleGalleryClass, IStyleGalleryClass2, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class BackgroundStyleGalleryClass
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IStyleGalleryClass, IStyleGalleryClass2

Use to create new Background style items.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

BackgroundStyleGalleryClass()
Constructs a BackgroundStyleGalleryClass using ArcGIS Engine.

BackgroundStyleGalleryClass(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
BackgroundStyleGalleryClass theBackgroundStyleGalleryClass = (BackgroundStyleGalleryClass) obj;

Method Summary

void	editProperties(Object[] galleryItem, IComPropertySheetEvents listener, int hWnd, boolean[] ok) Edits the properties of a Style Gallery Item of the supported class.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
String	getDescription() Description for the Style Gallery Class.
String	getDisplayName() Display name of the Style Gallery Class.
GUID	getItemClass() Interface ID for the items in the class.
String	getName() Name of the Style Gallery Class(as in the stle file).
Object	getNewObject(String newType) Creates a new object of the specified type.
IEnumBSTR	getNewObjectTypes() The available types of new items in this class.
double	getPreviewRatio() The width ratio to 1 height.
int	hashCode() the hashcode for this object
void	preview(Object galleryItem, int hDC, tagRECT rectangle) Draws a preview of a Style Gallery Item of the supported class.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

BackgroundStyleGalleryClass

public BackgroundStyleGalleryClass()
                            throws IOException,
                                   UnknownHostException

Constructs a BackgroundStyleGalleryClass using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

BackgroundStyleGalleryClass

public BackgroundStyleGalleryClass(Object obj)
                            throws IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getName

public String getName()
               throws IOException,
                      AutomationException

Name of the Style Gallery Class(as in the stle file).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IStyleGalleryClass

Specified by:

getName in interface IStyleGalleryClass2

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException

Description for the Style Gallery Class.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDescription in interface IStyleGalleryClass

Specified by:

getDescription in interface IStyleGalleryClass2

Returns:

The description

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getItemClass

public GUID getItemClass()
                  throws IOException,
                         AutomationException

Interface ID for the items in the class.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getItemClass in interface IStyleGalleryClass

Specified by:

getItemClass in interface IStyleGalleryClass2

Returns:

A Structure: com.esri.arcgis.support.ms.stdole.GUID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNewObjectTypes

public IEnumBSTR getNewObjectTypes()
                            throws IOException,
                                   AutomationException

The available types of new items in this class.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNewObjectTypes in interface IStyleGalleryClass

Specified by:

getNewObjectTypes in interface IStyleGalleryClass2

Returns:

A reference to a com.esri.arcgis.system.IEnumBSTR

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNewObject

public Object getNewObject(String newType)
                    throws IOException,
                           AutomationException

Creates a new object of the specified type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getNewObject in interface IStyleGalleryClass

Specified by:

getNewObject in interface IStyleGalleryClass2

Parameters:

newType - The newType (in)

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPreviewRatio

public double getPreviewRatio()
                       throws IOException,
                              AutomationException

The width ratio to 1 height.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPreviewRatio in interface IStyleGalleryClass

Specified by:

getPreviewRatio in interface IStyleGalleryClass2

Returns:

The ratio

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

preview

public void preview(Object galleryItem,
                    int hDC,
                    tagRECT rectangle)
             throws IOException,
                    AutomationException

Draws a preview of a Style Gallery Item of the supported class.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

preview in interface IStyleGalleryClass

Specified by:

preview in interface IStyleGalleryClass2

Parameters:

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

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

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

editProperties

public void editProperties(Object[] galleryItem,
                           IComPropertySheetEvents listener,
                           int hWnd,
                           boolean[] ok)
                    throws IOException,
                           AutomationException

Edits the properties of a Style Gallery Item of the supported class.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

editProperties in interface IStyleGalleryClass

Specified by:

editProperties in interface IStyleGalleryClass2

Parameters:

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

listener - A reference to a com.esri.arcgis.systemUI.IComPropertySheetEvents (in)

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

ok - The ok (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayName

public String getDisplayName()
                      throws IOException,
                             AutomationException

Display name of the Style Gallery Class.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getDisplayName in interface IStyleGalleryClass2

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.