com.ontimize.util.gis.client.gui.panels
Class BasicToolbar

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              com.ontimize.util.gis.client.gui.panels.BasicToolbar

All Implemented Interfaces:

com.ontimize.gui.field.FormComponent, com.ontimize.gui.field.IdentifiedElement, com.ontimize.gui.i18n.Internationalization, com.ontimize.gui.SecureElement, IGisClientComponent, IGisToolbar, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class BasicToolbar
extends javax.swing.JComponent
implements IGisToolbar, IGisClientComponent, com.ontimize.gui.field.FormComponent, com.ontimize.gui.field.IdentifiedElement, com.ontimize.gui.i18n.Internationalization

Gis client component used to add a tool bar panel over the gis map viewer component.

This panel will show a group of buttons aligned vertically. This toolbar contains a default group
of buttons. This buttons are:

• Zoom In (zoomIn)
• Zoom Out (zoomOut)
• Panning (pan)
• Select (select)
• Edit (edit)
• Distance measurement (distanceMeasure)

Example code to add the basic gis toolbar panel into a gis component:

<com.ontimize.util.gis.client.gui.OGisComponent
   attr="exampleComponent" layersconf="exampleConf">
    <com.ontimize.util.gis.client.gui.panels.BasicToolbar attr="gisToolbar" />    
</com.ontimize.util.gis.client.gui.OGisComponent>

Xml definition parameters:

Name	Description	Required
attr	Component attribute	Yes
actions	Basic actions list	No
edition	Edition enabled	No

In the previous example the toolbar will contain all the defalt buttons in it.
In order to show only a group of the default buttons use the parameter actions
To disable the edition button (enabled by default) use the parameter edition="no".

For example, to set only visible the zoom buttons and the pan button
the xml definition code will be:

<com.ontimize.util.gis.client.gui.OGisComponent
   attr="exampleComponent" layersconf="exampleConf">
    <com.ontimize.util.gis.client.gui.panels.BasicToolbar
    	attr="gisToolbar" actions="zoomIn;zoomOut;pan" edition="no"/>
</com.ontimize.util.gis.client.gui.OGisComponent>

It is possible to add new buttons to the current toolbar by using the class BasicToolbarButton:

<com.ontimize.util.gis.client.gui.OGisComponent
   attr="exampleComponent" layersconf="exampleConf">
    <com.ontimize.util.gis.client.gui.panels.BasicToolbar attr="gisToolbar">
        <com.ontimize.util.gis.client.gui.panels.components.BasicToolbarButton
        attr="bgetinfobutton" text="getInfo"
        icon="com/ontimize/gui/images/brush.png" />
    </com.ontimize.util.gis.client.gui.panels.BasicToolbar>
</com.ontimize.util.gis.client.gui.OGisComponent>

See Also:

BasicToolbarButton, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces 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 static java.lang.String	actions
protected static java.lang.String	attrDistance
protected static java.lang.String	attrEdit
protected java.lang.Object	attribute
protected static java.lang.String	attrPan
protected static java.lang.String	attrZoomIn
protected static java.lang.String	attrZoomOut
protected boolean	borderButtons
protected BasicToolbarButton	buttonEdit
protected static int	buttonHeight
(package private) java.lang.String[]	buttonNames
protected java.util.List<BasicToolbarButton>	buttons
protected int	buttonWidth
protected boolean	editionEnabled
protected boolean	enabled
protected IGisViewer	gisViewer
protected boolean	highlightButtons
protected java.lang.String	iconDistance
protected java.lang.String	iconEdit
protected java.lang.String	iconPan
protected java.lang.String	iconZoomIn
protected java.lang.String	iconZoomOut
protected static int	initialButtonWidth
protected static int	initialUpperLeftY
protected java.awt.event.MouseListener	listenerHighlightButtons
protected boolean	modifiable
protected boolean	modified
protected MeasurePanel	mPanel
protected boolean	opaqueBoolean
protected boolean	opaqueButtons
protected int	paintState
protected int	prevViewerState
protected boolean	required
protected static java.lang.String	textDistance
protected static java.lang.String	textEdit
protected static java.lang.String	textPan
protected static java.lang.String	textZoomIn
protected static java.lang.String	textZoomOut
protected int	upperLeftX
protected int	upperLeftY
protected java.lang.Object	value

Fields inherited from class javax.swing.JComponent

accessibleContext, 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

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface com.ontimize.gui.field.FormComponent

DEBUG

Fields inherited from interface com.ontimize.gui.i18n.Internationalization

DEBUG_LANGUAGE

Fields inherited from interface com.ontimize.gui.SecureElement

DESACTIVATE_COMPONENT_BY_PERMISSION_TIP

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

BasicToolbar(java.util.Hashtable parameters)

Method Summary

void	add(java.awt.Component comp, java.lang.Object constraints)
protected void	addActionElement(java.lang.String name)
void	addSeparator() Add a separator to the current toolbar
void	addToolbarButton(BasicToolbarButton button) Add a new button to the toolbar
protected void	adjustButtonsWidth()
void	deleteData()
void	disableOuterPanel()
java.lang.Object	getAttribute()
BasicToolbarButton	getButton(java.lang.Object buttonAttr) Get the toolbar button reference
java.util.List<BasicToolbarButton>	getButtons() Get a list with the complete toolbar buttons references
java.awt.Rectangle	getComponentLimits() Get the component drawing limits, since the component it's not painted on all the extension of the panel.
java.lang.Object	getConstraints(java.awt.LayoutManager layoutManager)
java.lang.String	getLabelComponentText()
int	getSQLDataType()
java.util.Vector	getTextsToTranslate()
java.lang.Object	getValue()
void	init(java.util.Hashtable params)
void	initPermissions()
boolean	isEmpty()
boolean	isEnabled()
boolean	isHidden()
boolean	isModifiable()
boolean	isModified()
boolean	isRequired()
boolean	isRestricted()
protected void	paintChildren(java.awt.Graphics g)
protected void	paintComponent(java.awt.Graphics g)
void	setBackground(java.awt.Color color)
void	setComponentLocale(java.util.Locale locale)
void	setEnabled(boolean enabled)
void	setGisViewer(IGisViewer gisViewer) Set the gis viewer instance for the actual component
void	setModifiable(boolean modifiable)
void	setRequired(boolean required)
void	setResourceBundle(java.util.ResourceBundle res)
void	setValue(java.lang.Object value)
void	setVisible(boolean visible) Sets the component visible

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, 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, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintImmediately, paintImmediately, paramString, 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, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

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, setLayout, transferFocusBackward, 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, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, 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, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

actions

protected static java.lang.String actions

attrZoomIn

protected static java.lang.String attrZoomIn

attrZoomOut

protected static java.lang.String attrZoomOut

attrPan

protected static java.lang.String attrPan

attrDistance

protected static java.lang.String attrDistance

attrEdit

protected static java.lang.String attrEdit

textZoomIn

protected static java.lang.String textZoomIn

textZoomOut

protected static java.lang.String textZoomOut

textPan

protected static java.lang.String textPan

textDistance

protected static java.lang.String textDistance

textEdit

protected static java.lang.String textEdit

iconPan

protected java.lang.String iconPan

iconZoomIn

protected java.lang.String iconZoomIn

iconZoomOut

protected java.lang.String iconZoomOut

iconDistance

protected java.lang.String iconDistance

iconEdit

protected java.lang.String iconEdit

modifiable

protected boolean modifiable

modified

protected boolean modified

required

protected boolean required

value

protected java.lang.Object value

enabled

protected boolean enabled

attribute

protected java.lang.Object attribute

opaqueBoolean

protected boolean opaqueBoolean

opaqueButtons

protected boolean opaqueButtons

highlightButtons

protected boolean highlightButtons

borderButtons

protected boolean borderButtons

listenerHighlightButtons

protected java.awt.event.MouseListener listenerHighlightButtons

paintState

protected int paintState

buttons

protected java.util.List<BasicToolbarButton> buttons

editionEnabled

protected boolean editionEnabled

prevViewerState

protected int prevViewerState

mPanel

protected MeasurePanel mPanel

buttonEdit

protected BasicToolbarButton buttonEdit

gisViewer

protected IGisViewer gisViewer

buttonHeight

protected static int buttonHeight

initialUpperLeftY

protected static int initialUpperLeftY

initialButtonWidth

protected static int initialButtonWidth

upperLeftX

protected int upperLeftX

upperLeftY

protected int upperLeftY

buttonWidth

protected int buttonWidth

buttonNames

java.lang.String[] buttonNames

Constructor Detail

BasicToolbar

public BasicToolbar(java.util.Hashtable parameters)
             throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

add

public void add(java.awt.Component comp,
                java.lang.Object constraints)

Overrides:

add in class java.awt.Container

getConstraints

public java.lang.Object getConstraints(java.awt.LayoutManager layoutManager)

Specified by:

getConstraints in interface com.ontimize.gui.field.FormComponent

disableOuterPanel

public void disableOuterPanel()

addActionElement

protected void addActionElement(java.lang.String name)

init

public void init(java.util.Hashtable params)
          throws java.lang.Exception

Specified by:

init in interface com.ontimize.gui.field.FormComponent

Throws:

java.lang.Exception

getTextsToTranslate

public java.util.Vector getTextsToTranslate()

Specified by:

getTextsToTranslate in interface com.ontimize.gui.i18n.Internationalization

setComponentLocale

public void setComponentLocale(java.util.Locale locale)

Specified by:

setComponentLocale in interface com.ontimize.gui.i18n.Internationalization

setResourceBundle

public void setResourceBundle(java.util.ResourceBundle res)

Specified by:

setResourceBundle in interface com.ontimize.gui.i18n.Internationalization

adjustButtonsWidth

protected void adjustButtonsWidth()

getAttribute

public java.lang.Object getAttribute()

Specified by:

getAttribute in interface com.ontimize.gui.field.IdentifiedElement

initPermissions

public void initPermissions()

Specified by:

initPermissions in interface com.ontimize.gui.SecureElement

isRestricted

public boolean isRestricted()

Specified by:

isRestricted in interface com.ontimize.gui.SecureElement

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface com.ontimize.gui.field.FormComponent

Overrides:

isEnabled in class java.awt.Component

setEnabled

public void setEnabled(boolean enabled)

Specified by:

setEnabled in interface com.ontimize.gui.field.FormComponent

Overrides:

setEnabled in class javax.swing.JComponent

setVisible

public void setVisible(boolean visible)

Description copied from interface: IGisClientComponent

Sets the component visible

Specified by:

setVisible in interface com.ontimize.gui.field.FormComponent

Specified by:

setVisible in interface IGisClientComponent

Overrides:

setVisible in class javax.swing.JComponent

paintComponent

protected void paintComponent(java.awt.Graphics g)

Overrides:

paintComponent in class javax.swing.JComponent

paintChildren

protected void paintChildren(java.awt.Graphics g)

Overrides:

paintChildren in class javax.swing.JComponent

getComponentLimits

public java.awt.Rectangle getComponentLimits()

Description copied from interface: IGisClientComponent

Get the component drawing limits, since the component it's not painted on all the extension of the panel. This method is used principally in events management

Specified by:

getComponentLimits in interface IGisClientComponent

Returns:

component painting area

setGisViewer

public void setGisViewer(IGisViewer gisViewer)

Description copied from interface: IGisClientComponent

Set the gis viewer instance for the actual component

Specified by:

setGisViewer in interface IGisClientComponent

Parameters:

gisViewer - Gis viewer instanceof

addToolbarButton

public void addToolbarButton(BasicToolbarButton button)

Description copied from interface: IGisToolbar

Add a new button to the toolbar

Specified by:

addToolbarButton in interface IGisToolbar

Parameters:

button - New toolbar button

getButton

public BasicToolbarButton getButton(java.lang.Object buttonAttr)

Description copied from interface: IGisToolbar

Get the toolbar button reference

Specified by:

getButton in interface IGisToolbar

Parameters:

buttonAttr - Toolbar button attribute

Returns:

Resquested toolbar button

getButtons

public java.util.List<BasicToolbarButton> getButtons()

Description copied from interface: IGisToolbar

Get a list with the complete toolbar buttons references

Specified by:

getButtons in interface IGisToolbar

Returns:

Toolbar buttons list

addSeparator

public void addSeparator()

Description copied from interface: IGisToolbar

Add a separator to the current toolbar

Specified by:

addSeparator in interface IGisToolbar

setBackground

public void setBackground(java.awt.Color color)

Overrides:

setBackground in class javax.swing.JComponent

deleteData

public void deleteData()

getLabelComponentText

public java.lang.String getLabelComponentText()

getSQLDataType

public int getSQLDataType()

getValue

public java.lang.Object getValue()

isEmpty

public boolean isEmpty()

isHidden

public boolean isHidden()

isModifiable

public boolean isModifiable()

isModified

public boolean isModified()

isRequired

public boolean isRequired()

setModifiable

public void setModifiable(boolean modifiable)

setRequired

public void setRequired(boolean required)

setValue

public void setValue(java.lang.Object value)