Package com.simplicite.util
Class PrintTemplate
- java.lang.Object
-
- com.simplicite.util.PrintTemplate
-
- All Implemented Interfaces:
java.io.Serializable
public class PrintTemplate extends java.lang.Object implements java.io.Serializable
Print template- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String[]
RESOURCES_TYPES
Resource types to be substitutedstatic java.lang.String
TYPE_DEFAULT
Default type HTMLstatic java.lang.String
TYPE_FILE
Filestatic java.lang.String
TYPE_METH
Methodstatic java.lang.String
TYPE_TMPL
Templatestatic char
USAGE_EXPORT
Usage exportstatic char
USAGE_LIST
Usage on liststatic char
USAGE_MAILING
Usage mailingstatic char
USAGE_OBJECT
Usage on objectstatic char
USAGE_OTHER
Usage other
-
Constructor Summary
Constructors Constructor Description PrintTemplate(ObjectDB object, java.lang.String name, java.lang.String display, java.lang.String type, java.lang.String usage, java.lang.String method, java.lang.String template, java.lang.String docId, java.lang.String mimeType, java.lang.String fileName, boolean grantable, char visible)
Constructor
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addGrantedGroup(java.lang.String group)
Add granted groupstatic java.lang.String
fillTemplate(ObjectDB obj, java.lang.String template, java.lang.String encoding, java.lang.String[] row)
Fill the templatestatic java.lang.String
fillTemplate(ObjectDB obj, java.lang.String template, java.lang.String encoding, java.util.List<java.lang.String[]> rows)
Fill the templatejava.lang.Object
fillWithCurrentList(ObjectDB obj)
Fill the template with the current object listjava.lang.Object
fillWithCurrentObject(ObjectDB obj)
Fill the template with the current object itemstatic java.lang.String
generateDefaultSubTemplate(ObjectDB obj)
Generate default sub templatestatic java.lang.String
generateDefaultTemplate(ObjectDB obj)
Generate default templatejava.util.List<java.lang.String[]>
getCurrentList(ObjectDB obj)
Get current listjava.lang.String
getDisplay()
Get display lablejava.lang.String
getDocId()
Get document IDDocumentDB
getDocument(Grant g)
Get documentjava.lang.String
getFilename()
Get file namejava.util.List<java.lang.String>
getGrantedGroups()
Get granted groupsjava.lang.String
getLabel()
Get display label (same as getDisplay)java.lang.String
getMethod()
java.lang.String
getMimeType()
Deprecated.Use getMIMETypejava.lang.String
getMIMEType()
Get MIME typejava.lang.String
getName()
Get nameObjectDB
getObject()
Get objectstatic java.lang.String
getPrintTemplateId(java.lang.String name, java.lang.String lang)
Get publication template IDjava.lang.String
getTemplate()
Get templatejava.lang.String
getTemplate(Grant g)
Deprecated.Use getTemplate()java.lang.String
getType()
Get typejava.lang.String
getUsage()
Get usagechar
getVisibility()
Get action visibilityboolean
isEnabled()
Is enabled?boolean
isForExportUsage()
Is for export usageboolean
isForListUsage()
Is for object list usageboolean
isForMailingUsage()
Is for mailing usageboolean
isForObjectUsage()
Is for object form usageboolean
isForOtherUsage()
Is for other usageboolean
isForUsage(char usage)
Is for specified usageboolean
isGrantable()
Is grantable?boolean
isGranted(Grant g)
Is granted?boolean
isVisible()
Is visible?void
removeGrantedGroup(java.lang.String group)
Remove granted groupvoid
setDocId(java.lang.String docId)
Set document IDvoid
setEnabled(boolean enabled)
Set nabledvoid
setFilename(java.lang.String filename)
Set file namevoid
setGrantable(boolean b)
Set grantablevoid
setMimeType(java.lang.String mimeType)
Deprecated.Use setMIMETypevoid
setMIMEType(java.lang.String mimeType)
Set IME typevoid
setTemplate(java.lang.String template)
Set templatevoid
setVisible(boolean b)
Set visiblevoid
setVisible(char vis)
Set action visibilitystatic java.lang.String
subsituteExprs(java.lang.String template, java.lang.String encoding, ObjectDB obj, java.lang.String rowId)
Substitute expressions in templatestatic java.lang.String
substituteDirectURL(java.lang.String text, ObjectDB obj)
Substitutes the direct URL statements with the direct URL to open the object update formstatic java.lang.String
substituteFields(java.lang.String template, java.lang.String encoding, ObjectDB obj, java.lang.String[] row)
Substitute field values in template (print or alert with fields of object and action)static java.lang.String
substituteFilters(java.lang.String template, java.lang.String encoding, ObjectDB obj)
Substitute filters in templatestatic java.lang.String
substituteLabels(java.lang.String template, java.lang.String encoding, ObjectDB obj)
Substitute labels in templatestatic java.lang.String
substituteResources(java.lang.String template, ObjectDB obj)
Substitute resources contentsstatic java.lang.String
substituteTexts(java.lang.String template, java.lang.String encoding, Grant g)
Substitute texts in templatestatic java.lang.String
substituteURL(java.lang.String text, Grant g)
Substitutes the URL statements with the instance context URL for specified grant
-
-
-
Field Detail
-
TYPE_DEFAULT
public static final java.lang.String TYPE_DEFAULT
Default type HTML- See Also:
- Constant Field Values
-
TYPE_FILE
public static final java.lang.String TYPE_FILE
File- See Also:
- Constant Field Values
-
TYPE_METH
public static final java.lang.String TYPE_METH
Method- See Also:
- Constant Field Values
-
TYPE_TMPL
public static final java.lang.String TYPE_TMPL
Template- See Also:
- Constant Field Values
-
USAGE_OBJECT
public static final char USAGE_OBJECT
Usage on object- See Also:
- Constant Field Values
-
USAGE_LIST
public static final char USAGE_LIST
Usage on list- See Also:
- Constant Field Values
-
USAGE_MAILING
public static final char USAGE_MAILING
Usage mailing- See Also:
- Constant Field Values
-
USAGE_EXPORT
public static final char USAGE_EXPORT
Usage export- See Also:
- Constant Field Values
-
USAGE_OTHER
public static final char USAGE_OTHER
Usage other- See Also:
- Constant Field Values
-
RESOURCES_TYPES
public static final java.lang.String[] RESOURCES_TYPES
Resource types to be substituted
-
-
Constructor Detail
-
PrintTemplate
public PrintTemplate(ObjectDB object, java.lang.String name, java.lang.String display, java.lang.String type, java.lang.String usage, java.lang.String method, java.lang.String template, java.lang.String docId, java.lang.String mimeType, java.lang.String fileName, boolean grantable, char visible)
Constructor- Parameters:
object
- Object namename
- Template namedisplay
- Displayusage
- Usagemethod
- Methodtemplate
- Template contentdocId
- Template document IDmimeType
- Output MIME typefileName
- Output file namegrantable
- Public or restricted to groupsvisible
- Action visibility
-
-
Method Detail
-
getObject
public ObjectDB getObject()
Get object- Returns:
- Object
-
getName
public java.lang.String getName()
Get name- Returns:
- Name
-
getDisplay
public java.lang.String getDisplay()
Get display lable- Returns:
- Display label
-
getLabel
public java.lang.String getLabel()
Get display label (same as getDisplay)- Returns:
- Display label
-
getType
public java.lang.String getType()
Get type- Returns:
- Type (one of PrintTemplate.TYPE_*)
-
getUsage
public java.lang.String getUsage()
Get usage- Returns:
- Usage (one of PrintTemplate.USAGE_*)
-
getMethod
public java.lang.String getMethod()
-
getPrintTemplateId
public static java.lang.String getPrintTemplateId(java.lang.String name, java.lang.String lang)
Get publication template ID- Parameters:
name
- Namelang
- Language- Returns:
- ID
-
isGrantable
public boolean isGrantable()
Is grantable?- Returns:
- True if grantable
-
setGrantable
public void setGrantable(boolean b)
Set grantable- Parameters:
b
- Grantable?
-
getGrantedGroups
public java.util.List<java.lang.String> getGrantedGroups()
Get granted groups- Returns:
- List of granted group names
-
addGrantedGroup
public void addGrantedGroup(java.lang.String group)
Add granted group- Parameters:
group
- Group name
-
removeGrantedGroup
public void removeGrantedGroup(java.lang.String group)
Remove granted group- Parameters:
group
- Group name
-
isGranted
public boolean isGranted(Grant g)
Is granted?- Parameters:
g
- Grant- Returns:
- True if granted
-
isForUsage
public boolean isForUsage(char usage)
Is for specified usage- Parameters:
usage
- Usage (one of PrintTemplate.USAGE_*)- Returns:
- True if for specified usage
-
isForObjectUsage
public boolean isForObjectUsage()
Is for object form usage- Returns:
- True if for object form usage
-
isForListUsage
public boolean isForListUsage()
Is for object list usage- Returns:
- True if for object list usage
-
isForMailingUsage
public boolean isForMailingUsage()
Is for mailing usage- Returns:
- True if for mailing usage
-
isForExportUsage
public boolean isForExportUsage()
Is for export usage- Returns:
- True if for export usage
-
isForOtherUsage
public boolean isForOtherUsage()
Is for other usage- Returns:
- True if for other usage
-
isEnabled
public boolean isEnabled()
Is enabled?- Returns:
- True if enabled
-
setEnabled
public void setEnabled(boolean enabled)
Set nabled- Parameters:
enabled
- Enabled?
-
isVisible
public boolean isVisible()
Is visible?- Returns:
- True if visible
-
getVisibility
public char getVisibility()
Get action visibility- Returns:
- Visibility (one of Action.ACTION_*
-
setVisible
public void setVisible(boolean b)
Set visible- Parameters:
b
- Visible (Action.ACTION_ALL) or non visible (Action.ACTION_HIDDEN)?
-
setVisible
public void setVisible(char vis)
Set action visibility- Parameters:
vis
- Visibility (one of Action.ACTION_*)
-
getDocId
public java.lang.String getDocId()
Get document ID- Returns:
- Document ID
-
getDocument
public DocumentDB getDocument(Grant g)
Get document- Parameters:
g
- Grant- Returns:
- Document
-
setDocId
public void setDocId(java.lang.String docId)
Set document ID- Parameters:
docId
- Document ID
-
getTemplate
@Deprecated public java.lang.String getTemplate(Grant g)
Deprecated.Use getTemplate()
-
getTemplate
public java.lang.String getTemplate()
Get template- Returns:
- Template
-
setTemplate
public void setTemplate(java.lang.String template)
Set template- Parameters:
template
- Template
-
getMimeType
@Deprecated public java.lang.String getMimeType()
Deprecated.Use getMIMEType
-
getMIMEType
public java.lang.String getMIMEType()
Get MIME type- Returns:
- MIME type
-
setMimeType
@Deprecated public void setMimeType(java.lang.String mimeType)
Deprecated.Use setMIMEType
-
setMIMEType
public void setMIMEType(java.lang.String mimeType)
Set IME type- Parameters:
mimeType
- MIME type
-
getFilename
public java.lang.String getFilename()
Get file name- Returns:
- File name
-
setFilename
public void setFilename(java.lang.String filename)
Set file name- Parameters:
filename
- File name
-
generateDefaultSubTemplate
public static java.lang.String generateDefaultSubTemplate(ObjectDB obj)
Generate default sub template- Parameters:
obj
- Object- Returns:
- Generated sub template
-
generateDefaultTemplate
public static java.lang.String generateDefaultTemplate(ObjectDB obj)
Generate default template- Parameters:
obj
- Object- Returns:
- Generated default template
-
substituteResources
public static java.lang.String substituteResources(java.lang.String template, ObjectDB obj)
Substitute resources contents- Parameters:
template
- Templateobj
- Object- Returns:
- Substituted resources contents
-
substituteTexts
public static java.lang.String substituteTexts(java.lang.String template, java.lang.String encoding, Grant g)
Substitute texts in template- Parameters:
template
- Templateencoding
- Encodingg
- Grant- Returns:
- Substituted template
-
substituteLabels
public static java.lang.String substituteLabels(java.lang.String template, java.lang.String encoding, ObjectDB obj)
Substitute labels in template- Parameters:
template
- Templateencoding
- Encodingobj
- Object- Returns:
- Substituted template
-
substituteFilters
public static java.lang.String substituteFilters(java.lang.String template, java.lang.String encoding, ObjectDB obj)
Substitute filters in template- Parameters:
template
- Templateencoding
- Encodingobj
- Object- Returns:
- Substituted template
-
subsituteExprs
public static java.lang.String subsituteExprs(java.lang.String template, java.lang.String encoding, ObjectDB obj, java.lang.String rowId)
Substitute expressions in template- Parameters:
template
- Templateencoding
- EncodingrowId
- Row ID- Returns:
- Substituted template
-
substituteFields
public static java.lang.String substituteFields(java.lang.String template, java.lang.String encoding, ObjectDB obj, java.lang.String[] row)
Substitute field values in template (print or alert with fields of object and action)- Parameters:
template
- Templateencoding
- Encodingrow
- Row- Returns:
- Substituted template
-
substituteURL
public static java.lang.String substituteURL(java.lang.String text, Grant g)
Substitutes the URL statements with the instance context URL for specified grant- Parameters:
text
- A textg
- Grant- Returns:
- Substituted text
-
substituteDirectURL
public static java.lang.String substituteDirectURL(java.lang.String text, ObjectDB obj)
Substitutes the direct URL statements with the direct URL to open the object update form- Parameters:
text
- A textobj
- Object- Returns:
- Substituted text
-
fillTemplate
public static java.lang.String fillTemplate(ObjectDB obj, java.lang.String template, java.lang.String encoding, java.util.List<java.lang.String[]> rows)
Fill the template- Parameters:
obj
- Objecttemplate
- Templateencoding
- Encodingrows
- Rows- Returns:
- Publication result
-
fillTemplate
public static java.lang.String fillTemplate(ObjectDB obj, java.lang.String template, java.lang.String encoding, java.lang.String[] row)
Fill the template- Parameters:
obj
- Objecttemplate
- Templateencoding
- Encodingrow
- Row- Returns:
- Publication result
-
fillWithCurrentObject
public java.lang.Object fillWithCurrentObject(ObjectDB obj) throws GrantException, PrintException
Fill the template with the current object item- Parameters:
obj
- Object- Returns:
- Publication result
- Throws:
GrantException
PrintException
-
getCurrentList
public java.util.List<java.lang.String[]> getCurrentList(ObjectDB obj)
Get current list- Parameters:
obj
- Object- Returns:
- Current list rows
-
fillWithCurrentList
public java.lang.Object fillWithCurrentList(ObjectDB obj) throws GrantException, PrintException
Fill the template with the current object list- Parameters:
obj
- Object- Returns:
- Publication result
- Throws:
GrantException
PrintException
-
-