nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

Where do I get complete property listings for a given element?

newbie321

Hi, guys:
 
Very silly question:
 
Where do I get complete property listings for a given element?
 
For example, for the scripted data source we can use
<pre class="_prettyXprint">
.getPropertyHandle(ScriptDataSetHandle.RESULT_SET_PROP); </pre>
or on a table handle we can do 
<pre class="_prettyXprint">
.setProperty(IReportItemModel.DATA_SET_PROP, "theName");</pre>
Where do I get a complete listing of what can go inside the parenthesis as an argument for the property-related methods? I am pretty sure there has to be some listing in Birt's API for all of this. I just can not seem to find it. 
 
Any pointers? 
 
Thanks,

Find more posts tagged with

Comments

Matthew L.

While I'm not sure where a list of all the properties are located, typically when I want to figure out what some properties are for an element, I use the GUI to bring in the element, populate it with several settings in the GUI, then look at the report's XML to determine the property name.
For example, below is a label that I applied some settings to in the GUI, now using the XML Source view, I can see the property names for each property I want to set using the API:
<pre class="_prettyXprint _lang-xml">
<label name="TheName" id="10">
<property name="comments">Comments</property>
<property name="borderBottomColor">#000000</property>
<property name="borderBottomStyle">solid</property>
<property name="borderLeftColor">#000000</property>
<property name="borderLeftStyle">solid</property>
<property name="borderRightColor">#000000</property>
<property name="borderRightStyle">solid</property>
<property name="borderTopColor">#000000</property>
<property name="borderTopStyle">solid</property>
<property name="marginTop">1pt</property>
<property name="marginLeft">1pt</property>
<property name="marginBottom">1pt</property>
<property name="marginRight">1pt</property>
<property name="paddingTop">2pt</property>
<property name="paddingLeft">2pt</property>
<property name="paddingBottom">2pt</property>
<property name="paddingRight">2pt</property>
<expression name="bookmark" type="javascript">"Bookmark"</expression>
<structure name="toc"/>
</label>
</pre>

newbie321

Thanks, Matthew! 
This is indeed a great pointer!! it will help me to get the names of the element properties. 
 
I guess my question is:
 
Given TableHandle element and its method: 
.setProperty(IReportItemModel.DATA_SET_PROP, "theName");
 
How do I know that IReportItemModel.DATA_SET_PROP constant corresponds to a legit real property associated with the TableHandle element? 
 
This is from 
Class DesignElementHandle 
void <a data-ipb='nomediaparse' href='http://help.eclipse.org/mars/topic/org.eclipse.birt.doc.isv/model/api/org/eclipse/birt/report/model/api/DesignElementHandle.html#setProperty(java.lang.String, java.lang.Object)'>setProperty</a>(java.lang.String propName, java.lang.Object value)
<div style="margin:3px 0px 0px;">Sets the value of a property from a generic object.</div>
<div style="margin:3px 0px 0px;"> </div>
The signature of the .setProperty() method is .setProperty(String, Object). Does this mean I can set in theory the Property of an element to anything, for example TableHandle.setProperty("myBurgerMeat", "beef")? so anything goes? OR there is a certain set of properties that can only be used within a context of any given object? Where is that set listing? What is the mapping between the constants (IReportItemModel.DATA_SET_PROP) and the actual string representation of that constant? 
<div> </div>
<div>Thanks!! </div>