User Tools

Site Tools


api:dk11:java:tatukgis.jdk.tgis_layer

TGIS_Layer class

DK11 for Java | tatukgis.jdk.TGIS_Layer | Classes | Constructors | Fields | Methods | Properties | Events

General layer class. Must be derived to provide file access.

Available also on: Delphi | .NET | ActiveX.

Syntax

// Java
public class TGIS_Layer extends TGIS_LayerAbstract {
};
// Oxygene
type
  TGIS_Layer = public class( TGIS_LayerAbstract )
  end;

Inheritance

→ TGIS_BaseObjectDisposable → TGIS_LayerAbstract

Constructors

Inherited Overrides Protected
Name Visibility Description
TGIS_Layer() public Create a layer with default parameters.

Fields

Inherited Protected
Name Visibility Description
FActive protected Is layer active?
FAddition protected Addition value.
FAge protected Age of the layer.
FBasemap protected True if the layer is interpreted as basemap.
FCachedPaint protected False if layer must be painted directly (bypassing cache).
FCaption protected Layer caption.
FCodePage protected Code Page in which text has been stored.
FCodePageForced protected Code Page forced by project file or property setting.
FCollapsed protected Is layer collapsed?
FComments protected Additional comments.
FConfigFile protected Configuration file handle.
FConfigFile2 protected Configuration file handle.
FConfigName protected Configuration file name.
FCS protected Projection object.
FCustomData protected List of custom data.
FDormantMode protected Dormant mode for the layer.
FDriver protected Layer driver.
FExtent protected Layer extent.
FExtent3D protected Layer extent 3D.
FFileCopyright protected Additional textual information about layer copyright.
FFileInfo protected Additional textual information about the layer such as compression, number of pixels, copyright etc.
FHideFromLegend protected True if layer should not be visible in a legend.
FIsLocked protected True if layer is in locked state Lock.
FIsModified protected True if structure (field, geometry etc) was modified.
FIsOpened protected True if layer was opened.
FIsPrepared protected True if layer was opened.
FIsReadOnly protected Read only flag.
FMaxTileSize protected Maximum allowed tile size for the layer.
FMultiUserMode protected Multiuser mode.
FName protected Layer name.
FOnBusy protected Busy event.
FOnPaintLayer protected PaintLayer event.
FOnPassword protected Will be fired upon opening layer to resolve any username/password
FOnRead protected Will be fired upon each file Read request.
FOnWrite protected Will be fired upon each file Write request.
forceCachedMode protected Set tor True to force cached (bitmap) type of drawing.
FParams protected Selected parameters set.
FParamsList protected List of parameters set (sections).
FParentLayer protected Parent layer.
FPath protected Layer path.
FProjectedExtent protected Precalculated projected extent.
FProjectedExtentBase protected Precalculated projected extent - Base extent (unprojected).
FProjectedExtentEPSG protected Precalculated projected extent - Layer CS Context.
FProjectedExtentRotationAngle protected Precalculated projected extent - Rotation context.
FProjectedExtentRotationPoint protected Precalculated projected extent - Rotation context.
FProjectedExtentViewerEPSG protected Precalculated projected extent - Viewer CS Context.
FRenderer protected Handle to a renderer used for drawing shapes.
FStatistics protected Statistics engine.
FStream protected Reference to a potential layer underlying stream.
FSubLayers protected Sub layers list.
FSubType protected Type of sublayer.
FTag protected Tag value.
FTagInternal protected Internal Tag value.
FTagPointer protected Pointer Tag value
FTransform protected Custom transformation.
FTransparency protected Transparency value.
FUnSupportedOperations protected Set of operations not supported by a layer.
FUseConfig protected Is config file active?
FUserObject protected User object.
FViewer protected Reference to viewer object.
inDraw protected True if layer paint procedure not yet complete.
paramsCache protected List of prepared parameters.
View3D public 3D Representation properties.

Methods

Inherited Overrides Protected
Name Visibility Description
Alive public Makes a layer non-dormant.
applyConfigOptions protected Read config option parameters.
applyConfigProjection protected Read config projection parameters.
ApplyCuttingPolygon public Sets a cutting polygon for a layer.
ChangeHash public Changes the hash for the purpose of verifying layer's modifications.
ClearModified public Sets IsModified flag to false for a layer and its sublayers.
Dormant public Makes a layer dormant.
DormantGain public Calculates the approximate gain (in Megabytes) which can be achieved by releasing memory by calling Dormant method.
Draw public Draws a layer.
DrawEx public Draws a layer within a defined extent.
drawExtent protected Calculates the drawing area /clipping area of device/.
drawExtentEx protected Calculates the drawing area /clipping area of device/.
DrawFlash public Draws a flash.
DrawSelected public Draws only the selected item(s) on layer.
DrawSelectedEx public Draws only the selected item(s) on layer that are within a defined extent.
ForEachSubLayer public Returns in callback event the layer and all sublayers belonging to it.
GetAvailableLayers public Gets a list of layers available in storage.
HourglassShake public Notifies of busy state using an hourglass.
IsGrid public Checks if the layer type is grid.
IsPixel public Checks if the layer type is pixel.
isSublayer protected Checks if the layer is a sublayer.
IsSupported public Checks if the operation is supported by the layer.
IsVector public Checks if the layer type is vector.
IsVector3D public Checks if the layer type is vector 3D.
IsVisible public Checks if the layer is visible in a defined extent and current params.
Lock public Locks layer in burst-mode operation.
lockThread protected Locks thread.
Move public Moves a layer up or down in the viewer zorder list.
MoveEx public Moves a layer up or down in the viewer zorder list (only visible layers).
MustCalculateStatistics public Verifies if all statistics required to properly render the layer are available.
MustReproject public Checks if the layer must be reprojected.
MustSave public Checks if the layer was modified by editing.
Open public Opens the layer.
optimizeParamsCache(int) protected Move section specified by _idx to the top of the cached list.
optimizeParamsCache(int, bool) protected Move section specified by _idx to the top of the cached list.
Paint public Draws the layer or fires PaintLayer event (if defined).
Prepare public Opens the layer.
prepareParamsCache protected Prepare cached section list meeting the _style name.
prepareParamsCache(java.lang.String) protected Prepare cached section list meeting the _style name.
PreRecognize public Checks if the layer can read the file.
Project public Applies a projection on the single point.
Project3D public Applies a projection on the single point in 3D.
Project3D_Ref public Applies a projection on the single point in 3D.
ProjectExtent public Applies a projection on the extent.
Project_Ref public Applies a projection on the single point.
RaiseBusyEvent public Fires Busy event of the layer.
RaiseBusyPrepare public Fires BusyPrepare method of the assigned viewer.
RaiseBusyRelease public Fires BusyRelease method of the assigned viewer.
RaiseBusyShake public Fires BusyShake method of the assigned viewer.
ReadConfig public Reads the layer configuration files.
ReadConfigParam public Reads the layer configuration parameters.
RecalcExtent public Recalculates extent based on real shapes.
RecalcProjectedExtent public Recalculates a projected extent.
ReOpen public Reopens the layer.
RereadConfig public Rereads the layer configuration files.
resetMustReproject protected Reset MustReporoject state.
RevertAll public Reverts layer to its original content.
RootLayer public Returns the absolute parent layer.
SaveAll public Saves layer and destroys mirrored items.
SaveData public Saves layer and destroys mirrored items.
SetCSByEPSG public Sets up Coordinate System to a coordinate system provided by a EPSG code.
SetCSByWKT public Sets up Coordinate System to a coordinate system provided by a WKT string (GEOGCS or PROJCS).
SetCSByWKTFile public Sets up Coordinate System to a coordinate system provided by a file which contains a WKT string (GEOGCS or PROJCS).
setUp protected Makes a general layer setup first step.
setUp2 protected Makes a general layer setup second step.
setUp3 protected Makes a general layer setup third step.
storeConfigOptions protected Store layer options in a configuration file.
transformExtent protected Custom transformation of the extent.
Unlock public Unlocks layer from burst-mode operation.
unlockThread protected Unlocks thread.
Unproject public Applies reverse projection (recovers from the projection) on the single point.
Unproject3D public Applies reverse projection (recovers from the projection) on the singlepoint in 3D.
Unproject3D_Ref public Applies reverse projection (recovers from the projection) on the single point in 3D.
UnprojectExtent public Applies reverse projection (recovers from the projection) on the extent.
Unproject_Ref public Applies reverse projection (recover from projection) on the single point.
WriteConfig public Writes layer configuration files.

Properties

Inherited Protected
Name Visibility Description
Active public Checks if the layer is active? Active means layer is visible and an object can be localized on the layer.
Addition public Additional value.
Age public Age of the layer (since its creation).
Basemap public True if the layer must be interpreted as basemap (for background painting).
CachedPaint public False if layer must be painted directly (bypassing cache).
Caption public Caption of layer; if not filed directly then will be filed with Name when adding to the Viewer.
CodePage public Code Page in which text has been stored.
Collapsed public Checks if the layer is collapsed? Collapsed means only the layer's title will be visible inside the legend.
Comments public Additional user comments.
ConfigFile public Configuration file handle.
ConfigName public Configuration file name.
CS public Coordinate System that is assigned to the layer.
CustomData public List of custom, user-defined data.
DirectMode public True if the layer is direct-mode (bypassing cache).
DormantMode public Dormant mode for the layer.
Driver public The layer's driver name.
Extent public Extent of the layer.
Extent3D public Three-dimensional extent of the layer.
FileCopyrights public Copyright information about the layer.
FileInfo public Additional textual information about the layer such as compression, number of pixels, copyright, etc.
HideFromLegend public False if the layer should not be visible in legend.
IsExportable public True if the layer is exportable.
IsLocked public True if the layer is in locked state.
IsOpened public True if the layer is opened and is ready for operations.
IsPersistent public True if the layer is persistent.
IsReadOnly public True if the layer is read-only.
IsTopmost public True if the layer can be interpreted as the topmost (trackable) layer.
MaxTileSize public Maximum allowed tile size for the layer.
MultiUserMode public Type of multiuser mode.
Name public Name of layer; if not filled directly, then will be filled with Path when added to the viewer.
Params public Parameters (colors, fills, etc.) object.
ParamsList public List of all parameter sections attached to the current layer.
ParentLayer public Parent layer of a sub layer.
Path public Path to file holding the layer's data.
PathWithDriver public Path to file with the layer's data extended with driver name.
ProjectedExtent public Extent of the layer in projected units.
Renderer public Handle to a renderer used for drawing shapes.
Statistics public Layer statistics engine
Stream public Reference to a potential layer underlying the stream.
SubLayers public List of sublayers belonging to the layer.
SubType public Type of sublayer.
Tag public Tag has no predefined meaning.
TagInternal public TagInternal has no predefined meaning.
TagPointer public TagPointer has no predefined meaning.
Transform public Custom transformation.
Transparency public Transparency value for the layer (0..100).
UnSupportedOperations public Set of operations not supported by the layer.
UseConfig public True if config file is active.
UserObject public UserObject can be used to associate with the layer a user-defined object.
Viewer public Reference to a viewer object.
ZOrder public Layer's position relative to other layers.
ZOrderEx public Layer position relative to other visible layers.

Events

Inherited Protected
Name Visibility Description
BusyEvent public
PaintLayerEvent public
PasswordEvent public
ReadEvent public
WriteEvent public

References

2020/07/24 01:10

Page Tools