public class PathDescriptor extends SettingDescriptor
Constructor and Description |
---|
PathDescriptor(java.lang.String name,
java.lang.String label,
java.awt.Color color,
Enums.PointType type,
Enums.Size size)
Constructor.
|
PathDescriptor(java.lang.String name,
java.lang.String label,
java.awt.Color color,
Enums.PointType type,
Enums.Size size,
boolean enabled,
boolean supportsMaxPoints,
boolean supportsDisable)
Constructor.
|
PathDescriptor(java.lang.String name,
java.lang.String label,
java.awt.Color color,
float width,
float[] dash)
Constructor
|
PathDescriptor(java.lang.String name,
java.lang.String label,
java.awt.Color color,
float width,
float[] dash,
boolean enabled,
boolean supportsMaxPoints,
boolean supportsDisable)
Constructor.
|
PathDescriptor(java.lang.String name,
java.lang.String label,
java.awt.Color color,
float width,
float[] dash,
boolean enabled,
boolean supportsColor2,
boolean supportsMaxPoints,
boolean supportsDisable)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
javax.swing.JComponent |
createInput(Settings settings,
boolean readOnly)
Creates the component that will accept the user input.
|
java.awt.Color |
getColor()
Gets the default color of the path line/points.
|
java.awt.Color |
getColor2()
Gets the default secondary color for the path line.
|
java.awt.Color |
getColor3()
Gets the default tertiary color for the path line.
|
java.awt.Color |
getColor4()
Gets the default quaternary color for the path line.
|
Enums.ColorPolicy[] |
getColorPolicies()
Gets the supported color policies for this path.
|
Enums.ColorPolicy |
getColorPolicy()
Gets the color policy for this path.
|
float[] |
getDash()
Gets the default dash setting for the path line (null for solid line).
|
PathInfo |
getDefaultValue()
Gets the default value as a PathInfo object.
|
java.lang.Integer |
getFixedWidth()
Gets the fixed width for displaying bars (null for dynamic width).
|
java.lang.Double |
getGradientCenter()
Gets the center point for the gradient (null if automatic).
|
int |
getMaxPoints()
Gets the default maximum number of points to display for the path.
|
Enums.Size |
getPointSize()
Gets the default size of the path points.
|
Enums.PointType |
getPointType()
Gets the default type of point displayed for each value in the path.
|
Enums.ShadeType |
getShadeType()
Gets the shade type for this path.
|
Enums.ShadeType[] |
getShadeTypes()
Gets the supported shade types for this path.
|
float |
getWidth()
Gets the default width of the path line.
|
boolean |
isContinuous()
Indicates if both path line is continuous even if values are missing.
|
boolean |
isDisplaySetting()
Indicates if this setting is used to affect the appearance of the of the study/strategy
|
boolean |
isGradient()
Deprecated.
user color policy instead
|
boolean |
isShowAllPoints()
Indicates if all points on the path should be shown by default.
|
boolean |
isShowAsBars()
Indicates if all path should be show as bars by default.
|
boolean |
isShowPath()
Indicates if the path line should be shown by default.
|
boolean |
isShowPoints()
Indicates if the points of the path should be shown by default.
|
boolean |
isSupportsAdvancedPanel()
Indicates if the advanced settings panel is supported for this setting.
|
boolean |
isSupportsBoth()
Indicates if both path line and path points are supported at the same time.
|
boolean |
isSupportsColor2()
Deprecated.
use supportsColorPolicy instead
|
boolean |
isSupportsColorPolicy()
Determines if the user is allowed to choose the color policy.
|
boolean |
isSupportsMaxPoints()
Determines if the max points attribute is supported for this setting.
|
boolean |
isSupportsShadeType()
Determines if the user is allowed to choose the shade type for the path.
|
boolean |
isSupportsShowAsBars()
Determines if the path can optionally be shown as bars.
|
boolean |
isSupportsShowPoints()
Determines if the show points attribute is supported for this setting.
|
void |
setColor(java.awt.Color c)
Sets the default color for the path line and/or points.
|
void |
setColor2(java.awt.Color color)
Sets the default secondary color for the path line.
|
void |
setColor3(java.awt.Color color)
Sets the default tertiary color for the path line.
|
void |
setColor4(java.awt.Color color)
Sets the default quaternary color for the path line.
|
void |
setColorPolicies(Enums.ColorPolicy[] policies)
Sets the supported color policies for this path.
|
void |
setColorPolicy(Enums.ColorPolicy policy)
Sets the color policy for this path.
|
void |
setContinuous(boolean b)
Sets the continuous option for the path.
|
void |
setDash(float[] dash)
Sets the default dash setting for the path line (null for solid line).
|
void |
setFixedWidth(java.lang.Integer width)
Sets the fixed width for displaying bars (null for dynamic width).
|
void |
setGradient(boolean b)
Deprecated.
use color policy instead
|
void |
setGradientCenter(java.lang.Double center)
Sets the center point for the gradient (null if automatic).
|
void |
setMaxPoints(int max)
Sets the default maximum number of points to display for the path.
|
void |
setPointSize(Enums.Size size)
Sets the default size of the path points.
|
void |
setPointType(Enums.PointType type)
Sets the default type of point displayed for each value in the path.
|
void |
setShadeType(Enums.ShadeType shadeType)
sets the shade type for this path.
|
void |
setShadeTypes(Enums.ShadeType[] shadeTypes)
Sets the supported shade types for this path.
|
void |
setShowAllPoints(boolean b)
Sets the default show all points value.
|
void |
setShowAsBars(boolean b)
Sets the default show as bars value.
|
void |
setShowPath(boolean b)
Sets the default 'show path' attribute.
|
void |
setShowPoints(boolean b)
Sets the default 'show points' attribute.
|
void |
setSupportsAdvancedPanel(boolean b)
Indicates if the advanced settings panel is supported for this setting.
|
void |
setSupportsBoth(boolean b)
Indicates if both the path line and path points are supported at the same time.
|
void |
setSupportsColor2(boolean b)
Deprecated.
use supportsColorPolicy instead
|
void |
setSupportsColorPolicy(boolean b)
Determines if the user is allowed to choose the color policy.
|
void |
setSupportsDisable(boolean b)
Sets the supports disable attribute for the path.
|
void |
setSupportsMaxPoints(boolean b)
Determines if the max points attribute is supported for this setting.
|
void |
setSupportsShadeType(boolean b)
Determines if the user is allowed to choose the shade type for the path.
|
void |
setSupportsShowAsBars(boolean b)
Determines if the path can optionally be shown as bars.
|
void |
setSupportsShowPoints(boolean b)
Determines if the show points attribute is supported for this setting.
|
void |
setWidth(float w)
Sets the default with of the path line.
|
getGridWidth, getLabel, getName, isAllowUserDefaults, isEnabled, isShowLabel, isSupportsDisable, setAllowUserDefaults, setDefaultValue, setEnabled, setGridWidth, setShowLabel
public PathDescriptor(java.lang.String name, java.lang.String label, java.awt.Color color, float width, float[] dash)
name
- name of the setting (key)label
- label displayed to the usercolor
- default color of the path linewidth
- default width of the path linedash
- default dash value of the path linepublic PathDescriptor(java.lang.String name, java.lang.String label, java.awt.Color color, float width, float[] dash, boolean enabled, boolean supportsMaxPoints, boolean supportsDisable)
name
- name of the setting (key)label
- label displayed to the usercolor
- default color of the path linewidth
- default width of the path linedash
- default dash value of the path lineenabled
- true if the path is enabled by defaultsupportsMaxPoints
- true if the max points setting is allowedsupportsDisable
- true if the user can disable this pathpublic PathDescriptor(java.lang.String name, java.lang.String label, java.awt.Color color, float width, float[] dash, boolean enabled, boolean supportsColor2, boolean supportsMaxPoints, boolean supportsDisable)
name
- name of the setting (key)label
- label displayed to the usercolor
- default color of the path linewidth
- default width of the path linedash
- default dash value of the path lineenabled
- true if the path is enabled by defaultsupportsColor2
- true if a secondary color can be set for this pathsupportsMaxPoints
- true if the max points setting is allowedsupportsDisable
- true if the user can disable this pathpublic PathDescriptor(java.lang.String name, java.lang.String label, java.awt.Color color, Enums.PointType type, Enums.Size size)
name
- name of the setting (key)label
- label displayed to the usercolor
- default color of the path linetype
- type of point to be displayedsize
- size of the pointspublic PathDescriptor(java.lang.String name, java.lang.String label, java.awt.Color color, Enums.PointType type, Enums.Size size, boolean enabled, boolean supportsMaxPoints, boolean supportsDisable)
name
- name of the setting (key)label
- label displayed to the usercolor
- default color of the path linetype
- type of point to be displayedsize
- size of the pointsenabled
- true if the path is enabled by defaultsupportsMaxPoints
- true if the max points setting is allowedsupportsDisable
- true if the user can disable this pathpublic void setSupportsDisable(boolean b)
setSupportsDisable
in class SettingDescriptor
b
- true if supports disable is allowedpublic PathInfo getDefaultValue()
getDefaultValue
in class SettingDescriptor
public javax.swing.JComponent createInput(Settings settings, boolean readOnly)
SettingDescriptor
createInput
in class SettingDescriptor
settings
- settings for the studyreadOnly
- true if the component should not accept user inputpublic float getWidth()
public void setWidth(float w)
w
- width of the path linepublic float[] getDash()
public void setDash(float[] dash)
dash
- dash setting for the linepublic boolean isShowPoints()
public void setShowPoints(boolean b)
b
- true if the points of the path should be shownpublic boolean isShowPath()
public void setShowPath(boolean b)
b
- true if the path line should be drawnpublic Enums.Size getPointSize()
public void setPointSize(Enums.Size size)
size
- default size of the path pointspublic Enums.PointType getPointType()
public void setPointType(Enums.PointType type)
type
- default type of point to be displaed for each value in the pathpublic java.awt.Color getColor()
public void setColor(java.awt.Color c)
c
- color of the path line and/or pointspublic java.awt.Color getColor2()
public void setColor2(java.awt.Color color)
color
- secondary color for the pathpublic java.awt.Color getColor3()
public void setColor3(java.awt.Color color)
color
- tertiary color for the pathpublic java.awt.Color getColor4()
public void setColor4(java.awt.Color color)
color
- quaternary color for the pathpublic boolean isSupportsColor2()
public void setSupportsColor2(boolean b)
b
- true if the secondary color is supportedpublic Enums.ColorPolicy getColorPolicy()
public void setColorPolicy(Enums.ColorPolicy policy)
policy
- color policypublic Enums.ColorPolicy[] getColorPolicies()
public void setColorPolicies(Enums.ColorPolicy[] policies)
policies
- supported color policiespublic Enums.ShadeType getShadeType()
public void setShadeType(Enums.ShadeType shadeType)
shadeType
- type of shadepublic Enums.ShadeType[] getShadeTypes()
public void setShadeTypes(Enums.ShadeType[] shadeTypes)
shadeTypes
- supported shade typespublic boolean isShowAllPoints()
public void setShowAllPoints(boolean b)
b
- true if all path points should be shownpublic boolean isShowAsBars()
public void setShowAsBars(boolean b)
b
- true if the path should be shown as a series of barspublic java.lang.Integer getFixedWidth()
public void setFixedWidth(java.lang.Integer width)
width
- fixed width for displaying barspublic int getMaxPoints()
public void setMaxPoints(int max)
max
- maximum number of points to displaypublic boolean isSupportsMaxPoints()
public void setSupportsMaxPoints(boolean b)
b
- true if max points is supportedpublic boolean isSupportsColorPolicy()
public void setSupportsColorPolicy(boolean b)
b
- true if user is allowed to choose the color policypublic boolean isSupportsShadeType()
public void setSupportsShadeType(boolean b)
b
- true if user is allowed to choose the shade typepublic boolean isSupportsShowPoints()
public void setSupportsShowPoints(boolean b)
b
- true if the show points attribute is supportedpublic boolean isSupportsShowAsBars()
public void setSupportsShowAsBars(boolean b)
b
- true if the path can be shown as barspublic boolean isSupportsAdvancedPanel()
public void setSupportsAdvancedPanel(boolean b)
b
- true if the user can see the advanced pathpublic boolean isSupportsBoth()
public void setSupportsBoth(boolean b)
b
- true if both the path line and path points are supported at the same time.public boolean isContinuous()
public void setContinuous(boolean b)
b
- true if the path line is continuous when there are values missingpublic boolean isGradient()
public void setGradient(boolean b)
b
- true if the colors are part of a gradientpublic java.lang.Double getGradientCenter()
public void setGradientCenter(java.lang.Double center)
center
- center point for the gradientpublic boolean isDisplaySetting()
SettingDescriptor
isDisplaySetting
in class SettingDescriptor