net.refractions.udig.catalog.ui
Interface ISharedImages


public interface ISharedImages

A registry for common images which may be useful to other plug-ins.

This lists the ImageDescriptors that are available via RegistryUI.getImageResource(). The fact that a constant is mentioned here, by convention, makes the associated Image part of the Plug-In api.

To use one of these images:

 ImageRegistry images = CatalogUIPlugin.getDefault().getImageRegistry();
 ImageDescriptor image = images.getDescriptor(ISharedImages.IMG_DATASTORE_OBJ);
 

This interface is not intended to be implemented by clients.


Field Summary
static java.lang.String CATALOG_OBJ
          Generic catalog glyph
static java.lang.String DATABASE_OBJ
          Shared Image representing a database.
static java.lang.String DATASTORE_OBJ
          Shared Image representing a Datastore (generic feature information).
static java.lang.String ERROR_OVR
          Represent a data source with an erro condition.
static java.lang.String FEATURE_FILE_OBJ
          Graphic representing a Feature File
static java.lang.String FEATURE_OBJ
          Graphic representing a Feature (default for an indivudal IGeoResource)
static java.lang.String FILE_OBJ
          Generic storage glyph.
static java.lang.String GCE_OBJ
          Shared Image representing a Grid Coverage Exchange (generic raster information).
static java.lang.String GRAPHIC_OBJ
          Graphic representing a generated graphic
static java.lang.String GRID_FILE_OBJ
          Graphic representing a Grid based file format
static java.lang.String GRID_MISSING
           
static java.lang.String GRID_OBJ
          Graphic representing a Grid (default for an indivudal IGeoResource)
static java.lang.String MAP_GRAPHICS_OBJ
          Graphic representing a all generated map graphics
static java.lang.String MEMORY_OBJ
          Generic storage glyph.
static java.lang.String PALETTE_OBJ
          Palette of map graphics (synthetic content)
static java.lang.String PIXEL_OBJ
          Graphic representing a Grid (default for an indivudal IGeoResource)
static java.lang.String RESOURCE_OBJ
          Graphic representing a Grid (default for an indivudal IGeoResource)
static java.lang.String SERVER_OBJ
          Generic external provider of information.
static java.lang.String WAIT_OVR
          Represent a data source waiting for status information.
static java.lang.String WARNING_OVR
          Represents a data source with a warning codition.
static java.lang.String WFS_OBJ
          Web Feature Server is a standards based external source of feature information.
static java.lang.String WMS_OBJ
          Web Map Server is a standards based external source of raster information.
static java.lang.String WRS_OBJ
          Wen Registry Service registry (a OWS Catalog)
 
Method Summary
 Image get(java.lang.String id)
          Returns shared image for the given image ID.
 ImageDescriptor getImageDescriptor(java.lang.String id)
          Returns the image descriptor for the given image ID.
 

Field Detail

MAP_GRAPHICS_OBJ

static final java.lang.String MAP_GRAPHICS_OBJ
Graphic representing a all generated map graphics


GRAPHIC_OBJ

static final java.lang.String GRAPHIC_OBJ
Graphic representing a generated graphic


CATALOG_OBJ

static final java.lang.String CATALOG_OBJ
Generic catalog glyph


DATABASE_OBJ

static final java.lang.String DATABASE_OBJ
Shared Image representing a database.


DATASTORE_OBJ

static final java.lang.String DATASTORE_OBJ
Shared Image representing a Datastore (generic feature information).


ERROR_OVR

static final java.lang.String ERROR_OVR
Represent a data source with an erro condition.


FEATURE_FILE_OBJ

static final java.lang.String FEATURE_FILE_OBJ
Graphic representing a Feature File


FEATURE_OBJ

static final java.lang.String FEATURE_OBJ
Graphic representing a Feature (default for an indivudal IGeoResource)


FILE_OBJ

static final java.lang.String FILE_OBJ
Generic storage glyph.


GCE_OBJ

static final java.lang.String GCE_OBJ
Shared Image representing a Grid Coverage Exchange (generic raster information).


GRID_FILE_OBJ

static final java.lang.String GRID_FILE_OBJ
Graphic representing a Grid based file format


GRID_OBJ

static final java.lang.String GRID_OBJ
Graphic representing a Grid (default for an indivudal IGeoResource)


GRID_MISSING

static final java.lang.String GRID_MISSING

PIXEL_OBJ

static final java.lang.String PIXEL_OBJ
Graphic representing a Grid (default for an indivudal IGeoResource)


MEMORY_OBJ

static final java.lang.String MEMORY_OBJ
Generic storage glyph.


PALETTE_OBJ

static final java.lang.String PALETTE_OBJ
Palette of map graphics (synthetic content)


RESOURCE_OBJ

static final java.lang.String RESOURCE_OBJ
Graphic representing a Grid (default for an indivudal IGeoResource)


SERVER_OBJ

static final java.lang.String SERVER_OBJ
Generic external provider of information.


WAIT_OVR

static final java.lang.String WAIT_OVR
Represent a data source waiting for status information.


WARNING_OVR

static final java.lang.String WARNING_OVR
Represents a data source with a warning codition.

A warning means that the system is making an assumption. The user should be able to edit the data source and fix the problem.

The context menu could provide a list of suggested fixes, or if there is only one it should probably just do it. An example of this would be getting back a redirect for WFS url. The fix would be to remember the redirect (rather than the origional). This is the kind of thing that should just happen.


WFS_OBJ

static final java.lang.String WFS_OBJ
Web Feature Server is a standards based external source of feature information.


WMS_OBJ

static final java.lang.String WMS_OBJ
Web Map Server is a standards based external source of raster information.


WRS_OBJ

static final java.lang.String WRS_OBJ
Wen Registry Service registry (a OWS Catalog)

Method Detail

get

Image get(java.lang.String id)
Returns shared image for the given image ID. Returns null if there is no such image.

Parameters:
id - Constant from ISharedImages
Returns:
Shared image for image ID, do plugin will manage disposal.

getImageDescriptor

ImageDescriptor getImageDescriptor(java.lang.String id)
Returns the image descriptor for the given image ID. Returns null if there is no such image.

Parameters:
id - Constant from ISharedImages
Returns:
ImageDescriptor locating resource associated with id