|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.report.model.api.DesignElementHandle
org.eclipse.birt.report.model.api.ReportElementHandle
org.eclipse.birt.report.model.api.MasterPageHandle
public abstract class MasterPageHandle
Represents a master page. The master page is an abstract element that defines the basic properties of a printed page. The derived elements, Simple and Graphic Master Pages, provide content that appears on the page itself.
MasterPage
,
DimensionHandle
Field Summary |
---|
Fields inherited from class org.eclipse.birt.report.model.api.ReportElementHandle |
---|
element |
Fields inherited from class org.eclipse.birt.report.model.api.DesignElementHandle |
---|
module |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IMasterPageModel |
---|
A4_HEIGHT, A4_WIDTH, BOTTOM_MARGIN_PROP, HEIGHT_PROP, LEFT_MARGIN_PROP, ORIENTATION_PROP, RIGHT_MARGIN_PROP, STYLE_PROP, TOP_MARGIN_PROP, TYPE_PROP, US_LEGAL_HEIGHT, US_LEGAL_WIDTH, US_LETTER_HEIGHT, US_LETTER_WIDTH, WIDTH_PROP |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel |
---|
COMMENTS_PROP, CUSTOM_XML_PROP, DISPLAY_NAME_ID_PROP, DISPLAY_NAME_PROP, EVENT_HANDLER_CLASS_PROP, EXTENDS_PROP, FULL_LABEL, ID_SUFFIX, NAME_PROP, NO_SLOT, PROPERTY_MASKS_PROP, REF_TEMPLATE_PARAMETER_PROP, SHORT_LABEL, USER_LABEL, USER_PROPERTIES_PROP, VIEW_ACTION_PROP |
Constructor Summary | |
---|---|
MasterPageHandle(org.eclipse.birt.report.model.core.Module module,
org.eclipse.birt.report.model.core.DesignElement element)
Constructs a master-page handle with the given design and the element. |
Method Summary | |
---|---|
DimensionHandle |
getBottomMargin()
Gets a dimension handle to work with the margin on the bottom side. |
DimensionValue |
getEffectiveHeight()
Deprecated. |
DimensionValue |
getEffectiveWidth()
Deprecated. |
DimensionHandle |
getHeight()
Gets a dimension handle to work with the height of the page. |
DimensionHandle |
getLeftMargin()
Gets a dimension handle to work with the margin on the left side. |
java.lang.String |
getOrientation()
Returns the page orientation. |
DimensionValue |
getPageHeight()
Gets the effective page height. |
java.lang.String |
getPageType()
Returns the type of the page. |
DimensionValue |
getPageWidth()
Gets the effective page width. |
DimensionHandle |
getRightMargin()
Gets a dimension handle to work with the margin on the right side. |
Point |
getSize()
Returns the size of the page. |
DimensionHandle |
getTopMargin()
Gets a dimension handle to work with the margin on the top side. |
DimensionHandle |
getWidth()
Gets a dimension handle to work with the width of the page. |
void |
setOrientation(java.lang.String orientation)
Returns the page orientation. |
void |
setPageType(java.lang.String type)
Sets the type of the page. |
Methods inherited from class org.eclipse.birt.report.model.api.ReportElementHandle |
---|
getComments, getCustomXml, getDisplayName, getDisplayNameKey, getElement, getPropertyMask, isValidLayoutForCompoundElement, isValidReferenceForCompoundElement, propertyMaskIterator, setComments, setCustomXml, setDisplayName, setDisplayNameKey, setPropertyMask |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public MasterPageHandle(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)
module
- the moduleelement
- the model representation of the elementMethod Detail |
---|
public Point getSize()
getWidth
and getHeight
values
unless the page uses a custom size.
public DimensionValue getEffectiveWidth()
public DimensionValue getEffectiveHeight()
public java.lang.String getPageType()
DesignChoiceConstants
and can be one of:
PAGE_SIZE_CUSTOM
PAGE_SIZE_US_LETTER
PAGE_SIZE_US_LEGAL
PAGE_SIZE_A4
public void setPageType(java.lang.String type) throws SemanticException
DesignChoiceConstants
and can be one of:
PAGE_SIZE_CUSTOM
PAGE_SIZE_US_LETTER
PAGE_SIZE_US_LEGAL
PAGE_SIZE_A4
type
- the type of the page
SemanticException
- if the property is locked or the input value is not one of
the above.public java.lang.String getOrientation()
DesignChoiceConstants
can be one of:
PAGE_ORIENTATION_AUTO
PAGE_ORIENTATION_PORTRAIT
PAGE_ORIENTATION_LANDSCAPE
public void setOrientation(java.lang.String orientation) throws SemanticException
DesignChoiceConstants
can be one of:
PAGE_ORIENTATION_AUTO
PAGE_ORIENTATION_PORTRAIT
PAGE_ORIENTATION_LANDSCAPE
orientation
- the page orientation
SemanticException
- if the property is locked or the input value is not one of
the above.public DimensionHandle getHeight()
public DimensionHandle getWidth()
public DimensionHandle getBottomMargin()
public DimensionHandle getLeftMargin()
public DimensionHandle getRightMargin()
public DimensionHandle getTopMargin()
public DimensionValue getPageHeight()
public DimensionValue getPageWidth()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |