|
||||||||||
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.StyleHandle
org.eclipse.birt.report.model.api.PrivateStyleHandle
public class PrivateStyleHandle
Represents the "private style" for an element. The private style is the set of style properties set on the element itself, instead of inherited from a shared style.
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.IStyleModel |
---|
BACKGROUND_ATTACHMENT_PROP, BACKGROUND_COLOR_PROP, BACKGROUND_IMAGE_PROP, BACKGROUND_POSITION_X_PROP, BACKGROUND_POSITION_Y_PROP, BACKGROUND_REPEAT_PROP, BORDER_BOTTOM_COLOR_PROP, BORDER_BOTTOM_STYLE_PROP, BORDER_BOTTOM_WIDTH_PROP, BORDER_LEFT_COLOR_PROP, BORDER_LEFT_STYLE_PROP, BORDER_LEFT_WIDTH_PROP, BORDER_RIGHT_COLOR_PROP, BORDER_RIGHT_STYLE_PROP, BORDER_RIGHT_WIDTH_PROP, BORDER_TOP_COLOR_PROP, BORDER_TOP_STYLE_PROP, BORDER_TOP_WIDTH_PROP, CAN_SHRINK_PROP, COLOR_PROP, DATE_FORMAT_PROP, DATE_TIME_FORMAT_PROP, DISPLAY_PROP, FONT_FAMILY_PROP, FONT_SIZE_PROP, FONT_STYLE_PROP, FONT_VARIANT_PROP, FONT_WEIGHT_PROP, HIGHLIGHT_RULES_PROP, LETTER_SPACING_PROP, LINE_HEIGHT_PROP, MAP_RULES_PROP, MARGIN_BOTTOM_PROP, MARGIN_LEFT_PROP, MARGIN_RIGHT_PROP, MARGIN_TOP_PROP, MASTER_PAGE_PROP, NUMBER_ALIGN_PROP, NUMBER_FORMAT_PROP, ORPHANS_PROP, PADDING_BOTTOM_PROP, PADDING_LEFT_PROP, PADDING_RIGHT_PROP, PADDING_TOP_PROP, PAGE_BREAK_AFTER_PROP, PAGE_BREAK_BEFORE_PROP, PAGE_BREAK_INSIDE_PROP, SHOW_IF_BLANK_PROP, STRING_FORMAT_PROP, TEXT_ALIGN_PROP, TEXT_DIRECTION_PROP, TEXT_INDENT_PROP, TEXT_LINE_THROUGH_PROP, TEXT_OVERLINE_PROP, TEXT_TRANSFORM_PROP, TEXT_UNDERLINE_PROP, TIME_FORMAT_PROP, VERTICAL_ALIGN_PROP, WHITE_SPACE_PROP, WIDOWS_PROP, WORD_SPACING_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 | |
---|---|
PrivateStyleHandle(org.eclipse.birt.report.model.core.Module module,
org.eclipse.birt.report.model.core.DesignElement element)
Constructs the handle for a private style with the given design and element. |
Method Summary | |
---|---|
void |
addUserPropertyDefn(UserPropertyDefn prop)
This method is not defined for private styles. |
void |
drop()
This method is not defined for private styles. |
void |
dropAndClear()
This method is not defined for private styles. |
void |
dropUserPropertyDefn(java.lang.String propName)
This method is not defined for private styles. |
int |
findContentSlot(DesignElementHandle content)
This method is not defined for private styles. |
DesignElementHandle |
getElementHandle()
Returns a handle to the element that owns this private style. |
DesignElementHandle |
getExtends()
This method is not defined for private styles. |
void |
moveTo(DesignElementHandle newContainer,
int toSlot)
This method is not defined for private styles. |
void |
setExtends(DesignElementHandle parent)
This method is not defined for private styles. |
void |
setExtendsElement(org.eclipse.birt.report.model.core.DesignElement parent)
This method is not defined for private styles. |
void |
setExtendsName(java.lang.String name)
This method is not defined for private styles. |
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 PrivateStyleHandle(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 DesignElementHandle getElementHandle()
public void addUserPropertyDefn(UserPropertyDefn prop) throws UserPropertyException
addUserPropertyDefn
in class DesignElementHandle
prop
- the user property definition to add. The name and property
type must be valid.
UserPropertyException
- if the element is not allowed to have user property or the
user property definition is invalid, or if the value of the
user-defined choice is invalid for the type of user property
definition, the property type is incorrect.DesignElementHandle.addUserPropertyDefn(org.eclipse.birt.report.model.api.core.UserPropertyDefn)
public void dropAndClear() throws SemanticException
getElementHandle
to first get a handle to that element.
dropAndClear
in class DesignElementHandle
SemanticException
- if this element has no container or the element cannot be
dropped.DesignElementHandle.dropAndClear()
public void drop() throws SemanticException
getElementHandle
to first get a handle to that element.
drop
in class DesignElementHandle
SemanticException
- if this element has no container or the element cannot be
dropped.DesignElementHandle.drop()
public void dropUserPropertyDefn(java.lang.String propName) throws UserPropertyException
getElementHandle
to first get a handle to that element.
dropUserPropertyDefn
in class DesignElementHandle
propName
- the name of the user property to remove
UserPropertyException
- If the property is not found.DesignElementHandle.dropUserPropertyDefn(java.lang.String)
public int findContentSlot(DesignElementHandle content)
getElementHandle
to first get a handle to that element.
findContentSlot
in class DesignElementHandle
content
- handle to the content element to find
IDesignElementModel.NO_SLOT
if the element is not contained in
this element.DesignElementHandle.findContentSlot(org.eclipse.birt.report.model.api.DesignElementHandle)
public DesignElementHandle getExtends()
getElementHandle
to first get a handle to that element.
getExtends
in class DesignElementHandle
null
if this element
does not have a parent, or if the extends name does not resolve
to a valid element.DesignElementHandle.getExtends()
public void moveTo(DesignElementHandle newContainer, int toSlot) throws ContentException
getElementHandle
to first get a handle to that element.
moveTo
in class DesignElementHandle
newContainer
- the new container elementtoSlot
- the target slot within the new container
ContentException
- If the element cannot be placed into the target element or
slot, perhaps because the element is of the wrong type, the
slot is full, or other error.DesignElementHandle.moveTo(org.eclipse.birt.report.model.api.DesignElementHandle,
int)
public void setExtends(DesignElementHandle parent) throws ExtendsException
getElementHandle
to first get a handle to that element.
setExtends
in class DesignElementHandle
parent
- handle to the element that this element is to extend. If
null
, then this element will no longer extend
another element.
ExtendsException
- if the parent element is of the wrong type as this element.DesignElementHandle.setExtends(org.eclipse.birt.report.model.api.DesignElementHandle)
public void setExtendsElement(org.eclipse.birt.report.model.core.DesignElement parent) throws ExtendsException
getElementHandle
to first get a handle to that element.
setExtendsElement
in class DesignElementHandle
parent
- the element that this element is to extend
ExtendsException
- If the parent element is of the wrong type as this element.DesignElementHandle.setExtendsElement(org.eclipse.birt.report.model.core.DesignElement)
public void setExtendsName(java.lang.String name) throws ExtendsException
getElementHandle
to first get a handle to that element.
setExtendsName
in class DesignElementHandle
name
- the name of the element that this one is to extend
ExtendsException
- if no element exists with the given name, or if the element
is of the wrong type.DesignElementHandle.setExtendsName(java.lang.String)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |