Public Member Functions | |
_.Library.Status | OnConfigureMappings (pParams) |
Subclasses may override to customize mapping behavior at the beginning of the Reload phase. | |
_.Library.Status | OnPhase (_.Library.String pPhase, pParams, _.Library.Boolean pResourceHandled) |
Called as phase pPhase is executed for the resource. More... | |
![]() | |
OnGetUniqueName (pUniqueName) | |
Returns a unique name for this resource. More... | |
_.Library.String | OnItemRelativePath (_.Library.String pItemName) |
Returns the path relative to the module root for item pItemName within this resource. | |
_.Library.Status | OnLoad (_.Library.String pFullResourcePath, _.Library.Boolean pVerbose, _.Library.Boolean pCompile, _.Library.String pLoadedList, _.Library.String pParams) |
Subclasses may override to customize resource load behavior during the Reload phase. More... | |
_.Library.Status | OnResolveChildren (pResourceArray) |
Enumerate all documents contained in the resource being processed. More... | |
![]() | |
OnGetStudioProject (_.Studio.Project pProject, _.Library.Boolean pHandled) | |
Subclasses may override to customize the studio project. More... | |
![]() | |
_.Library.Status | OnValidateObject () |
This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More... | |
_.Library.String | GetDomainsForResource () |
Returns a comma-separated list of domains for the specified resource. | |
Public Attributes | |
Directory | |
Directory relative to module root containing the exported resource. More... | |
Format | |
Export format - list of acceptable values may differ by subclass. More... | |
![]() | |
Compile | |
If true, the resource will be compiled during the compilation phase in the module lifecycle. More... | |
Directory | |
Directory relative to module root containing the exported resource. More... | |
DirectoryDefined | |
More... | |
FilenameExtension | |
Extension for individual filename(s) that comprise this resource. More... | |
FilenameTranslateAssociator | |
Characters in the filename to use as the associator in $translate when determining the resource's filename on disk. More... | |
FilenameTranslateIdentifier | |
Characters in the filename to use as the identifier in $translate when determining the resource's filename on disk. More... | |
Format | |
Export format - list of acceptable values may differ by subclass. More... | |
LoadAsDirectory | |
If true (default is false), the resource is loaded as a directory. More... | |
![]() | |
CompileAfter | |
Comma-separated list of resource names after which this resource should be compiled. More... | |
ExportFlags | |
Flags/qualifiers to export items with. More... | |
Flags | |
Flags/qualifiers to compile with (overriding any more general defaults); "verbose" added per lifecycle command. More... | |
![]() | |
Params | |
More... | |
![]() | |
Domains | |
Comma-separated list of domains to export to the specified file. More... | |
Filename | |
Filename to export to. More... | |
Static Public Attributes | |
DESCRIPTION = None | |
Description of resource processor class (shown in UI) | |
EXTENSION = None | |
May be set to determine the value of <property>Extension</property> based on a static value rather than based on the resource name. More... | |
![]() | |
ATTRIBUTES = None | |
Comma-separated list of resource attribute names that this processor uses. | |
DESCRIPTION = None | |
Description of resource processor class (shown in UI) | |
EXTENSION = None | |
May be set to determine the value of <property>Extension</property> based on a static value rather than based on the resource name. More... | |
NAMEPOSTFIX = None | |
When a module is loaded in developer mode, this is appended to the resource name in ^Sources - e.g., ^Sources(..Extension, <resource name>_..NAMEPOSTFIX) More... | |
![]() | |
ATTRIBUTES = None | |
Comma-separated list of resource attribute names that this processor uses. | |
DESCRIPTION = None | |
Description of resource processor class (shown in UI) | |
![]() | |
ATTRIBUTES = None | |
Comma-separated list of resource attribute names that this processor uses. | |
DESCRIPTION = None | |
Description of resource processor class (shown in UI) | |
![]() | |
ATTRIBUTES = None | |
Comma-separated list of resource attribute names that this processor uses. | |
DESCRIPTION = None | |
Description of resource processor class (shown in UI) | |
Additional Inherited Members | |
![]() | |
_.Library.Boolean | ResourceIsMappedToDefaultDB (_.Library.String pResourceName) |
Helper method to be used in derived classes' OnConfigureMappings() to skip creating unnecessary mappings. More... | |
![]() | |
_.Library.Status | GetMessageFile (_.Library.String pDocName, _.IPM.ResourceProcessor.LocalizationExport.MsgFile pFileObject) |
pDocName is the full document name (including the .LOC extension) More... | |
_.Library.Status | SaveMessageFile (_.Library.String pDocName, _.IPM.ResourceProcessor.LocalizationExport.MsgFile pFileObject, _.Library.Boolean pCompile, pConsoleOutput) |
pDocName is the full document name (including the .LOC extension) More... | |
_.Library.Status OnPhase | ( | _.Library.String | pPhase, |
pParams, | |||
_.Library.Boolean | pResourceHandled | ||
) |
Called as phase pPhase is executed for the resource.
If pResourceHandled is set to true,
then the default behavior for that resource will be bypassed in the current phase. Currently, this is only used in the Verify phase, because of different handling of intermediate error statuses. TODO: Implement for standard database resources (.INC, .CLS, etc.)
Reimplemented from Document.
|
static |
May be set to determine the value of <property>Extension</property> based on a static value rather than based on the resource name.
The only expected use case at this point is class packages (.PKG, but Extension will be .CLS)
Directory |
Directory relative to module root containing the exported resource.
Defaults to the resource's extension (lower-case) if unspecified.
Format |
Export format - list of acceptable values may differ by subclass.