oracle.forms.demos.bigraph
Class FormsGraph

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--oracle.ewt.lwAWT.LWComponent
                    |
                    +--oracle.ewt.lwAWT.LWContainer
                          |
                          +--oracle.forms.ui.VBean
                                |
                                +--oracle.forms.demos.bigraph.FormsGraph
All Implemented Interfaces:
javax.accessibility.Accessible, oracle.ewt.lwAWT.DoubleBufferer, oracle.ewt.help.HelpCapable, java.awt.image.ImageObserver, oracle.ewt.lwAWT.ImmediatePainter, oracle.forms.ui.IView, oracle.ewt.lwAWT.KeyProcessor, java.awt.MenuContainer, java.io.Serializable, oracle.ewt.lwAWT.VirtualComponent

public class FormsGraph
extends oracle.forms.ui.VBean

FormsGraph is a charting client for Oracle9i Forms, including the BI Bean Graph component to Forms. This sample does not expose all of the functionality provided by the BI Graph Bean, but as much as was possible with Oracle Graphics, the previous charting solution used within Forms.

FormsGraph can be used in multiple instances, each running in a Bean Container managed by Forms. Mouse Click events are passed back to Forms firing the when-custom-item-event trigger so that interactive charts as well as drill down and master/detail relationships are within the control of the Forms application developer.

version 1.0 Review

See Also:
Serialized Form

Inner classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Inner classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent
 
Field Summary
 int allData
           
 int dataColumn
           
 int dataLabel
           
 int dataPrimKey
           
 int dataValue
           
protected static oracle.forms.properties.ID eGetDelimiter
          Property registered to get information about the delimiter
static oracle.forms.properties.ID eGetSeriesCount
          Event registered to inform about the number of series (columns) shown in a graph.
static oracle.forms.properties.ID eGraphAction
          Custom Item Event raised by mouse click on the graph.
 int noData
           
protected static oracle.forms.properties.ID pAddDataToGraph
          Show the data in the Graph clearing out existing data
protected static oracle.forms.properties.ID pAddRowData
          Forms property used to to add a data row in the Graph.
protected static oracle.forms.properties.ID pAlignTitleText
          Property registered to determine the alignment for the title, subtitle and footnote text.
protected static oracle.forms.properties.ID pClearGraph
          Forms property registered to reset the Forms Graph.
protected static oracle.forms.properties.ID pDebug
          Forms registered property to enable Debug message (TRUE/FALSE).
protected static oracle.forms.properties.ID pDelimiterInfo
          property registered to obtain the delimiter sign
protected static oracle.forms.properties.ID pEnableTooltips
          Property registered to disable/enable tooltips.
protected static oracle.forms.properties.ID pExplodePieSLice
          Forms registered property to explode a specific slice, for example '3,30' to explode the fourth slice by 30 points.
protected static oracle.forms.properties.ID pFramePos
          Forms property registered to define the xy-position of the separate frame.
protected static oracle.forms.properties.ID pGetDelimiter
          property registered to retrieve the current delimiter String. The response is a Forms custom event firing, passing the new delimiter string as an argument
protected static oracle.forms.properties.ID pGraph
          Forms property registered to make the Graph display inside of the Forms Bean Container.
static oracle.forms.properties.ID pGraphInfo
          Property registered to obtain information about graph component that the user clicked on
protected static oracle.forms.properties.ID pGraphInFrame
          Forms property registered to make the Graph Display show in a separate frame.
protected static oracle.forms.properties.ID pGraphType
          Forms property registered to define the type of the Graph displayed.
protected static oracle.forms.properties.ID pHideFrame
          Forms property registered to hide the external frame Used with SET_CUSTOM_PROPERTY() from the Form
protected static oracle.forms.properties.ID pHideGraph
          Property registered to hide the graph.
protected static oracle.forms.properties.ID pModifyData
          property registered to update a column or slice in a graph.
protected static oracle.forms.properties.ID pMouseAction
          property registered to enable/disable mouse action [true/false].
protected static oracle.forms.properties.ID pPositionLegendArea
          Property registered to position the legend area in a screen.
protected static oracle.forms.properties.ID pRemoveData
          property registered to remove a data row currently displayed in the graph. If the graph contains a primary key then this also gets deleted from the data store.
protected static oracle.forms.properties.ID pRemoveFooter
          properties registered to hide the footer if set
protected static oracle.forms.properties.ID pRemoveSubTitle
          properties registered to hide the sub_titles if set
protected static oracle.forms.properties.ID pRemoveTitle
          properties registered to hide the graph title if set
protected static oracle.forms.properties.ID pRemoveX_Title
          properties registered to hide the x axis label if set
protected static oracle.forms.properties.ID pRemoveY_Title
          properties registered to hide the y axis label title if set
protected static oracle.forms.properties.ID pReturnValues
          property registered to define return values of a mouseclick on a graph. Allowed arguments are "ALL", "ROWLABEL", "COLUMNLABEL","VALUE","PRIMARY_KEY".
protected static oracle.forms.properties.ID pScrollBar
          Property registered to display a scrollbar on the Graph if needed.
protected static oracle.forms.properties.ID pSeriesCount
          Used with SET_CUSTOM_PROPERTY() from the Form, retrieves the number of columns in a graph Column means the group of data displayed: Columns e.g.
protected static oracle.forms.properties.ID pSetBackgroundColor
          Forms property registered to set the graph background color.
protected static oracle.forms.properties.ID pSetBaseline
          Property registered to set the graph's baseline to a value other than 0. Use this property if you want to show the variance a graph column has from a specific reference point.
protected static oracle.forms.properties.ID pSetDebugPrefix
          property registered to set a prefix string to the debug message produced by the bean. This is useful if running multiple instances of this bean in one Forms application. In this case it is useful to know which bean wrotes the output when looking in the Java console
protected static oracle.forms.properties.ID pSetDelimiter
          Forms property registered to set the delimiting character for data passed as string. The default delimiter is a comma but there are situations where it must be changed, like when setting the title, which includes the color Used with SET_CUSTOM_PROPERTY() from the Form
protected static oracle.forms.properties.ID pSetDepth
          property registered to define the depth of a graph and the orientation of this depth.
protected static oracle.forms.properties.ID pSetFooterBackgroundColor
          property registered to set the background color of the subtitle footer text field.
protected static oracle.forms.properties.ID pSetFootnote
          property registered to set the graph Footer title, font, font style, font size and color.
protected static oracle.forms.properties.ID pSetFrameWidthAndHeight
          property registered to set the width and hight for the external Graph frame.
protected static oracle.forms.properties.ID pSetLegendBorder
          property registered to set the border and background color of the legend shown in a graph.
protected static oracle.forms.properties.ID pSetLineGraphMarkers
          property registered to show hide value markers in Line graphs. Use 'true' to switch this feature on and 'false' to switch it off.
protected static oracle.forms.properties.ID pSetNoDataFoundMessage
          Property registered to set the message shown when no data is provided for the graph to render.
protected static oracle.forms.properties.ID pSetPlotAreaColor
          Property registered to set the color of the Plot Area.
protected static oracle.forms.properties.ID pSetScaledLogarithmic
          property registered to logarithmic scale the Y and X Axis. Pass the axis identifier, true or false to symbolize whether logarithmic scale is enabled and the base.
protected static oracle.forms.properties.ID pSetSubTitle
          property registered to set the graph Sub title, font, font style, font size and color.
protected static oracle.forms.properties.ID pSetSubTitleBackgroundColor
          property registered to set the background color of the subtitle title text field.
protected static oracle.forms.properties.ID pSetTitle
          property registered to set the graph title, font, font style, font size and color,  expecting the following string format title string,color,fontstyle,font size,fontname.
protected static oracle.forms.properties.ID pSetTitleBackgroundColor
          property registered to set the background color of the title text field.
protected static oracle.forms.properties.ID pSetXLabel
          property registered to set the x-Axis title
protected static oracle.forms.properties.ID pSetYLabel
          property registered to set the y-Axis title
protected static oracle.forms.properties.ID pShowColumnsAsRows
          Forms property registered to show columns as rows and rows a columns in the Graph.
protected static oracle.forms.properties.ID pShowFrame
          Forms property registered to show the external frame Graph.
protected static oracle.forms.properties.ID pShowGrid
          Property registered to show/hide the grid in a graph. The default value is set to true, use false to hide the graph from showing
protected static oracle.forms.properties.ID pShowLabels
          Forms property registered to show/hide the labels shown on the x and y axis.
protected static oracle.forms.properties.ID pShowLegend
          Forms property registered to show/hide the graph legend.
protected  int returnValueSelection
           
protected  boolean showGraphAsSeries
           
 
Fields inherited from class oracle.forms.ui.VBean
BEAN_NAME, DEBUG_MODE, DELIVER_EVENT, FOCUS_EVENT, KEY_EVENT
 
Fields inherited from class oracle.ewt.lwAWT.LWComponent
DEFAULT_BORDERPAINTER, DEFAULT_COLOR, DEFAULT_FONT, DEFAULT_PAINTER, MNEMONIC_CHAR_NONE, MNEMONIC_INDEX_NONE
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface oracle.forms.ui.IView
DEFAULT_COLOR
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
FormsGraph()
           
 
Method Summary
protected  void DebugMessage(java.lang.String dm)
           
protected  void dispatchMouseAction(java.lang.String msg)
           
 java.lang.String getDelimiter()
          getDelimiter returns the actual string used to separate values passed in a string.
 java.lang.Object[] getTitleFromString(java.lang.String in)
          public Object[] getTitleFromString(String in) takes a delimited string and creates a title string, a Font value and a Color value of it.
 void init(oracle.forms.handler.IHandler handler)
          Implementation of IView interface.
 void setDelimiter(java.lang.String delm)
           
 boolean setProperty(oracle.forms.properties.ID _ID, java.lang.Object _object)
          Implementation of IView interface which sets a requested property to a given value
 
Methods inherited from class oracle.forms.ui.VBean
add, addCustomListener, addListener, addNotify, destroy, dispatchCustomEvent, getBean, getHandler, getProperty, initializeBean, remove, removeAll, removeCustomListener, removeListener, repaint
 
Methods inherited from class oracle.ewt.lwAWT.LWContainer
getBorderPainter, setBorderPainter
 
Methods inherited from class oracle.ewt.lwAWT.LWComponent
accessAccessibleContext, addAnyEventListener, addImpl, addPostKeyListener, addPreKeyListener, clipToParents, contains, convertInnerToOuterSize, convertInteriorToOuter, convertOuterToInterior, createAccessibleContext, disable, doLayout, enable, eventMatchesMnemonic, eventMatchesMnemonic, freezeRepaints, getAccessibleContext, getActualAlignment, getActualReadingDirection, getAlignment, getBackground, getBaseClassName, getBorderContext, getBorderInsets, getClientProperty, getColorScheme, getDefaultHelpProvider, getDefaultName, getDocumentSize, getDoubleBuffer, getEWTDropTarget, getFill, getFocusedComponent, getFont, getForeground, getGraphics, getHelpBook, getHelpProvider, getHelpTopic, getInnerBounds, getInnerHeight, getInnerOrigin, getInnerSize, getInnerWidth, getInsets, getInteriorAlignmentX, getInteriorAlignmentY, getInvalidateFlags, getLookAndFeel, getMnemonicChar, getMnemonicIndex, getMnemonicString, getName, getPageBounds, getPaintContext, getPaintData, getPaintState, getPrintPaintContext, getReadingDirection, getRepaintFlags, getToolTipValue, getUI, getUIClassID, getUIDefaults, hasFocus, hasGlobalFocus, hasMnemonicModifier, hasWindowFocus, hide, imageUpdate, insets, interiorContains, invalidate, invalidateAndRepaintIfNecessary, isActive, isBorderTransparent, isChildClipped, isClippedBySibling, isFocusTraversable, isInteriorTransparent, isLocaleDefaulted, isPaintPropagationRequired, isReadingDirectionDefaulted, isTransparent, paint, paintAll, paintImmediate, paintImmediate, paintImmediateInterior, paintImmediateInterior, paintImmediateUnclipped, paintInterior, paintOverChildren, paramString, pointInInterior, pointIsInChild, postProcessKey, print, printAll, printPage, processEvent, processEventImpl, processFocusEvent, processMouseEvent, putClientProperty, redispatchEvent, remove, removeAnyEventListener, removeClientProperty, removeNotify, removePostKeyListener, removePreKeyListener, repaint, repaintInterior, repaintInterior, reshape, setAlignment, setBackground, setColorScheme, setDefaultHelpProvider, setEnabled, setEWTDropTarget, setFill, setFont, setForeground, setHelpBook, setHelpProvider, setHelpTopic, setLocale, setLookAndFeel, setMnemonicChar, setMnemonicIndex, setReadingDirection, setToolTipValue, setToolTipValue, setUI, setVisible, shiftFrozenDamage, showHelp, unfreezeRepaints, update, updateAlignment, updateLocale, updateReadingDirection, updateUI, updateUI, updateUI
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, countComponents, deliverEvent, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, getListeners, getMaximumSize, getMinimumSize, getPreferredSize, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, remove, removeContainerListener, setLayout, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addPropertyChangeListener, addPropertyChangeListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, getBounds, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFontMetrics, getGraphicsConfiguration, getHeight, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocation, getLocationOnScreen, getParent, getPeer, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, inside, isDisplayable, isDoubleBuffered, isEnabled, isLightweight, isOpaque, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, postEvent, prepareImage, prepareImage, processComponentEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseMotionEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface oracle.forms.ui.IView
contains, paint
 
Methods inherited from interface oracle.ewt.lwAWT.VirtualComponent
getBounds, getSize
 

Field Detail

showGraphAsSeries

protected boolean showGraphAsSeries

allData

public final int allData

dataLabel

public final int dataLabel

dataColumn

public final int dataColumn

dataValue

public final int dataValue

dataPrimKey

public final int dataPrimKey

noData

public final int noData

returnValueSelection

protected int returnValueSelection

pAddRowData

protected static final oracle.forms.properties.ID pAddRowData
Forms property used to to add a data row in the Graph. If Graph Data exists, then the new row is appended. A row contains columns data which are separated by a defined delimiter. The default delimiter is ",", custom delimiters can be set using the Forms property SET_DELIMITER in a call to SET_CUSTOM_PROPERTY(). Used with SET_CUSTOM_PROPERTY() from the Form. Syntax: e.g 'SAL,SMITH,1200,7750'

Forms Example:

set_custom_property('BeanArea',1,'ADD_ROWDATA','SAL,SMTITH,1200);

or, if a primarey key needs to be passed

set_custom_property('BeanArea',1,'ADD_ROWDATA','SAL,SMTITH,1200,7765);

pAddDataToGraph

protected static final oracle.forms.properties.ID pAddDataToGraph
Show the data in the Graph clearing out existing data

Forms Example:

set_custom_property('BeanArea',1,'ADD_DATA_TO_GRAPH','');

pAlignTitleText

protected static final oracle.forms.properties.ID pAlignTitleText
Property registered to determine the alignment for the title, subtitle and footnote text. The allowed values are "LEFT", "RIGHT" and "CENTER". One property call can be used to set all title alignments. The following attribute syntax sets the title first, then the subtitle and at lst the footnote 'title=CENTER,subtitle=LEFT,footnote=CENTER'. The delimiter by default it a comma (',') if not set other using the SET_DELIMITER property. Values can be omitted. For example. If the alignment should be set for the title and subtitle only, then the following syntax is valid 'title=CENTER,subtitle=LEFT'

Forms Example:

set_custom_property('BeanArea',1,'ALIGN_TITLE_TEXT','title=CENTER,subtitle=LEFT');

pClearGraph

protected static final oracle.forms.properties.ID pClearGraph
Forms property registered to reset the Forms Graph. Clearing the Graph empties the data cache of the graph. All data will be removed from the internal Graph store

Forms Example:

set_custom_property('BeanArea',1,'CLEAR_GRAPH','');

pDebug

protected static final oracle.forms.properties.ID pDebug
Forms registered property to enable Debug message (TRUE/FALSE). Arguments passed are either "TRUE" or "FALSE" to switch on/off verbose debug messages to system out.

Forms Example:

set_custom_property('BeanArea',1,'DEBUG','TRUE');

pEnableTooltips

protected static final oracle.forms.properties.ID pEnableTooltips
Property registered to disable/enable tooltips. By default no tooltips are shown, the following Attributes are supported if provided with the set_custom_property() call in Forms "ALL" - show detail information (default) "LABELS" - labels only "VALUES" - show data values only "NONE" - show no tooltips

Forms Example:

set_custom_property('BeanArea',1,'ENABLE_TOOLTIPS','ALL');

pExplodePieSLice

protected static final oracle.forms.properties.ID pExplodePieSLice
Forms registered property to explode a specific slice, for example '3,30' to explode the fourth slice by 30 points. Specifies how far the slices for the series are exploded. Exploded slices are pulled apart from the rest of the pie that they belong to. The values range from 0 to 100.

Forms Example:

set_custom_property('BeanArea',1,'EXPLODE_PIESLICE','2,60');

pFramePos

protected static final oracle.forms.properties.ID pFramePos
Forms property registered to define the xy-position of the separate frame. The value passed is defined in Pixel and must be passed as integer. The attribute value is of kind ' , where the delimiter by default is a comma Used with SET_CUSTOM_PROPERTY() from the Form

Forms Example:

set_custom_property('BeanArea',1,'FRAME_POS','100,200');

pGraphType

protected static final oracle.forms.properties.ID pGraphType
Forms property registered to define the type of the Graph displayed. HORIZONTAL_BAR,HORIZONTAL_BAR_2Y,VERTICAL_BAR,VERTICAL_BAR_2Y, VERTICAL_STACKED_BAR,HORIZONTAL_STACKED_BAR, VERTICAL_PERCENT_BAR, HORIZONTAL_PERCENT_BAR,VERTICAL_LINE_GRAPH, HORIZONTAL_LINE_GRAPH, RING_BAR VERTICAL_STACKED_LINE_GRAPH, HORIZONTAL_STACKED_LINE_GRAPH,VERTICAL_LINE_SPLIT_GRAPH,VERTICAL_AREA_GRAPH, VERTICAL_PERCENT_AREA_GRAPH, VERTICAL_STACKED_AREA_GRAPH,PIE_GRAPH,PIE_BAR_GRAPH,MULTI_PIE_GRAPH,STOCK_HIGHLOW_GRAPH,MULTI_PIE_PROPORTIONAL_GRAPH,MULTI_RING_PROPORTIONAL_GRAPH, MULTI_RING_GRAPH,3D_BAR_GRAPH, 3D_AREA_GRAPH, RADAR

Forms Example:

set_custom_property('BeanArea',1,'GRAPHTYPE','PIE_BAR_GRAPH');

pGraphInFrame

protected static final oracle.forms.properties.ID pGraphInFrame
Forms property registered to make the Graph Display show in a separate frame. This is to be used with Forms Bean Containers of a minimum size of 1x1 Pixel. If the Bean Container is chosen bigger, then the container will be empty if running the Graph in an external frame. Used with SET_CUSTOM_PROPERTY() from the Form. The Frame title can be passed as an argument with the call

Forms Example:

set_custom_property('BeanArea',1,'SHOW_GRAPH_IN_FRAME','');

pGraph

protected static final oracle.forms.properties.ID pGraph
Forms property registered to make the Graph display inside of the Forms Bean Container. The Graph resizes itself to fit into the size defined by the Bean Container. The window title can be set by the attribute passed with the Forms call to SET_CUSTOM_PROPERTY() Used with SET_CUSTOM_PROPERTY() from the Form

Forms Example:

set_custom_property('BeanArea',1,'SHOW_GRAPH','');

pHideFrame

protected static final oracle.forms.properties.ID pHideFrame
Forms property registered to hide the external frame Used with SET_CUSTOM_PROPERTY() from the Form

Forms Example:

set_custom_property('BeanArea',1,'HIDE_FRAME','');

pHideGraph

protected static final oracle.forms.properties.ID pHideGraph
Property registered to hide the graph. Useful if no data is displayed in the graph. The BI Graph Bean uses internal test data if no data is set by the relational API. In a master detail situation this is the case if no detail data is selected. To avoid confusion the Graph can be hidden by this command. The Graphs automatically displays when data is provided

Forms Example:

set_custom_property('BeanArea',1,'HIDE_GRAPH','');

pMouseAction

protected static final oracle.forms.properties.ID pMouseAction
property registered to enable/disable mouse action [true/false]. Setting mouse action to false produces less network traffic because the Forms client does not check with the server for a response to a mouse event (click)

Forms Example:

set_custom_property('BeanArea',1,'MOUSEACTION','false');

pModifyData

protected static final oracle.forms.properties.ID pModifyData
property registered to update a column or slice in a graph. This allows a partial graph update without refreshing all data in the graph

Forms Example:

set_custom_property('BeanArea',1,'MODIFY_ROW_DATA','ColumnName,RowName,OldValue,NewValue');

pPositionLegendArea

protected static final oracle.forms.properties.ID pPositionLegendArea
Property registered to position the legend area in a screen. Use TOP, LEFT, RIGHT, BOTTOM or AUTO as an argument when calling set_custom_property The default behavior of the Graph Bean though is to auto layout the legend according to the space left

Forms Example:

set_custom_property('BeanArea',1,'POSITION_LEGEND','LEFT');

pSetBackgroundColor

protected static final oracle.forms.properties.ID pSetBackgroundColor
Forms property registered to set the graph background color. The color must be passed as sRGB color in a comma separated string, with the specified red, green, and blue values in the range (0 - 255), e.g. '255,255,255' for white. Basic colors: black, blue, cyan, darkGray, gray, green, lightGray, magenta, orange, pink, red, white can be passed in clear text. Used with SET_CUSTOM_PROPERTY() from the Form

Forms Example:

set_custom_property('BeanArea',1,'SET_BACKGROUND','120,234,123');

pSetDelimiter

protected static final oracle.forms.properties.ID pSetDelimiter
Forms property registered to set the delimiting character for data passed as string. The default delimiter is a comma but there are situations where it must be changed, like when setting the title, which includes the color Used with SET_CUSTOM_PROPERTY() from the Form

Forms Example:

set_custom_property('BeanArea',1,'SET_DELIMITER','#');

pSetLineGraphMarkers

protected static final oracle.forms.properties.ID pSetLineGraphMarkers
property registered to show hide value markers in Line graphs. Use 'true' to switch this feature on and 'false' to switch it off.

Forms Example:

set_custom_property('BeanArea',1,'SET_LINEGRAPH_MARKER','true');

pSetScaledLogarithmic

protected static final oracle.forms.properties.ID pSetScaledLogarithmic
property registered to logarithmic scale the Y and X Axis. Pass the axis identifier, true or false to symbolize whether logarithmic scale is enabled and the base. The delimiter must match the currently defined delimiter, which is by default ','.

Forms Example:

set_custom_property('BeanArea',1,'SET_SCALED_LOGARITHMIC','Y,true,2');

or

set_custom_property('BeanArea',1,'SET_SCALED_LOGARITHMIC','X,true');

In above example the Y axis is defined as scaled logarithmic with a base of 2. The base is provided as a double value. Note that there is always only one axis that shows the value of the graph. The ability to set the X-Axis to a logarithmic scale is for all horizontal graphs, while setting logarithmic scale to the Y axis is for all vertical graphs


pSetBaseline

protected static final oracle.forms.properties.ID pSetBaseline
Property registered to set the graph's baseline to a value other than 0. Use this property if you want to show the variance a graph column has from a specific reference point. The new baseline value is passed as a double value from Forms

Forms Example:

set_custom_property('BeanArea',1,'SET_GRAPH_BASELINE','2000');

to reset

set_custom_property('BeanArea',1,'SET_GRAPH_BASELINE','0');

pGetDelimiter

protected static final oracle.forms.properties.ID pGetDelimiter
property registered to retrieve the current delimiter String. The response is a Forms custom event firing, passing the new delimiter string as an argument

Forms Example:

set_custom_property('BeanArea',1,'GET_DELIMITER','');

pShowGrid

protected static final oracle.forms.properties.ID pShowGrid
Property registered to show/hide the grid in a graph. The default value is set to true, use false to hide the graph from showing

Forms Example:

set_custom_property('BeanArea',1,'SHOW_GRID','false');

pRemoveData

protected static final oracle.forms.properties.ID pRemoveData
property registered to remove a data row currently displayed in the graph. If the graph contains a primary key then this also gets deleted from the data store. The data row to delete is identified by the match of columns name, row name and value

Forms Example:

set_custom_property('BeanArea',1,'REMOVE_DATA','ColumnName,RowName,value');

pRemoveTitle

protected static final oracle.forms.properties.ID pRemoveTitle
properties registered to hide the graph title if set

Forms Example:

set_custom_property('BeanArea',1,'HIDE_TITLE','');

pRemoveSubTitle

protected static final oracle.forms.properties.ID pRemoveSubTitle
properties registered to hide the sub_titles if set

Forms Example:

set_custom_property('BeanArea',1,'HIDE_SUBTITLE','');

pRemoveFooter

protected static final oracle.forms.properties.ID pRemoveFooter
properties registered to hide the footer if set

Forms Example:

set_custom_property('BeanArea',1,'HIDE_FOOTER','');

pRemoveX_Title

protected static final oracle.forms.properties.ID pRemoveX_Title
properties registered to hide the x axis label if set

Forms Example:

set_custom_property('BeanArea',1,'HIDE_X_TITLE','');

pRemoveY_Title

protected static final oracle.forms.properties.ID pRemoveY_Title
properties registered to hide the y axis label title if set

Forms Example:

set_custom_property('BeanArea',1,'HIDE_Y_TITLE','');

pReturnValues

protected static final oracle.forms.properties.ID pReturnValues
property registered to define return values of a mouseclick on a graph. Allowed arguments are "ALL", "ROWLABEL", "COLUMNLABEL","VALUE","PRIMARY_KEY". The primary is returned only if it was passed using the ADD_ROW_DATA property

Forms Example:

--Forms example for a master/detail Graph. Code added to the WHEN-CUSTOM-EVENT Trigger

-- on the PJC.MASTERGRAPH

set_custom_property('BeanArea',1,'RETURN_VALUES_ON_CLICK','ALL');

to retrieve the result in Forms:

DECLARE

  eventName varchar2(30) := :system.custom_item_event;

  tempString varchar2(100);

  eventValues ParamList;

  eventValueType number;

BEGIN

IF (eventName='GRAPH_ACTION') THEN

   eventValues := get_parameter_list(:system.custom_item_event_parameters);

   get_parameter_attr(eventValues,'GRAPH_INFO',eventValueType, tempString);

   FORMSGRAPHSAMPLE.clearData('PJC.DETAILGRAPH');

   FORMSGRAPHSAMPLE.populateDetailGraphData('PJC.DETAILGRAPH',tempString,',');

ELSE

   null;

END IF;

END;


pScrollBar

protected static final oracle.forms.properties.ID pScrollBar
Property registered to display a scrollbar on the Graph if needed. Set value to true for enabling the scrollbar (default) or false to disable the scrollbar. The default is false as this feature is only required when too many columns are shown that cannot be displayed in the current graph

Forms Example:

set_custom_property('BeanArea',1,'SCROLLBAR','true');

pSetDepth

protected static final oracle.forms.properties.ID pSetDepth
property registered to define the depth of a graph and the orientation of this depth. Specify both values in one call, where the fist value determines the depth and the second the radius. The delimiter is the actual delimiter defined or ',' if choosing the default. To se a depth of 20 pixel and a radius of 10 degrees, set the attribute value of this Forms property to '20,10' (if the default delimiter id used). Allowable rage of degrees are from 0 - 180

Forms Example:

set_custom_property('BeanArea',1,'SET_DEPTH','30,75');

pSetDebugPrefix

protected static final oracle.forms.properties.ID pSetDebugPrefix
property registered to set a prefix string to the debug message produced by the bean. This is useful if running multiple instances of this bean in one Forms application. In this case it is useful to know which bean wrotes the output when looking in the Java console

Forms Example:

set_custom_property('BeanArea',1,'SET_DEBUG_PREFIX','Bean1');

pSetFrameWidthAndHeight

protected static final oracle.forms.properties.ID pSetFrameWidthAndHeight
property registered to set the width and hight for the external Graph frame. The size is passed in as a string representing two integers delimited by the delimiter used (default ','); e.g. 200,300 where the first value always represents the height.

Forms Example:

set_custom_property('BeanArea',1,'SET_FRAME_HEIGHT_WIDTH','200,300');

pSetTitle

protected static final oracle.forms.properties.ID pSetTitle
property registered to set the graph title, font, font style, font size and color,  expecting the following string format title string,color,fontstyle,font size,fontname. For example to set a Subtitle to "Hello World", the Font to TimesNewRoman, the font style to bold [b] and italic [i] and the color to red the string shows: 'Hello World,red,bi,10,TimesNewRoman' The color can be specified as color name or as a sRGB value in a range from (0..255). Values can be omitted from right to left.

Forms Example:

BEGIN

  -- the color is defined with comma separated rgb values. Thus the default delimiter

  -- must be changed temporarily. Alos set the font type to bold and italic (bi)

  SET_CUSTOM_PROPERTY('PJC.SIMPLEGRAPH',1,'SET_DELIMITER','#');

  SET_CUSTOM_PROPERTY('PJC.SIMPLEGRAPH',1,'SET_TITLE','Hello World#120,234,120#bi#12');

  SET_CUSTOM_PROPERTY('PJC.SIMPLEGRAPH',1,'SET_DELIMITER',',');

END;


pSetNoDataFoundMessage

protected static final oracle.forms.properties.ID pSetNoDataFoundMessage
Property registered to set the message shown when no data is provided for the graph to render. This is the case whenever a master-detail relationship does not have detail data If the message text is about to contain commas then define a new delimiter before and reset it after.

Forms Example:

set_custom_property('BeanArea',1,'SET_NO_DATA_FOUND','Sorry - we are out of data today');

pSetLegendBorder

protected static final oracle.forms.properties.ID pSetLegendBorder
property registered to set the border and background color of the legend shown in a graph. The color can be provided as an rgb value e.g. 120,234,22 or as a name e.g. red, orange, green The first value passed is for the border, the second for the background. '120,200,222|223,223,222' If one or both setting should be transparent, then pass 'TRANSPARENT' as a color name. E.g. 'Transparent|123,334,22'. Note that in this case the default delimiter must be changed since the color coding requires ',' as a delimiter

Forms Example:

set_custom_property('BeanArea',1,'SET_LEGEND_BORDER','blue,yellow');

pSeriesCount

protected static final oracle.forms.properties.ID pSeriesCount
Used with SET_CUSTOM_PROPERTY() from the Form, retrieves the number of columns in a graph Column means the group of data displayed: Columns e.g. are SAL, COMM, REVENUE

Forms Example:

set_custom_property('BeanArea',1,'COLUMNCOUNT','');

In a when-custom-item-event trigger

DECLARE    eventName varchar2(30) := :system.custom_item_event;    tempString varchar2(100);

BEGIN

   IF (eventName='RETURNED_COLUMN_NUMBER') THEN

  eventValues := get_parameter_list(:system.custom_item_event_parameters);

  get_parameter_attr(eventValues,'GRAPH_INFO',eventValueType, tempString);

   ...

END;


pSetSubTitle

protected static final oracle.forms.properties.ID pSetSubTitle
property registered to set the graph Sub title, font, font style, font size and color. The following string format is expected

"title string,color,font style,font size,font"

For example to set a Subtitle to "Hello World", the Font to TimesNewRoman, the font style to bold [b] and italic [i] and the color to red the string shows:

'Hello World,red,bi,10,TimesNewRoman'

The color can be specified as color name or as a sRGB value in a range from (0..255). Values can be omitted from right to left. Passing color values as RGB values may require switching the default delimiter as the comma must be used to set RGB values

Forms Example:

set_custom_property('BeanArea',1,'SET_SUBTITLE','Hello World,red,bi,10,TimesNewRoman');

or

set_custom_property('BeanArea',1,'SET_DELIMITER','#');

set_custom_property('BeanArea',1,'SET_SUBTITLE','Hello World#120,234,120#bi#10#TimesNewRoman');

set_custom_property('BeanArea',1,'SET_DELIMITER',',');


pSetFootnote

protected static final oracle.forms.properties.ID pSetFootnote
property registered to set the graph Footer title, font, font style, font size and color. The following string format is expected

"title string,color,font style,font size,font"

For example to set a Subtitle to "Hello World", the Font to TimesNewRoman, the font style to bold [b] and italic [i] and the color to red the string shows:

'Hello World,red,bi,10,TimesNewRoman'

The color can be specified as color name or as a sRGB value in a range from (0..255). Values can be omitted from right to left. Passing color values as RGB values may require switching the default delimiter as the comma must be used to set RGB values

Forms Example:

set_custom_property('BeanArea',1,'SET_FOOTER','Hello World,red,bi,10,TimesNewRoman');

or

set_custom_property('BeanArea',1,'SET_DELIMITER','#');

set_custom_property('BeanArea',1,'SET_FOOTER','Hello World#120,234,120#bi#10#TimesNewRoman');

set_custom_property('BeanArea',1,'SET_DELIMITER',',');


pSetPlotAreaColor

protected static final oracle.forms.properties.ID pSetPlotAreaColor
Property registered to set the color of the Plot Area. If not set then the area is chosen to be white. The color must be passed as RGB color in a comma separated string, with the specified red, green, and blue values in the range (0 - 255), e.g. '255,255,255' for white. Basic colors: black, blue, cyan, darkGray, gray,green, lightGray, magenta, orange, pink, red, white can be passed in clear text.

Forms Example:

set_custom_property('BeanArea',1,'SET_PLOT_AREA_COLOR','255,255,255');


pSetTitleBackgroundColor

protected static final oracle.forms.properties.ID pSetTitleBackgroundColor
property registered to set the background color of the title text field. Normally you want that color be set to the same value then the background, but sometimes having this appear in a different color may make sense. The color must be passed as RGB color in a comma separated string, with the specified red, green, and blue values in the range (0 - 255), e.g. '255,255,255' for white. Basic colors: black, blue, cyan, darkGray, gray, green, lightGray, magenta, orange, pink, red, white can be passed in clear text.

Forms Example:

set_custom_property('BeanArea',1,'SET_TITLE_BACKGROUND','255,255,255');


pSetSubTitleBackgroundColor

protected static final oracle.forms.properties.ID pSetSubTitleBackgroundColor
property registered to set the background color of the subtitle title text field. Normally you want that color be set to the same value then the background, but sometimes having this appear in a different color may make sense. The color must be passed as RGB color in a comma separated string, with the specified red, green, and blue values in the range (0 - 255), e.g. '255,255,255' for white. Basic colors: black, blue, cyan, darkGray, gray, green, lightGray, magenta, orange, pink, red, white can be passed in clear text.

Forms Example:

set_custom_property('BeanArea',1,'SET_SUBTITLE_BACKGROUND','255,255,255');


pSetFooterBackgroundColor

protected static final oracle.forms.properties.ID pSetFooterBackgroundColor
property registered to set the background color of the subtitle footer text field. Normally you want that color be set to the same value then the background, but sometimes having this appear in a different color may make sense. The color must be passed as RGB color in a comma separated string, with the specified red, green, and blue values in the range (0 - 255), e.g. '255,255,255' for white. Basic colors: black, blue, cyan, darkGray, gray, green, lightGray, magenta, orange, pink, red, white can be passed in clear text.

Forms Example:

set_custom_property('BeanArea',1,'SET_FOOTER_BACKGROUND','255,255,255');


pSetXLabel

protected static final oracle.forms.properties.ID pSetXLabel
property registered to set the x-Axis title

Forms Example:

set_custom_property('BeanArea',1,'SET_X_LABEL','Hello World X');


pSetYLabel

protected static final oracle.forms.properties.ID pSetYLabel
property registered to set the y-Axis title

Forms Example:

set_custom_property('BeanArea',1,'SET_Y_LABEL','Hello World Y');


pShowColumnsAsRows

protected static final oracle.forms.properties.ID pShowColumnsAsRows
Forms property registered to show columns as rows and rows a columns in the Graph. If specifying the argument passed as "true" then the columns will show as series data and the rows as group data. To switch this presentation back to normal mode, call the same property again and pass "false" as an argument.

Forms Example:

set_custom_property('BeanArea',1,'SHOW_COLUMNS_AS_ROWS','true');


pShowFrame

protected static final oracle.forms.properties.ID pShowFrame
Forms property registered to show the external frame Graph. This feature is used when running the Graph in an external frame to the Forms window. It is to unhide a frame that previously was hidden.

Forms Example:

set_custom_property('BeanArea',1,'SHOW_FRAME','');


pShowLabels

protected static final oracle.forms.properties.ID pShowLabels
Forms property registered to show/hide the labels shown on the x and y axis. Labels are shown by default, to hide labels pass a value of false with the argument of the Forms property. Use the following syntax: 'x=false,y1=true' to show labels for the y1 axis but to hide labels for the x axis. You can omit the outer right value if no change is needed e.g. 'x=true'. The delimiter by default is a ',' if not overwritten using the SET_DELIMITER property

Forms Example:

set_custom_property('BeanArea',1,'SHOW_LABELS','x=false,y=true');


pShowLegend

protected static final oracle.forms.properties.ID pShowLegend
Forms property registered to show/hide the graph legend. Attribute value to be passed 'true' to show the legend (default) 'false' to hide

Forms Example:

set_custom_property('BeanArea',1,'SHOW_LEGEND','true');


eGetSeriesCount

public static final oracle.forms.properties.ID eGetSeriesCount
Event registered to inform about the number of series (columns) shown in a graph. The event is caught in a when-custom-item event trigger on the Bean Container

Forms Example:

...

IF (eventName='RETURNED_COLUMN_NUMBER') THEN

  eventValues := get_parameter_list(:system.custom_item_event_parameters);

  get_parameter_attr(eventValues,'GRAPH_INFO',eventValueType, tempString);

  ...


eGraphAction

public static final oracle.forms.properties.ID eGraphAction
Custom Item Event raised by mouse click on the graph. Note that this event wont work if pMouseAction is set to false. The event is caught in a when-custom-item event trigger on the Bean Container

Forms Example:

...

IF (eventName='GRAPH_ACTION') THEN

  eventValues := get_parameter_list(:system.custom_item_event_parameters);

  get_parameter_attr(eventValues,'GRAPH_INFO',eventValueType, tempString);

  ...


pGraphInfo

public static final oracle.forms.properties.ID pGraphInfo
Property registered to obtain information about graph component that the user clicked on

eGetDelimiter

protected static final oracle.forms.properties.ID eGetDelimiter
Property registered to get information about the delimiter

pDelimiterInfo

protected static final oracle.forms.properties.ID pDelimiterInfo
property registered to obtain the delimiter sign
Constructor Detail

FormsGraph

public FormsGraph()
Method Detail

init

public void init(oracle.forms.handler.IHandler handler)
Implementation of IView interface. Init is called when the bean is first instanciated
Overrides:
init in class oracle.forms.ui.VBean
See Also:
IView

setProperty

public boolean setProperty(oracle.forms.properties.ID _ID,
                           java.lang.Object _object)
Implementation of IView interface which sets a requested property to a given value
Overrides:
setProperty in class oracle.forms.ui.VBean
Parameters:
_ID - property to be set.
_object - value of the property id.
Returns:
true if the property could be set, false otherwise.
See Also:
IView

DebugMessage

protected void DebugMessage(java.lang.String dm)

dispatchMouseAction

protected void dispatchMouseAction(java.lang.String msg)

setDelimiter

public void setDelimiter(java.lang.String delm)

getDelimiter

public java.lang.String getDelimiter()
getDelimiter returns the actual string used to separate values passed in a string. There is a need, e.g. for color values passed for a title string, to change the delimiter.
Returns:
String

getTitleFromString

public java.lang.Object[] getTitleFromString(java.lang.String in)
public Object[] getTitleFromString(String in) takes a delimited string and creates a title string, a Font value and a Color value of it. The delimiter used is the defined delimiter stored in sDelimiter, or ',' as the default. The String syntax is ',<color>,<[b][i]>,<size>,<Font Name>' Values can be omitted from right to left, e.g '<Title>,<color>,<[b][i]>,<size>' or '<Title>,<color>,<[b][i]>'</DL> <!-- ========= END OF CLASS DATA ========= --> <HR> <!-- ========== START OF NAVBAR ========== --> <A NAME="navbar_bottom"><!-- --></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_bottom_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">  PREV CLASS   <A HREF="../../../../oracle/forms/demos/bigraph/graphTypeRegistry.html"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>    <A HREF="FormsGraph.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY:  <A HREF="#inner_classes_inherited_from_class_java.awt.Container">INNER</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL:  <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <!-- =========== END OF NAVBAR =========== --> <HR> </BODY> </HTML>