ilog.server.jsds.swing
Class IlsDSJComponent

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--ilog.server.jsds.swing.IlsDSJComponent
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.swing.TransferHandler.HasGetTransferHandler
Direct Known Subclasses:
IlsPluggableDSJComponent

public class IlsDSJComponent
extends javax.swing.JPanel

The base class for high level UI object.

See Also:
Serialized Form

Inner classes inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
 
Inner classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Inner classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Inner classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
protected  boolean _autoconnect
           
protected  IlsDSComponent _component
           
protected  IlsDataSource _dataSource
           
protected  IlsDataSourceContainer _dataSourceContainer
           
protected  java.lang.String _hostName
           
protected  java.lang.String _label
           
protected  java.lang.String _objectId
           
protected  java.lang.String _serverName
           
protected  java.lang.String _viewId
           
protected  boolean _viewOpened
           
 
Fields inherited from class javax.swing.JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
IlsDSJComponent()
          Instantiate a new IlsDSJComponent with a default IlsDataSourceContainer.
IlsDSJComponent(IlsDataSourceContainer dataSourceContainer)
          Instantiate a new IlsDSJComponent with a predefined IlsDataSourceContainer.
 
Method Summary
 boolean connect()
          Connect the high level UI object to a server and open a dynamic view.
 boolean connect(IlsDSComponent component, java.lang.String objectId, java.lang.String viewId, java.lang.String label)
          Open a dynamic view on a connected component.
 boolean connect(java.lang.String serverName, java.lang.String hostName, java.lang.String objectId, java.lang.String viewId, java.lang.String label)
          Connect the component to a server object and open a dynamic view.
protected  boolean doConnect()
          Do the connection and open a dynamic view with the predefined parameter.
protected  boolean doOpenView()
          Open a dynamic view with the predefined parameter.
protected  void dscOpen(java.util.Map Properties)
          This method is invoked when opening a view and the component has a default container.
protected  void dscPropertiesChange(java.util.Map Properties)
          This method is invoked when properties on the container change and the component has a default container.
 IlsDataSource getDataSource()
          Return the associated data source.
 IlsDataSourceContainer getDataSourceContainer()
          Return the associated data source container.
 IlsDSComponent getDSComponent()
          Return the associated component.
 java.lang.String getHostName()
          Return the host name.
 java.lang.String getLabel()
          Return the origin representation object name of the data source.
 java.lang.String getObjectId()
          Return the declared object server name.
 java.lang.String getServerName()
          Return the server name.
 java.lang.String getViewId()
          Return the dynamic view name.
protected  IlsDataSourceContainer instantiateDataSourceContainer()
           
 boolean isAutoconnect()
          Return true if the component is in auto connect mode.
 boolean openView()
          Open a dynamic view on the connected component.
 void setAutoconnect(boolean autoconnect)
          Set the auto connect mode.
 void setDataSourceContainer(IlsDataSourceContainer dataSourceContainer)
          Set the data source container.
 void setDSComponent(IlsDSComponent component)
          Set the component.
 void setHostName(java.lang.String hostName)
          Set host name of the server.
 void setLabel(java.lang.String label)
          Set the origin representation object name of the data source.
 void setLayout(java.awt.LayoutManager mgr)
          Set the layout manager.
 void setObjectId(java.lang.String objectId)
          Set the declared object server name.
 void setServerName(java.lang.String serverName)
          Set server name.
 void setViewId(java.lang.String viewId)
          Set the dynamic view name to be opened.
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusDownCycle, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

_component

protected IlsDSComponent _component

_viewOpened

protected boolean _viewOpened

_serverName

protected java.lang.String _serverName

_hostName

protected java.lang.String _hostName

_objectId

protected java.lang.String _objectId

_viewId

protected java.lang.String _viewId

_label

protected java.lang.String _label

_autoconnect

protected boolean _autoconnect

_dataSource

protected IlsDataSource _dataSource

_dataSourceContainer

protected IlsDataSourceContainer _dataSourceContainer
Constructor Detail

IlsDSJComponent

public IlsDSJComponent()
Instantiate a new IlsDSJComponent with a default IlsDataSourceContainer.
See Also:
IlsDataSourceContainer

IlsDSJComponent

public IlsDSJComponent(IlsDataSourceContainer dataSourceContainer)
Instantiate a new IlsDSJComponent with a predefined IlsDataSourceContainer.
Parameters:
dataSourceContainer - The predefined container.
See Also:
IlsDataSourceContainer
Method Detail

setLayout

public void setLayout(java.awt.LayoutManager mgr)
Set the layout manager.
Overrides:
setLayout in class java.awt.Container
Parameters:
mgr - The layout manager.

isAutoconnect

public boolean isAutoconnect()
Return true if the component is in auto connect mode.
Returns:
true if the component is in auto connect mode.

setAutoconnect

public void setAutoconnect(boolean autoconnect)
Set the auto connect mode.
Parameters:
autoconnect - The autoconnect mode.

connect

public boolean connect(java.lang.String serverName,
                       java.lang.String hostName,
                       java.lang.String objectId,
                       java.lang.String viewId,
                       java.lang.String label)
Connect the component to a server object and open a dynamic view.
Parameters:
serverName - The server name.
hostName - The host name where the server run.
objectId - The object server name declared on the server.
viewId - The dynamic view name.
label - The origin representation object name of the data source.

connect

public boolean connect(IlsDSComponent component,
                       java.lang.String objectId,
                       java.lang.String viewId,
                       java.lang.String label)
Open a dynamic view on a connected component.
Parameters:
component - The component.
objectId - The object server name declared on the server.
viewId - The dynamic view name.
label - The origin representation object name of the data source.

connect

public boolean connect()
Connect the high level UI object to a server and open a dynamic view. The connection is using the predefined parameter :

openView

public boolean openView()
Open a dynamic view on the connected component. The connection is using the predefined parameter :

doConnect

protected boolean doConnect()
Do the connection and open a dynamic view with the predefined parameter.
See Also:
connect(), openView()

doOpenView

protected boolean doOpenView()
Open a dynamic view with the predefined parameter.
See Also:
openView()

getDSComponent

public IlsDSComponent getDSComponent()
Return the associated component.
Returns:
the associated component.
See Also:
IlsDSComponent

setDSComponent

public void setDSComponent(IlsDSComponent component)
Set the component.
See Also:
IlsDSComponent

getServerName

public java.lang.String getServerName()
Return the server name.
Returns:
the server name.

setServerName

public void setServerName(java.lang.String serverName)
Set server name.
Parameters:
serverName - the server name

getHostName

public java.lang.String getHostName()
Return the host name.
Returns:
the host name.

setHostName

public void setHostName(java.lang.String hostName)
Set host name of the server.
Parameters:
hostName - the host name of the server.

getObjectId

public java.lang.String getObjectId()
Return the declared object server name.
Returns:
the declared object server name.

setObjectId

public void setObjectId(java.lang.String objectId)
Set the declared object server name.
Parameters:
objectId - the object name in the .ils view.

getViewId

public java.lang.String getViewId()
Return the dynamic view name.
Returns:
the dynamic view name.

setViewId

public void setViewId(java.lang.String viewId)
Set the dynamic view name to be opened.
Parameters:
viewId - the name of the dynamic view.

getLabel

public java.lang.String getLabel()
Return the origin representation object name of the data source.
Returns:
the origin representation object name of the data source.

setLabel

public void setLabel(java.lang.String label)
Set the origin representation object name of the data source.
Parameters:
label - the name of the representation object in the .ils view.

getDataSource

public IlsDataSource getDataSource()
Return the associated data source.
Returns:
the associated data source.

getDataSourceContainer

public IlsDataSourceContainer getDataSourceContainer()
Return the associated data source container.
Returns:
the associated data source container.

setDataSourceContainer

public void setDataSourceContainer(IlsDataSourceContainer dataSourceContainer)
Set the data source container.
Parameters:
dataSourceContainer - The data source container.
See Also:
IlsDataSourceContainer

dscOpen

protected void dscOpen(java.util.Map Properties)
This method is invoked when opening a view and the component has a default container.
See Also:
IlsDataSourceContainer.open(ilog.server.jsds.IlsDSRepresentation, java.util.Map)

dscPropertiesChange

protected void dscPropertiesChange(java.util.Map Properties)
This method is invoked when properties on the container change and the component has a default container.
See Also:
IlsDataSourceContainer.propertiesChange(ilog.server.jsds.IlsDSRepresentation, java.util.Map)

instantiateDataSourceContainer

protected IlsDataSourceContainer instantiateDataSourceContainer()