OutputParameterInfo (JForex API 2.13.99 API)

java.lang.Object
- com.dukascopy.api.indicators.OutputParameterInfo

public class OutputParameterInfo
extends java.lang.Object

Describes output

Author:: Dmitry Shohov

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`OutputParameterInfo.DrawingStyle` Specifies how to draw output
`static class`	`OutputParameterInfo.Type` Type of the output

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DASH_LINE` Deprecated. use `OutputParameterInfo.DrawingStyle.DASH_LINE` instead
`static int`	`DOT` Deprecated. use `OutputParameterInfo.DrawingStyle.DOTS` instead
`static int`	`DOT_LINE` Deprecated. use `OutputParameterInfo.DrawingStyle.DOT_LINE` instead
`static int`	`HISTO` Deprecated. use `OutputParameterInfo.DrawingStyle.HISTOGRAM` instead
`static int`	`LINE` Deprecated. use `OutputParameterInfo.DrawingStyle.LINE` instead
`static int`	`PATTERN_BOOL` Deprecated. use `OutputParameterInfo.DrawingStyle.PATTERN_BOOL` instead
`static int`	`PATTERN_BULL_BEAR` Deprecated. use `OutputParameterInfo.DrawingStyle.PATTERN_BULL_BEAR` instead
`static int`	`PATTERN_STRENGTH` Deprecated. use `OutputParameterInfo.DrawingStyle.PATTERN_STRENGTH` instead

Constructor Summary

Constructors
Constructor and Description
`OutputParameterInfo()` Creates empty parameter description without setting any field
`OutputParameterInfo(java.lang.String name, OutputParameterInfo.Type type, int flags)` Deprecated. use `OutputParameterInfo(String, Type, DrawingStyle)` instead
`OutputParameterInfo(java.lang.String name, OutputParameterInfo.Type type, OutputParameterInfo.DrawingStyle drawingStyle)` Creates output parameter descriptor and sets all fields.
`OutputParameterInfo(java.lang.String name, OutputParameterInfo.Type type, OutputParameterInfo.DrawingStyle drawingStyle, boolean lastValueOnChart)` Creates output parameter descriptor and sets all fields.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`char`	`getArrowSymbol()` Returns arrow character for outputs with `OutputParameterInfo.DrawingStyle.ARROW_SYMBOL_UP` or `OutputParameterInfo.DrawingStyle.ARROW_SYMBOL_DOWN` style
`java.awt.Color`	`getColor()` Returns default color for output or null if no color was set Used as trend up color for outputs with `OutputParameterInfo.DrawingStyle.isOutputAsLine()` is `true`
`java.awt.Color`	`getColor2()` Used as trend down color for outputs with `OutputParameterInfo.DrawingStyle.isOutputAsLine()` is `true` By default equals to `color`
`int`	`getDisplayOrder()` Returns default display order of indicator output.
`OutputParameterInfo.DrawingStyle`	`getDrawingStyle()` Returns style that specifies how to draw this output
`int`	`getFlags()` Deprecated. use `getDrawingStyle()` instead
`Instrument`	`getInstrument()` Returns instrument of this output, or null if no instrument was set
`int`	`getLineWidth()` Returns drawing line width
`java.lang.String`	`getName()` Returns name of the output
`float`	`getOpacityAlpha()` Returns transparency alpha value
`int`	`getShift()` Shifts output by number of candles returned
`OutputParameterInfo.Type`	`getType()` Returns type of the output
`boolean`	`isDrawnByIndicator()` Returns true if indicator draws this output itself
`boolean`	`isGapAtNaN()` Returns true if drawing logic should make a gap in lines when there is a NaN or Integer.MIN_VALUE in output
`boolean`	`isHistogramTwoColor()` Returns true if histogram should be shown in two colors
`boolean`	`isShowOutput()` Checks should output be drawn or not.
`boolean`	`isShowPopupInfo()` Checks should tooltip with info appear on mouse over the output or not.
`boolean`	`isShowValueOnChart()` Checks should last value be specially drawn on chart or not.
`void`	`setArrowSymbol(char arrowSymbol)` Sets arrow character for outputs with `OutputParameterInfo.DrawingStyle.ARROW_SYMBOL_UP` or `OutputParameterInfo.DrawingStyle.ARROW_SYMBOL_DOWN` style
`void`	`setColor(java.awt.Color color)` Sets default color to use when drawing this output
`void`	`setColor2(java.awt.Color color2)` Sets default color used when drawing trend down outputs
`void`	`setDisplayOrder(int displayOrder)` Sets default display order of indicator output.
`void`	`setDrawingStyle(OutputParameterInfo.DrawingStyle drawingStyle)` Sets style that specifies how to draw this output
`void`	`setDrawnByIndicator(boolean drawnByIndicator)` If set to true, than indicator should have public method `public void drawOutput(Graphics g, int outputIdx, Object values, Color color, IIndicatorDrawingSupport indicatorDrawingSupport, List<Shape> shapes, Map<Color, List<Point>>Map<Color, List<Point>> handles)` Also it's possible to define `public double[] getMinMax(int outputIdx, Object values)` method, that will be called to define minimum and maximum values for scale Please look at the description of IIndicator interface for more info
`void`	`setFlags(int flags)` Deprecated. use `setDrawingStyle(DrawingStyle)` instead
`void`	`setGapAtNaN(boolean gapAtNaN)` Set to true to make gaps at candles with Double.NaN or Integer.MIN_VALUE in output
`void`	`setHistogramTwoColor(boolean histogramTwoColor)` If set to true and drawing style is histogram, then it will be shown in two colors, positive values with green and negative with red
`void`	`setInstrument(Instrument instrument)` Sets instrument of this output.
`void`	`setLineWidth(int lineWidth)` Sets drawing line width
`void`	`setName(java.lang.String name)` Sets name of the output
`void`	`setOpacityAlpha(float alpha)` Sets the transparency alpha value
`void`	`setShift(int shift)` Sets number of candles to shift this output
`void`	`setShowOutput(boolean showOutput)` Defines should output be drawn or not.
`void`	`setShowPopupInfo(boolean showPopupInfo)` Defines should tooltip with info appear on mouse over the output or not.
`void`	`setShowValueOnChart(boolean showValueOnChart)` Defines should last value be specially drawn on chart or not.
`void`	`setType(OutputParameterInfo.Type type)` Sets type of the output

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LINE
```
@Deprecated
public static final int LINE
```
    Deprecated. use OutputParameterInfo.DrawingStyle.LINE instead
    
    Show output as line
    
    See Also:
    
    Constant Field Values
  - DOT_LINE
```
@Deprecated
public static final int DOT_LINE
```
    Deprecated. use OutputParameterInfo.DrawingStyle.DOT_LINE instead
    
    Show output as dotted line
    
    See Also:
    
    Constant Field Values
  - DASH_LINE
```
@Deprecated
public static final int DASH_LINE
```
    Deprecated. use OutputParameterInfo.DrawingStyle.DASH_LINE instead
    
    Show output as dashed line
    
    See Also:
    
    Constant Field Values
  - DOT
```
@Deprecated
public static final int DOT
```
    Deprecated. use OutputParameterInfo.DrawingStyle.DOTS instead
    
    Show output as dots
    
    See Also:
    
    Constant Field Values
  - HISTO
```
@Deprecated
public static final int HISTO
```
    Deprecated. use OutputParameterInfo.DrawingStyle.HISTOGRAM instead
    
    Show output as histogram
    
    See Also:
    
    Constant Field Values
  - PATTERN_BOOL
```
@Deprecated
public static final int PATTERN_BOOL
```
    Deprecated. use OutputParameterInfo.DrawingStyle.PATTERN_BOOL instead
    
    If value is not zero, then draw pattern
    
    See Also:
    
    Constant Field Values
  - PATTERN_BULL_BEAR
```
@Deprecated
public static final int PATTERN_BULL_BEAR
```
    Deprecated. use OutputParameterInfo.DrawingStyle.PATTERN_BULL_BEAR instead
    
    If value: == 0 - no pattern, > 0 - bullish, < 0 - bearish
    
    See Also:
    
    Constant Field Values
  - PATTERN_STRENGTH
```
@Deprecated
public static final int PATTERN_STRENGTH
```
    Deprecated. use OutputParameterInfo.DrawingStyle.PATTERN_STRENGTH instead
    
    If value: == 0 - neutral ]0..100] getting bullish ]100..200] bullish [-100..0[ getting bearish [-200..100[ bearish
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - OutputParameterInfo
```
public OutputParameterInfo()
```
    Creates empty parameter description without setting any field
  - OutputParameterInfo
```
public OutputParameterInfo(java.lang.String name,
                           OutputParameterInfo.Type type,
                           int flags)
```
    Deprecated. use OutputParameterInfo(String, Type, DrawingStyle) instead
    
    Creates output parameter descriptor and sets all fields
    
    Parameters:
    
    name - name of the output
    
    type - type of the output
    
    flags - flags of the output
  - OutputParameterInfo
```
public OutputParameterInfo(java.lang.String name,
                           OutputParameterInfo.Type type,
                           OutputParameterInfo.DrawingStyle drawingStyle)
```
    Creates output parameter descriptor and sets all fields.
    
    Parameters:
    
    name - name of the output
    
    type - type of the output
    
    drawingStyle - specifies how to draw this output
  - OutputParameterInfo
```
public OutputParameterInfo(java.lang.String name,
                           OutputParameterInfo.Type type,
                           OutputParameterInfo.DrawingStyle drawingStyle,
                           boolean lastValueOnChart)
```
    Creates output parameter descriptor and sets all fields.
    
    Parameters:
    
    name - name of the output
    
    type - type of the output
    
    drawingStyle - specifies how to draw this output
    
    lastValueOnChart - true to show indicator's last value for this output on chart.
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Returns name of the output
    
    Returns:
    
    name of the output
  - setName
```
public void setName(java.lang.String name)
```
    Sets name of the output
    
    Parameters:
    
    name - name of the output
  - getType
```
public OutputParameterInfo.Type getType()
```
    Returns type of the output
    
    Returns:
    
    type of the output
  - setType
```
public void setType(OutputParameterInfo.Type type)
```
    Sets type of the output
    
    Parameters:
    
    type - type of the output
  - getInstrument
```
public Instrument getInstrument()
```
    Returns instrument of this output, or null if no instrument was set
    
    Returns:
    
    instrument of the output
  - setInstrument
```
public void setInstrument(Instrument instrument)
```
    Sets instrument of this output. This allows indicator to draw values on the secondary instruments of chart
    
    Parameters:
    
    instrument - instrument of the output
  - getFlags
```
public int getFlags()
```
    Deprecated. use getDrawingStyle() instead
    
    Returns flags of the output
    
    Returns:
    
    flags of the output
  - setFlags
```
public void setFlags(int flags)
```
    Deprecated. use setDrawingStyle(DrawingStyle) instead
    
    Sets flags of the output. Use | operator to specify more than one flag
    
    Parameters:
    
    flags - flags of the output
  - getDrawingStyle
```
public OutputParameterInfo.DrawingStyle getDrawingStyle()
```
    Returns style that specifies how to draw this output
    
    Returns:
    
    style that specifies how to draw this output
  - setDrawingStyle
```
public void setDrawingStyle(OutputParameterInfo.DrawingStyle drawingStyle)
```
    Sets style that specifies how to draw this output
    
    Parameters:
    
    drawingStyle - specifies how to draw this output
  - getColor
```
public java.awt.Color getColor()
```
    Returns default color for output or null if no color was set Used as trend up color for outputs with OutputParameterInfo.DrawingStyle.isOutputAsLine() is true
    
    Returns:
    
    default color for output or null
    
    See Also:
    
    getColor2()
  - setColor
```
public void setColor(java.awt.Color color)
```
    Sets default color to use when drawing this output
    
    Parameters:
    
    color - color to draw with
  - getColor2
```
public java.awt.Color getColor2()
```
    Used as trend down color for outputs with OutputParameterInfo.DrawingStyle.isOutputAsLine() is true By default equals to color
    
    Returns:
    
    the color2
    
    See Also:
    
    getColor()
  - setColor2
```
public void setColor2(java.awt.Color color2)
```
    Sets default color used when drawing trend down outputs
    
    Parameters:
    
    color2 - the color2 to set
  - getArrowSymbol
```
public char getArrowSymbol()
```
    Returns arrow character for outputs with OutputParameterInfo.DrawingStyle.ARROW_SYMBOL_UP or OutputParameterInfo.DrawingStyle.ARROW_SYMBOL_DOWN style
    
    Returns:
    
    arrow character
  - setArrowSymbol
```
public void setArrowSymbol(char arrowSymbol)
```
    Sets arrow character for outputs with OutputParameterInfo.DrawingStyle.ARROW_SYMBOL_UP or OutputParameterInfo.DrawingStyle.ARROW_SYMBOL_DOWN style
    
    Parameters:
    
    arrowSymbol - arrow character
  - isHistogramTwoColor
```
public boolean isHistogramTwoColor()
```
    Returns true if histogram should be shown in two colors
    
    Returns:
    
    true if histogram should be shown in two colors
  - setHistogramTwoColor
```
public void setHistogramTwoColor(boolean histogramTwoColor)
```
    If set to true and drawing style is histogram, then it will be shown in two colors, positive values with green and negative with red
    
    Parameters:
    
    histogramTwoColor - if true, then show histogram in two colors
  - getShift
```
public int getShift()
```
    Shifts output by number of candles returned
    
    Returns:
    
    number of candles to shift this output
  - setShift
```
public void setShift(int shift)
```
    Sets number of candles to shift this output
    
    Parameters:
    
    shift - number of candles to shift this output
  - isDrawnByIndicator
```
public boolean isDrawnByIndicator()
```
    Returns true if indicator draws this output itself
    
    Returns:
    
    true if indicator draws this output itself
  - setDrawnByIndicator
```
public void setDrawnByIndicator(boolean drawnByIndicator)
```
    If set to true, than indicator should have public method
    public void drawOutput(Graphics g, int outputIdx, Object values, Color color, IIndicatorDrawingSupport indicatorDrawingSupport, List<Shape> shapes, Map<Color, List<Point>>Map<Color, List<Point>> handles)
    Also it's possible to define
    public double[] getMinMax(int outputIdx, Object values)
    method, that will be called to define minimum and maximum values for scale
    Please look at the description of IIndicator interface for more info
    
    Parameters:
    
    drawnByIndicator - true if indicator draws this output itself
  - isGapAtNaN
```
public boolean isGapAtNaN()
```
    Returns true if drawing logic should make a gap in lines when there is a NaN or Integer.MIN_VALUE in output
    
    Returns:
    
    true for gaps
  - setGapAtNaN
```
public void setGapAtNaN(boolean gapAtNaN)
```
    Set to true to make gaps at candles with Double.NaN or Integer.MIN_VALUE in output
    
    Parameters:
    
    gapAtNaN - true for gaps
  - isShowValueOnChart
```
public boolean isShowValueOnChart()
```
    Checks should last value be specially drawn on chart or not.
    
    Returns:
    
    true to draw the last value, false to not.
  - setShowValueOnChart
```
public void setShowValueOnChart(boolean showValueOnChart)
```
    Defines should last value be specially drawn on chart or not.
    
    Parameters:
    
    showValueOnChart - true to draw the last value, false to not.
  - isShowPopupInfo
```
public boolean isShowPopupInfo()
```
    Checks should tooltip with info appear on mouse over the output or not.
    
    Returns:
    
    true if tooltip should be shown
  - setShowPopupInfo
```
public void setShowPopupInfo(boolean showPopupInfo)
```
    Defines should tooltip with info appear on mouse over the output or not.
    
    Parameters:
    
    showPopupInfo - true of tooltip should be shown
  - isShowOutput
```
public boolean isShowOutput()
```
    Checks should output be drawn or not.
    
    Returns:
    
    true to draw the output, false to not.
  - setShowOutput
```
public void setShowOutput(boolean showOutput)
```
    Defines should output be drawn or not.
    
    Parameters:
    
    showOutput - true to draw the output, false to not.
  - getOpacityAlpha
```
public float getOpacityAlpha()
```
    Returns transparency alpha value
    
    Returns:
    
    transparency alpha value
  - setOpacityAlpha
```
public void setOpacityAlpha(float alpha)
```
    Sets the transparency alpha value
    
    Parameters:
    
    alpha - ranges from 0 to 1
  - getLineWidth
```
public int getLineWidth()
```
    Returns drawing line width
    
    Returns:
    
    drawing line width
  - setLineWidth
```
public void setLineWidth(int lineWidth)
```
    Sets drawing line width
    
    Parameters:
    
    lineWidth - drawing line width
  - getDisplayOrder
```
public int getDisplayOrder()
```
    Returns default display order of indicator output.
    
    Returns:
    
    default display order (-1 if not defined)
  - setDisplayOrder
```
public void setDisplayOrder(int displayOrder)
```
    Sets default display order of indicator output.
    
    Parameters:
    
    displayOrder - default display order

Class OutputParameterInfo

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LINE

DOT_LINE

DASH_LINE

DOT

HISTO

PATTERN_BOOL

PATTERN_BULL_BEAR

PATTERN_STRENGTH

Constructor Detail

OutputParameterInfo

OutputParameterInfo

OutputParameterInfo

OutputParameterInfo

Method Detail

getName

setName

getType

setType

getInstrument

setInstrument

getFlags

setFlags

getDrawingStyle

setDrawingStyle

getColor

setColor

getColor2

setColor2

getArrowSymbol

setArrowSymbol

isHistogramTwoColor

setHistogramTwoColor

getShift

setShift

isDrawnByIndicator

setDrawnByIndicator

isGapAtNaN

setGapAtNaN

isShowValueOnChart

setShowValueOnChart

isShowPopupInfo

setShowPopupInfo

isShowOutput

setShowOutput

getOpacityAlpha

setOpacityAlpha

getLineWidth

setLineWidth

getDisplayOrder

setDisplayOrder