public abstract class CommonChartOptions extends DvtExtendedPatternOptions
Modifier and Type | Class and Description |
---|---|
static class |
CommonChartOptions.PopupBehaviorAlignType
enum that publishes the valid values for the af:showPopupBehavior
tag's align property.
|
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
AREA_CHART |
static java.lang.String |
BAR_CHART |
static java.lang.String |
BUBBLE_CHART |
static java.lang.String |
CHART_LEGEND |
static java.lang.String |
CHART_Y2AXIS |
static java.lang.String |
COMBO_CHART |
static java.lang.String |
DVT |
static java.lang.String |
FUNNEL_CHART |
static java.lang.String |
HORIZONTAL_BAR_CHART |
static java.lang.String |
LINE_CHART |
protected java.lang.String |
m_clAction |
protected java.lang.String |
m_clMethod |
protected java.lang.String |
m_pbAlignId |
protected boolean |
m_pbDisabled |
protected java.lang.String |
m_pbId |
protected java.lang.String |
m_pbTriggerType |
static java.lang.String |
PIE_CHART |
static java.lang.String |
SCATTER_CHART |
static java.lang.String |
STOCK_CHART |
Constructor and Description |
---|
CommonChartOptions() |
Modifier and Type | Method and Description |
---|---|
void |
applyChanges(BinderParams bindParams)
Applies changes from this set of properties to the subtree rooted by the
bind root in the bind params.
|
java.util.List<ChartSeriesStyle> |
getChartSeriesStyleItems() |
java.lang.String |
getClientListenerAction()
Returns the af:clientListener's action attribute value.
|
java.lang.String |
getClientListenerMethod()
Returns the af:clientListener's method attribute value.
|
java.lang.String |
getId() |
CommonChartOptions.PopupBehaviorAlignType |
getPopupBehaviorAlign()
Returns the align attribute value set on a af:showPopupBehavior tag.
|
java.lang.String |
getPopupBehaviorAlignId()
Retusn the alignId attribute value set on a af:showPopupBehavior tag.
|
java.lang.String |
getPopupBehaviorId()
Returns the popupId property value set on a af:showPopupBehavior tag.
|
java.lang.String |
getPopupBehaviorTriggerType()
Returns the triggerType attribute value set on a af:showPopupBehavior tag.
|
protected java.lang.String |
getProperty(java.lang.String localName)
Gets the attribute that will be applied on the root element of the bind root.
|
java.lang.String |
getValue()
Returns the value attribute of the chart.
|
java.lang.String |
getVar()
Returns the name of the var attribute.
|
boolean |
isPopupBehaviorDisabled()
Returns the disabled attribute value set on a af:showPopupBehavior tag.
|
void |
setChartSeriesStyleItems(java.util.List<ChartSeriesStyle> items) |
void |
setClientListenerAction(java.lang.String action)
Sets the af:clientListener's action attribute value.If such value is set
then an af:clientListener child tag will be added to the chart during bind
operation.
|
void |
setClientListenerMethod(java.lang.String method)
Sets the af:clientListener's method attribute value.
|
void |
setId(java.lang.String id) |
void |
setPopupBehaviorAlign(CommonChartOptions.PopupBehaviorAlignType align)
Sets the align attribute on a af:showPopupBehavior tag.
|
void |
setPopupBehaviorAlignId(java.lang.String id)
Sets the alignId attribute value.
|
void |
setPopupBehaviorDisabled(boolean disabled)
Sets whether the af:showPopupBehavior tag added as a child tag to a chart
will be disabled or not.
|
void |
setPopupBehaviorId(java.lang.String id)
Sets the popupId property value for a af:showPopupBehavior tag.
|
void |
setPopupBehaviorTriggerType(java.lang.String triggerType)
Sets the triggerType attribute on a af:showPopupBehavior tag.
|
protected void |
setProperty(java.lang.String localName,
java.lang.String value)
Sets the attribute that will be applied on the root element of the bind root.
|
void |
setValue(java.lang.String value)
Sets the value parameter of the chart.
|
void |
setVar(java.lang.String var)
Sets the var attribute's name.
|
getBindingOptions
getExtendedProperties
merge
public static final java.lang.String AREA_CHART
public static final java.lang.String BAR_CHART
public static final java.lang.String LINE_CHART
public static final java.lang.String HORIZONTAL_BAR_CHART
public static final java.lang.String COMBO_CHART
public static final java.lang.String SCATTER_CHART
public static final java.lang.String BUBBLE_CHART
public static final java.lang.String PIE_CHART
public static final java.lang.String FUNNEL_CHART
public static final java.lang.String STOCK_CHART
public static final java.lang.String CHART_LEGEND
public static final java.lang.String CHART_Y2AXIS
public static final java.lang.String DVT
protected java.lang.String m_clMethod
protected java.lang.String m_clAction
protected java.lang.String m_pbId
protected java.lang.String m_pbTriggerType
protected java.lang.String m_pbAlignId
protected boolean m_pbDisabled
public void setChartSeriesStyleItems(java.util.List<ChartSeriesStyle> items)
items
- a List of ChartSeriesStyle instances. These instances
will be added as dvt:chartSeriesStyle child tags to the chart during
a bind/rebind operation.public java.util.List<ChartSeriesStyle> getChartSeriesStyleItems()
public void setId(java.lang.String id)
id
- A String that is the unique id of the chart.public java.lang.String getId()
public void setVar(java.lang.String var)
var
- The var
property value.public java.lang.String getVar()
var
attribute.public void setClientListenerMethod(java.lang.String method)
method
- The af:clientListener
method attribute value.public java.lang.String getClientListenerMethod()
String
that's the af:clientListener's method attribute value.public void setClientListenerAction(java.lang.String action)
action
- the af:clientListener's action attribute value.public java.lang.String getClientListenerAction()
public void setPopupBehaviorId(java.lang.String id)
id
- the af:showPopupBehavior tag's id.public java.lang.String getPopupBehaviorId()
public void setPopupBehaviorTriggerType(java.lang.String triggerType)
triggerType
- The triggerType property value on the af:showPopupBehavior tag used by the chart.public java.lang.String getPopupBehaviorTriggerType()
public void setPopupBehaviorAlign(CommonChartOptions.PopupBehaviorAlignType align)
align
- The value of the 'align' attribute on a af:showPopupBehavior tag.public CommonChartOptions.PopupBehaviorAlignType getPopupBehaviorAlign()
public void setPopupBehaviorAlignId(java.lang.String id)
id
- the alignId attribute valuepublic java.lang.String getPopupBehaviorAlignId()
public void setPopupBehaviorDisabled(boolean disabled)
disabled
- True if the af:showPopupBehavior tag added as a child tag to a chart
will be disabled.public boolean isPopupBehaviorDisabled()
public void applyChanges(BinderParams bindParams)
bindParams
- The bind params containing the binding rootpublic final void setValue(java.lang.String value)
value
- The 'value' parameter of the chart. Used internally.public final java.lang.String getValue()
protected void setProperty(java.lang.String localName, java.lang.String value)
localName
- Localname of the attributevalue
- Value to setprotected java.lang.String getProperty(java.lang.String localName)
localName
- Localname of the attribute