|
TPTP 4.5.0 Platform Project Internal API Specification |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.eclipse.tptp.platform.report.core.internal.DItem
org.eclipse.tptp.platform.report.core.internal.DItemContainer
org.eclipse.tptp.platform.report.core.internal.DGraphic
org.eclipse.tptp.platform.report.birt).
public class DGraphic
Graphics purpose is to display chart in documents. Graphics are parent of axis and curve, curve must contains at least one points (or more, depending on curve type), and points define one or more coordinates (associated to an axis), that's the data structure of a graphic. Graphics have a type (see T_xxxx constants), used by drivers (ie graphic render) to display data in differents way. In addition display property (see D_xxxx constants) can be used to configure graphic rendering (for instance including legend...) Graphic may have a title. In addition graphic can hold any property. A property is an object associated with a key (String). By default DGraphic define any property key (se P_xxx constants) but user can add it own property (very usefull for graphic render). Few graphics type can have textuals labels, see DPoint class to know how to set labels and which graphic type can have labels.
| Field Summary | |
|---|---|
static double |
DEF_3D_HEIGHT
Deprecated. default value for P_3D_HEIGHT property |
static float |
DEF_3D_LIGHT
Deprecated. default value for P_3D_LIGHT property |
static float |
DEF_3D_SHADOW
Deprecated. default value for P_3D_SHADOW property |
static java.lang.String |
P_3D
Deprecated. boolean property to set "3D" effect on graphics (ie 3D bar in histograms). |
static java.lang.String |
P_3D_HEIGHT
Deprecated. property key for a positive number to change height (DEF_3D_HEIGHT by default). |
static java.lang.String |
P_3D_LIGHT
Deprecated. property key for a float(double) number to change 3D graphic's light strength (close to specular light effect) 0 means no light, 1 means light is White, default value is DEF_3D_LIGHT. |
static java.lang.String |
P_3D_SHADOW
Deprecated. property key for a float(double) number to change 3D graphic's shadow strength. 0 means no shadow, 1 means shadow is Black, default value is DEF_3D_SHADOW. |
static java.lang.String |
P_BACK_AREA
Deprecated. If property is set (true), the filled area of T_STACKED_AREA and T_AREA curves are drawn below the axis lines, otherwise filled area are drawn above axis lines (and can hidde them). |
static java.lang.String |
P_BACKCOLOR
Deprecated. string property to set a color for the background. |
static java.lang.String |
P_HEIGHT_SCALE
Deprecated. property to set a scale on the height of the graphic, scale is in 0..1, default is 1 |
static java.lang.String |
P_ID
Deprecated. property key for a string value which defines the chart id. |
static java.lang.String |
P_LEGEND_ACC_DESC
Deprecated. property key for a string object which defines the legend description required by the screen reader. |
static java.lang.String |
P_LEGEND_ACC_TITLE
Deprecated. property key for a string object which defines the legend title required by the screen reader. |
static java.lang.String |
P_LEGEND_BACKCOLOR
Deprecated. property key for an IDColor which defines the background color for the legend. |
static java.lang.String |
P_LEGEND_EVENT_LIST
Deprecated. property key for a List of DEvent object which defines the interactions on the chart legend. |
static java.lang.String |
P_LEGEND_HEIGHT
Deprecated. property key for a integer defining the height of the legend can graphically take. |
static java.lang.String |
P_LEGEND_ID
Deprecated. property key for a string object which defines the legend id. |
static java.lang.String |
P_LEGEND_LABEL
Deprecated. property key for a string which defines the label for the legend. |
static java.lang.String |
P_LEGEND_LAYOUT
Deprecated. property key for a DAlignmentPair object controlling the layout and alignment of graphic legend. |
static java.lang.String |
P_LEGEND_LIMIT
Deprecated. property key for a integer defining the maximum space the legend can graphically take. |
static java.lang.String |
P_LEGEND_LOCATION
Deprecated. property key for a string object which defines the legend location. |
static java.lang.String |
P_LEGEND_TOOLTIP
Deprecated. property key for a string which defines the tooltip for the legend. |
static java.lang.String |
P_LEGEND_WIDTH
Deprecated. property key for a integer defining the width of the legend can graphically take. |
static java.lang.String |
P_MARGIN
Deprecated. property key for a positive integer to change margin used by default chart render. |
static java.lang.String |
P_MAX_HEIGHT
Deprecated. property to constraint the maximum height of graphic in pixel... |
static java.lang.String |
P_MAX_WIDTH
Deprecated. property to constraint the maximum width of graphic in pixel... |
static java.lang.String |
P_MIN_HEIGHT
Deprecated. property to constraint the minimum height of graphic in pixel... |
static java.lang.String |
P_MIN_WIDTH
Deprecated. property to constraint the minimum width of graphic in pixel... |
static java.lang.String |
P_PLOTAREA_BACKCOLOR
Deprecated. property key for an IDColor which is the background color of the plot area. |
static java.lang.String |
P_SHOW_BORDER
Deprecated. property key for the a boolean which the chart displays or not the border. |
static java.lang.String |
P_SHOW_LEGEND
Deprecated. property key, hold a Boolean value false to not display legend (otherwise the legend is displayed) |
static java.lang.String |
P_SHOW_PERCENTAGE
Deprecated. property key for string value which defines if the value is displayed as a percentage. |
static java.lang.String |
P_SHOW_PLOTAREA_BORDER
Deprecated. property key for the a boolean which the chart displays or not the border. |
static java.lang.String |
P_SHOW_TITLE
Deprecated. property key, hold a Boolean value false to not display graphic title (otherwise the title is displayed) |
static java.lang.String |
P_SHOW_VALUES
Deprecated. property key for T_SECTORS(3D) graphic for a boolean driving the display or not of values (and labels). |
static java.lang.String |
P_THIN_BAR
Deprecated. boolean property to set thin bar, or connected bar. |
static java.lang.String |
P_TITLE_ACC_DESC
Deprecated. property key for a string which defines title description required by the screen reader. |
static java.lang.String |
P_TITLE_ACC_TITLE
Deprecated. property key for a string which defines accessibility title required by the screen reader. |
static java.lang.String |
P_TITLE_BACKCOLOR
Deprecated. property key for an IDColor which defines the background color of the title Only activated for the SVG generation. |
static java.lang.String |
P_TITLE_EVENT_LIST
Deprecated. property key for a List of DEvent object which defines the interaction on the chart title. |
static java.lang.String |
P_TITLE_LAYOUT
Deprecated. property key for a DAlignmentPair object controlling the layout and alignment of graphic title. |
static java.lang.String |
P_TITLE_TOOLTIP
Deprecated. property key for a string which defines the tooltip of the title Only activated for the SVG generation. |
static java.lang.String |
P_TITLE_WITH_SEPARATOR
Deprecated. property key for a string which defines the separator Only activated for the SVG generation. |
static java.lang.String |
P_VALUE_FORMAT
Deprecated. property key for a string value which defines the value format displayed in the chart. |
static java.lang.String |
P_VERSION
Deprecated. property key for a string which represents the format version. |
static java.lang.String |
P_WIDTH_SCALE
Deprecated. property to set a scale on the width of the graphic, scale is in 0..1, default is 1 |
static java.lang.String |
P_XYS_COLORIZER
Deprecated. property key for an instance of IXYSurfaceColorizer class, used by T_XY_SURFACE graphic type to get surface colors. |
static java.lang.String |
P_XYS_CONTOUR_LINE
Deprecated. property key to draw contour line on T_XY_SURFACE graphic type. |
static java.lang.String |
P_XYS_CONTOUR_LINE_COLOR
Deprecated. property key to define color of contour line drawn by T_XY_SURFACE graphic type. |
static java.lang.String |
P_XYS_LINE_X
Deprecated. property key for an integer (N) used by T_XY_SURFACE graphic type to render line every N face of surfaces along X axis, 0 for none. |
static java.lang.String |
P_XYS_LINE_Y
Deprecated. property key for an integer (N) used by T_XY_SURFACE graphic type to render line every N face of surfaces along Y axis, 0 for none. |
static java.lang.String |
P_XYS_NO_POLYGON
Deprecated. property key to avoid filling of polygon in a T_XY_SURFACE. |
static java.lang.String |
P_XYZ_PHI
Deprecated. property key for 'phi' (angle view for XYZ graphs), Float class if exists |
static java.lang.String |
P_XYZ_THETA
Deprecated. property key for 'theta' (angle view for XYZ graphs), Float class if exists |
static java.lang.String |
P_XYZ_XPROJ
Deprecated. property to force projection status on X axis, Boolean (default: true) |
static java.lang.String |
P_XYZ_YPROJ
Deprecated. property to force projection status on Y axis, Boolean (default: true) |
static java.lang.String |
P_XYZ_ZPROJ
Deprecated. property to force projection status on Z axis, Boolean (default: true) |
protected DPropertyStore |
properties_
Deprecated. Property store |
static java.lang.String |
T_H_HISTOGRAM_IM
Deprecated. graphic is a flat histogram using mixed values, means each point having same index from curves are rendered together. |
static java.lang.String |
T_H_STACKBARS
Deprecated. Graphic made of vertical stacked bars. |
static java.lang.String |
T_HBARS
Deprecated. graphic made of horizontal bars, this graphic type contains four kind of graphics: simple histogram bars: use une DAxis, several DCurve and DPoint with one DCoord by point one chart begin-end bars: use one DAxis, several DCurve/DPoint, by set two DCoord by points two horizontal bars: same as simple horizontal bars, but use two DAxis (one by chart). |
static java.lang.String |
T_HISTOGRAM
Deprecated. graphic made of vertical bar, require one axis, several DCurve and DPoint. |
static java.lang.String |
T_HISTOGRAM_IM
Deprecated. graphic is a flat histogram using mixed values, means each point having same index from curves are rendered together. |
static java.lang.String |
T_HISTORS
Deprecated. graphic is made of fixed angle sectors but ray depends on points values |
static java.lang.String |
T_METER
Deprecated. Graphic showing a Meter. |
static java.lang.String |
T_PIE3D
Deprecated. Graphic is a Pie chart using 3D projection, with free rotation. |
static java.lang.String |
T_SECTORS
Deprecated. graphic is made of flat sectors, require one axis, 1+ curve with 1+ points |
static java.lang.String |
T_SECTORS3D
Deprecated. graphic is made of sectors displayed as simulated 3D elevation (see T_SECTORS) |
static java.lang.String |
T_SERIES3D
Deprecated. Graphic made of real 3D bars, 3D lines (ribbon), others. |
static java.lang.String |
T_STACKBARS
Deprecated. Graphic made of vertical stacked bars. |
static java.lang.String |
T_TORUS3D
Deprecated. Graphic is a 3D Torus, with free rotation (similar to T_PIE3D but using a torus as volume). |
static java.lang.String |
T_WIREFRAME
Deprecated. 3D graphic displaying a surface, require 3 axis, 2+ curves with same number of points . |
static java.lang.String |
T_XY
Deprecated. default values for graphic_type_ 2D plan, required two axis support curve type LINE,BAR,POINTS. |
static java.lang.String |
T_XY_SURFACE
Deprecated. Graphic is a XY Surface with Z raising, rendered using 3D projection with free rotation. |
static java.lang.String |
T_XYZ
Deprecated. 3D graphic displaying curves, require 3 axis. |
| Constructor Summary | |
|---|---|
DGraphic()
Deprecated. Creates an empty graphic. |
|
| Method Summary | |
|---|---|
boolean |
canMoves()
Deprecated. |
static boolean |
CanMoves(DGraphic graphic)
Deprecated. |
java.lang.String |
getGraphicType()
Deprecated. Alias of getRenderableId. |
float |
getHeightScale()
Deprecated. Access method for the heightScale property. |
java.util.Locale |
getLocale()
Deprecated. Return the locale set to the chart. |
DPropertyStore |
getProperties()
Deprecated. |
java.lang.String |
getRenderableId()
Deprecated. Return graphic type identifier. |
java.lang.String |
getTitle()
Deprecated. Access method for the title_ property. |
float |
getWidthScale()
Deprecated. Access method for the widthScale property. |
boolean |
isGraphicType(java.lang.String _gt)
Deprecated. Alias of isRenderableId |
boolean |
isRenderableId(java.lang.String _gt)
Deprecated. |
void |
setGraphicType(java.lang.String _gt)
Deprecated. Alias of setRenderableId Changes graphic type. |
void |
setHeightScale(float aHeightScale)
Deprecated. Sets the value of the heightScale property. |
void |
setProperties(DPropertyStore store)
Deprecated. Change current property store of graphic. |
void |
setRenderableId(java.lang.String _gt)
Deprecated. Changes renderable id, ie: graphic type. |
void |
setTitle(java.lang.String aTitle_)
Deprecated. Sets the value of the title_ property. |
void |
setWidthScale(float aWidthScale)
Deprecated. Sets the value of the widthScale property. |
| Methods inherited from class org.eclipse.tptp.platform.report.core.internal.DItemContainer |
|---|
clear, getChildCount, getChildOfClass, getChildPosition, getChildrenOfClass, getFirstChild, getLastChild, insertChild, isContainer, removeChild |
| Methods inherited from class org.eclipse.tptp.platform.report.core.internal.DItem |
|---|
addChild, getAppliedStyle, getIterator, getNext, getParent, getRoot, getStyle, setNext, setParent, setStyle |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface org.eclipse.tptp.platform.report.core.internal.IDItem |
|---|
addChild, clear, getAppliedStyle, getChildCount, getChildPosition, getFirstChild, getIterator, getLastChild, getNext, getParent, getRoot, getStyle, insertChild, isContainer, removeChild, setNext, setParent, setStyle |
| Field Detail |
|---|
protected DPropertyStore properties_
public static final java.lang.String T_SECTORS
public static final java.lang.String T_HISTOGRAM
public static final java.lang.String T_HISTOGRAM_IM
public static final java.lang.String T_H_HISTOGRAM_IM
public static final java.lang.String T_HISTORS
public static final java.lang.String T_XY
public static final java.lang.String T_XYZ
public static final java.lang.String T_WIREFRAME
T_XYZ,
Constant Field Valuespublic static final java.lang.String T_SECTORS3D
public static final java.lang.String T_HBARS
public static final java.lang.String T_STACKBARS
public static final java.lang.String T_H_STACKBARS
public static final java.lang.String T_METER
public static final java.lang.String T_SERIES3D
public static final java.lang.String T_PIE3D
public static final java.lang.String T_TORUS3D
public static final java.lang.String T_XY_SURFACE
public static final java.lang.String P_SHOW_LEGEND
public static final java.lang.String P_SHOW_TITLE
public static final java.lang.String P_XYZ_PHI
public static final java.lang.String P_XYZ_THETA
public static final java.lang.String P_XYZ_XPROJ
public static final java.lang.String P_XYZ_YPROJ
public static final java.lang.String P_XYZ_ZPROJ
public static final java.lang.String P_MAX_HEIGHT
public static final java.lang.String P_MIN_HEIGHT
public static final java.lang.String P_MAX_WIDTH
public static final java.lang.String P_MIN_WIDTH
public static final java.lang.String P_WIDTH_SCALE
public static final java.lang.String P_BACKCOLOR
public static final java.lang.String P_HEIGHT_SCALE
public static final java.lang.String P_THIN_BAR
public static final java.lang.String P_3D
public static final java.lang.String P_ID
public static final java.lang.String P_TITLE_LAYOUT
public static final java.lang.String P_TITLE_TOOLTIP
public static final java.lang.String P_TITLE_BACKCOLOR
public static final java.lang.String P_TITLE_WITH_SEPARATOR
public static final java.lang.String P_TITLE_EVENT_LIST
DEvent,
Constant Field Valuespublic static final java.lang.String P_TITLE_ACC_TITLE
public static final java.lang.String P_TITLE_ACC_DESC
public static final java.lang.String P_LEGEND_LAYOUT
P_SHOW_LEGEND,
Constant Field Valuespublic static final java.lang.String P_LEGEND_LIMIT
public static final java.lang.String P_LEGEND_WIDTH
public static final java.lang.String P_LEGEND_LOCATION
public static final java.lang.String P_LEGEND_HEIGHT
public static final java.lang.String P_LEGEND_LABEL
public static final java.lang.String P_LEGEND_TOOLTIP
public static final java.lang.String P_LEGEND_BACKCOLOR
public static final java.lang.String P_LEGEND_EVENT_LIST
DEvent,
Constant Field Valuespublic static final java.lang.String P_LEGEND_ACC_TITLE
public static final java.lang.String P_LEGEND_ACC_DESC
public static final java.lang.String P_LEGEND_ID
public static final java.lang.String P_BACK_AREA
public static final java.lang.String P_SHOW_VALUES
public static final java.lang.String P_SHOW_PERCENTAGE
public static final java.lang.String P_VALUE_FORMAT
public static final java.lang.String P_SHOW_BORDER
public static final java.lang.String P_SHOW_PLOTAREA_BORDER
public static final java.lang.String P_PLOTAREA_BACKCOLOR
public static final java.lang.String P_MARGIN
public static final java.lang.String P_3D_HEIGHT
public static final double DEF_3D_HEIGHT
public static final java.lang.String P_3D_SHADOW
public static final float DEF_3D_SHADOW
public static final java.lang.String P_3D_LIGHT
public static final float DEF_3D_LIGHT
public static final java.lang.String P_XYS_COLORIZER
IXYSurfaceColorizer,
Constant Field Valuespublic static final java.lang.String P_XYS_LINE_X
public static final java.lang.String P_XYS_LINE_Y
public static final java.lang.String P_XYS_CONTOUR_LINE
public static final java.lang.String P_XYS_CONTOUR_LINE_COLOR
public static final java.lang.String P_XYS_NO_POLYGON
public static final java.lang.String P_VERSION
| Constructor Detail |
|---|
public DGraphic()
| Method Detail |
|---|
public float getWidthScale()
getWidthScale in interface IDSizeableItempublic void setWidthScale(float aWidthScale)
setWidthScale in interface IDSizeableItemaWidthScale - the new value of the widthScale propertypublic float getHeightScale()
getHeightScale in interface IDSizeableItempublic void setHeightScale(float aHeightScale)
setHeightScale in interface IDSizeableItemaHeightScale - the new value of the heightScale propertypublic java.lang.String getTitle()
public void setTitle(java.lang.String aTitle_)
aTitle_ - the new value of the title_ propertypublic final java.lang.String getGraphicType()
public final void setGraphicType(java.lang.String _gt)
public java.lang.String getRenderableId()
getRenderableId in interface IDRenderablepublic void setRenderableId(java.lang.String _gt)
public final boolean isGraphicType(java.lang.String _gt)
public boolean isRenderableId(java.lang.String _gt)
public DPropertyStore getProperties()
public void setProperties(DPropertyStore store)
store - the new property store.public boolean canMoves()
public static boolean CanMoves(DGraphic graphic)
public java.util.Locale getLocale()
|
TPTP 4.5.0 Platform Project Internal API Specification |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||