dotnet-framework-api
- C1.WPF.PdfViewer.4.6.2 Assembly

CSJ2K.j2k.ModuleSpec

ModuleSpec Class

This generic class is used to handle values to be used by a module for each tile and component. It uses attribute to determine which value to use. It should be extended by each module needing this feature.

       This class might be used for values that are only tile specific or
       component specific but not both.

       <p>The attributes to use are defined by a hierarchy. The hierarchy is:

       <ul><li> Tile and component specific attribute</li><li> Tile specific default attribute</li><li> Component main default attribute</li><li> Main default attribute</li></ul></p>

Inheritance

ModuleSpec

Namespace: CSJ2K.j2k

Assembly: C1.WPF.PdfViewer.4.6.2.dll

Syntax

public class ModuleSpec

Constructors

Name	Description
ModuleSpec(int, int, byte)	Constructs a 'ModuleSpec' object, initializing all the components and tiles to the 'SPEC_DEF' spec val type, for the specified number of components and tiles.

Fields

Name	Description
SPEC_COMP_DEF	The identifier for "component default" specification
SPEC_DEF	The identifier for default specification
SPEC_TILE_COMP	The identifier for a "tile-component" specification
SPEC_TILE_DEF	The identifier for "tile default" specification
SPEC_TYPE_COMP	The identifier for a specification module that applies only to components
SPEC_TYPE_TILE	The identifier for a specification module that applies only to tiles
SPEC_TYPE_TILE_COMP	The identifier for a specification module that applies both to tiles and components
compDef	The default value for each component. Null if no component specific value is defined
def	Default value for each tile-component
nComp	The number of components
nTiles	The number of tiles
specType	The type of the specification module
specValType	The spec type for each tile-component. The first index is the tile index, the second is the component index.
tileCompVal	The specific value for each tile-component. Value of tile 16 component 3 is accessible through the hash value "t16c3". Null if no tile-component specific value is defined
tileDef	The default value for each tile. Null if no tile specific value is defined

Properties

Name	Description
Copy

Methods

Name	Description
Clone()
getCompDef(int)	Gets default value of the specified component. If no specification have been entered for this component, returns default value.
getDefault()	Gets default value for this module.
getSpec(int, int)	Gets value of specified tile-component without knowing if a specific tile-component value has been previously entered. It first check if a tile-component specific value has been entered, then if a tile specific value exist, then if a component specific value exist. If not the default value is returned.
getSpecValType(int, int)	Return the spec type of the given tile-component.
getTileCompVal(int, int)	Gets value of specified tile-component. This method calls getSpec but has a public access.
getTileDef(int)	Gets default value of the specified tile. If no specification has been entered, it returns the default value.
isCompSpecified(int)	Whether or not specifications have been entered for the given component.
isTileCompSpecified(int, int)	Whether or not a tile-component specification has been defined
isTileSpecified(int)	Whether or not specifications have been entered for the given tile.
parseIdx(string, int)
rotate90(Coord)	Rotate the ModuleSpec instance by 90 degrees (this modifies only tile and tile-component specifications).
setCompDef(int, object)	Sets default value for specified component and specValType tag if allowed by its priority.
setDefault(object)	Sets default value for this module
setTileCompVal(int, int, object)	Sets value for specified tile-component.
setTileDef(int, object)	Sets default value for specified tile and specValType tag if allowed by its priority.