public class TemplateBean extends java.lang.Object implements java.lang.Comparable<TemplateBean>, java.lang.Cloneable
Constructor and Description |
---|
TemplateBean() |
Modifier and Type | Method and Description |
---|---|
PerspectiveBean |
addPerspective(PerspectiveBean bean)
Set the visibility for this perspective in this template.If the report previously contained an user defined
for this bean, the old value is replaced.
|
void |
addReportBean(ReportBean reportBean)
Add new report descriptor into this template.
|
boolean |
checkVisible(java.lang.String perspective)
Return true if this template is visibled on given perspective.
|
java.lang.Object |
clone()
Creates and returns a copy of this object.
|
int |
compareTo(TemplateBean that)
Compares this object with the specified object for order.
|
boolean |
equals(java.lang.Object o) |
java.lang.String |
getCategory()
Return category name.
|
java.io.File |
getConfigFile()
Return a config file.
|
ReportBean |
getDefaultReport()
Return a default report.
|
java.lang.String |
getDescription()
Return description.
|
EditionBean |
getEdition()
Return an edition.
|
boolean |
getEnabled()
Return enabled status.
|
com.nomagic.ui.ResizableIcon |
getIcon()
Return a icon.
|
java.lang.String |
getIconFileName()
Return icon.
|
java.lang.String |
getName()
Return name.
|
java.lang.String |
getPath()
Return template directory or template file name.
|
java.util.List<PerspectiveBean> |
getPerspectiveList()
Return a perspective List.
|
boolean |
getPinned()
Return a pinned status.
|
boolean |
getReadOnly()
Return read only status.
|
java.util.List<ReportBean> |
getReportList()
Return List of ReportBean.
|
java.util.Map<java.lang.String,com.nomagic.magicdraw.plugins.RequiredPlugin> |
getRequiredPlugins() |
ReportBean |
getSelectedReport()
Return a selected report.
|
java.lang.String |
getTemplateFileName()
Return the template document file name.
|
java.util.List<UserDefinedBean> |
getUserDefinedList()
Return a user defined List.
|
java.lang.String |
getVisibility(java.lang.String perspective)
Returns the visibility value corresponding to this perspective.
|
int |
hashCode() |
void |
setCategory(java.lang.String category)
Set category name.
|
void |
setConfigFile(java.io.File configFile)
Set a config file.
|
void |
setDefaultReport(ReportBean defaultReport)
Set a default report.
|
void |
setDescription(java.lang.String description)
Set description.
|
void |
setEdition(EditionBean edition)
Set an edition.
|
void |
setEnabled(boolean enabled)
Set enable status.
|
void |
setIcon(com.nomagic.ui.ResizableIcon icon)
Set a icon.
|
void |
setIconFileName(java.lang.String iconFileName)
Set icon file name.
|
void |
setName(java.lang.String name)
Set name.
|
void |
setPath(java.lang.String path)
Set template path.
|
void |
setPerspectiveList(java.util.List<PerspectiveBean> perspectiveList)
Set a perspective List.
|
void |
setPinned(boolean pinned)
Set a pinned status.
|
void |
setReadOnly(boolean readOnly)
Set read only status.
|
void |
setReportList(java.util.List<ReportBean> reportList)
Set List of ReportBean.
|
void |
setRequiredPlugins(java.util.Map<java.lang.String,com.nomagic.magicdraw.plugins.RequiredPlugin> requiredPlugins) |
void |
setSelectedReport(ReportBean selectedReport)
Set a selected report.
|
void |
setTemplateFileName(java.lang.String templateFileName)
Set word document file name.
|
void |
setUserDefinedList(java.util.List<UserDefinedBean> userDefinedList)
Set a user defined List.
|
PerspectiveBean |
setVisibility(java.lang.String perspective,
java.lang.String visibility)
Set the visibility for this perspective in this template.
|
java.lang.String |
toString()
Return name of this descriptor.
|
public com.nomagic.ui.ResizableIcon getIcon()
public void setIcon(com.nomagic.ui.ResizableIcon icon)
icon
- the icon to setpublic boolean getPinned()
public void setPinned(boolean pinned)
pinned
- the pin status to setpublic void setEnabled(boolean enabled)
enabled
- the status to setpublic boolean getEnabled()
public void setIconFileName(java.lang.String iconFileName)
iconFileName
- the icon to setpublic java.lang.String getIconFileName()
public void setReadOnly(boolean readOnly)
readOnly
- the read only to setpublic boolean getReadOnly()
public void setCategory(java.lang.String category)
category
- the category to setpublic java.lang.String getCategory()
public void addReportBean(ReportBean reportBean)
reportBean
- a report descriptorpublic java.lang.String getDescription()
public void setDescription(java.lang.String description)
description
- the description to setpublic java.lang.String getName()
public void setName(java.lang.String name)
name
- the name to setpublic java.util.List<ReportBean> getReportList()
public void setReportList(java.util.List<ReportBean> reportList)
reportList
- the reportList to setpublic java.lang.String getPath()
public void setPath(java.lang.String path)
path
- the path to template directory or file namepublic java.lang.String getTemplateFileName()
public void setTemplateFileName(java.lang.String templateFileName)
templateFileName
- word document file namepublic java.util.List<UserDefinedBean> getUserDefinedList()
public void setUserDefinedList(java.util.List<UserDefinedBean> userDefinedList)
userDefinedList
- the user defined List to setpublic java.util.List<PerspectiveBean> getPerspectiveList()
public void setPerspectiveList(java.util.List<PerspectiveBean> perspectiveList)
perspectiveList
- the perspective List to setpublic EditionBean getEdition()
public void setEdition(EditionBean edition)
edition
- the edition to set@CheckForNull public java.lang.String getVisibility(java.lang.String perspective)
perspective
- perspective namepublic boolean checkVisible(java.lang.String perspective)
perspective
- perspective name@CheckForNull public PerspectiveBean setVisibility(java.lang.String perspective, java.lang.String visibility)
perspective
- perspective namevisibility
- perspective visibility@CheckForNull public PerspectiveBean addPerspective(PerspectiveBean bean)
bean
- user defined beanpublic ReportBean getDefaultReport()
public void setDefaultReport(ReportBean defaultReport)
defaultReport
- the default report to setpublic ReportBean getSelectedReport()
public void setSelectedReport(ReportBean selectedReport)
selectedReport
- the selected report to setpublic java.io.File getConfigFile()
public void setConfigFile(java.io.File configFile)
configFile
- the config file to setpublic void setRequiredPlugins(java.util.Map<java.lang.String,com.nomagic.magicdraw.plugins.RequiredPlugin> requiredPlugins)
public java.util.Map<java.lang.String,com.nomagic.magicdraw.plugins.RequiredPlugin> getRequiredPlugins()
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in class java.lang.Object
java.lang.CloneNotSupportedException
- if the object's class does not support the Cloneable
interface. Subclasses that override the clone
method can also throw this
exception to indicate that an instance cannot be cloned.Cloneable
public int compareTo(TemplateBean that)
compareTo
in interface java.lang.Comparable<TemplateBean>
that
- the Object to be compared.public boolean equals(@CheckForNull java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object