|
||||||||||
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.ThemeHandle
public class ThemeHandle
Represents a theme in the library. Each theme contains some number of styles.
Theme
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.IThemeModel |
---|
CSSES_PROP, DEFAULT_THEME_NAME, STYLES_SLOT |
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 | |
---|---|
ThemeHandle(org.eclipse.birt.report.model.core.Module module,
org.eclipse.birt.report.model.core.DesignElement element)
Constructs the handle for a theme with the given design and element. |
Method Summary | |
---|---|
void |
addCss(CssStyleSheetHandle sheetHandle)
Includes one css with the given css file name. |
void |
addCss(IncludedCssStyleSheet cssStruct)
Includes one CSS structure with the given IncludedCssStyleSheet. |
void |
addCss(java.lang.String fileName)
Includes one css with the given css file name. |
boolean |
canAddCssStyleSheet(CssStyleSheetHandle sheetHandle)
Check style sheet can be added or not. |
boolean |
canAddCssStyleSheet(java.lang.String fileName)
Check style sheet can be added or not. |
boolean |
canDropCssStyleSheet(CssStyleSheetHandle sheetHandle)
Check style sheet can be droped or not. |
boolean |
canRenameCss(IncludedCssStyleSheetHandle handle,
java.lang.String newFileName)
Checks included style sheet can be renamed or not. |
void |
dropCss(CssStyleSheetHandle sheetHandle)
Drops the given css style sheet of this design file. |
CssStyleSheetHandle |
findCssStyleSheetHandleByName(java.lang.String fileName)
Gets CssStyleSheetHandle by file name. |
IncludedCssStyleSheetHandle |
findIncludedCssStyleSheetHandleByName(java.lang.String fileName)
Gets IncludedCssStyleSheetHandle by file name. |
StyleHandle |
findStyle(java.lang.String name)
Returns the style with the given name. |
java.util.List |
getAllCssStyleSheets()
Gets all css styles sheet |
java.util.List |
getAllStyles()
Gets all styles in theme,include css file. |
java.lang.String |
getDisplayLabel(int level)
Returns the display label for this element. |
SlotHandle |
getStyles()
Returns the styles slot of row. |
java.util.Iterator |
includeCssesIterator()
Returns the iterator over all included css style sheets. |
void |
reloadCss(CssStyleSheetHandle sheetHandle)
Reloads the css with the given css file path. |
void |
renameCss(IncludedCssStyleSheetHandle handle,
java.lang.String newFileName)
Renames both IncludedCssStyleSheet and
CSSStyleSheet |
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 ThemeHandle(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 SlotHandle getStyles()
SlotHandle
public java.util.List getAllStyles()
StyleHandle
public java.util.List getAllCssStyleSheets()
CssStyleSheetHandle
public StyleHandle findStyle(java.lang.String name)
name
- the style name
public java.lang.String getDisplayLabel(int level)
DesignElementHandle
The user can also decide at which detail level the display label should be returned. The level can be one of the following options:
getDisplayLabel
in class DesignElementHandle
level
- the display label detail level
public java.util.Iterator includeCssesIterator()
IncludedCssStyleSheetHandle
public void addCss(CssStyleSheetHandle sheetHandle) throws SemanticException
sheetHandle
- css style sheet handle
SemanticException
- if error is encountered when handling
CssStyleSheet
structure list.public void addCss(IncludedCssStyleSheet cssStruct) throws SemanticException
cssStruct
- the CSS structure
SemanticException
- if error is encountered when handling
CssStyleSheet
structure list.public void addCss(java.lang.String fileName) throws SemanticException
fileName
- css file name
SemanticException
- if error is encountered when handling
CssStyleSheet
structure list.public void dropCss(CssStyleSheetHandle sheetHandle) throws SemanticException
sheetHandle
- the css to drop
SemanticException
- if error is encountered when handling
CssStyleSheet
structure list. Or it maybe
because that the given css is not found in the design. Or
that the css has descedents in the current modulepublic boolean canDropCssStyleSheet(CssStyleSheetHandle sheetHandle)
sheetHandle
-
true
can be dropped.else return false
public boolean canAddCssStyleSheet(CssStyleSheetHandle sheetHandle)
sheetHandle
-
true
can be added.else return false
public boolean canAddCssStyleSheet(java.lang.String fileName)
fileName
-
true
can be added.else return false
public void reloadCss(CssStyleSheetHandle sheetHandle) throws SemanticException
sheetHandle
- css style sheet handle
SemanticException
- if error is encountered when handling
CssStyleSheet
structure list. Or it maybe
because that the given css is not found in the design. Or
that the css has descedents in the current modulepublic CssStyleSheetHandle findCssStyleSheetHandleByName(java.lang.String fileName)
CssStyleSheetHandle
by file name.
fileName
- the file name.
public IncludedCssStyleSheetHandle findIncludedCssStyleSheetHandleByName(java.lang.String fileName)
IncludedCssStyleSheetHandle
by file name.
fileName
- the file name
public void renameCss(IncludedCssStyleSheetHandle handle, java.lang.String newFileName) throws SemanticException
IncludedCssStyleSheet
and
CSSStyleSheet to newFileName.
- Parameters:
handle
- the includedCssStyleSheetHandlenewFileName
- the new file name
- Throws:
SemanticException
public boolean canRenameCss(IncludedCssStyleSheetHandle handle, java.lang.String newFileName) throws SemanticException
handle
- the included css style sheet handle.newFileName
- the new file name.
true
can be renamed.else return false
SemanticException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |