com.alkacon.geranium.client.ui

Class HighlightingBorder

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.Composite

com.alkacon.geranium.client.ui.HighlightingBorder

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsRenderable, com.google.gwt.user.client.ui.IsWidget

public class HighlightingBorder
extends com.google.gwt.user.client.ui.Composite

A Widget to display a highlighting border around a specified position.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HighlightingBorder.BorderColor Enumeration of available border colours.

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields

Modifier and Type	Field and Description
protected com.google.gwt.dom.client.DivElement	m_borderBottom The bottom border.
protected com.google.gwt.dom.client.DivElement	m_borderLeft The left border.
protected com.google.gwt.dom.client.DivElement	m_borderRight The right border.
protected com.google.gwt.dom.client.DivElement	m_borderTop The top border.

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
HighlightingBorder(com.google.gwt.user.client.Element positioningParent, HighlightingBorder.BorderColor color) Constructor.
HighlightingBorder(int height, int width, int positionLeft, int positionTop, HighlightingBorder.BorderColor color) Constructor.
HighlightingBorder(PositionBean position, HighlightingBorder.BorderColor color) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	hide() Hides the border.
void	resetPosition() Recalculates the position and dimension when a positioning parent is given.
void	setPosition(int height, int width, int positionLeft, int positionTop) Sets the border position.
void	setPosition(PositionBean position) Sets the border position.
void	show() Shows the border.

Methods inherited from class com.google.gwt.user.client.ui.Composite

claimElement, getWidget, initializeClaimedElement, initWidget, isAttached, onAttach, onBrowserEvent, onDetach, render, render, resolvePotentialElement, setWidget

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object

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

Field Detail

m_borderBottom

@UiField
protected com.google.gwt.dom.client.DivElement m_borderBottom

The bottom border.

m_borderLeft

@UiField
protected com.google.gwt.dom.client.DivElement m_borderLeft

The left border.

m_borderRight

@UiField
protected com.google.gwt.dom.client.DivElement m_borderRight

The right border.

m_borderTop

@UiField
protected com.google.gwt.dom.client.DivElement m_borderTop

The top border.

Constructor Detail

HighlightingBorder

public HighlightingBorder(com.google.gwt.user.client.Element positioningParent,
                  HighlightingBorder.BorderColor color)

Constructor.

Parameters:

positioningParent - the element the border is positioned around, position is set relative to it

color - the border color

HighlightingBorder

public HighlightingBorder(int height,
                  int width,
                  int positionLeft,
                  int positionTop,
                  HighlightingBorder.BorderColor color)

Constructor.

Parameters:

height - the height

width - the width

positionLeft - the absolute left position

positionTop - the absolute top position

color - the border color

HighlightingBorder

public HighlightingBorder(PositionBean position,
                  HighlightingBorder.BorderColor color)

Constructor.

Parameters:

position - the position data

color - the border color

Method Detail

hide

public void hide()

Hides the border.

resetPosition

public void resetPosition()

Recalculates the position and dimension when a positioning parent is given.

setPosition

public void setPosition(int height,
               int width,
               int positionLeft,
               int positionTop)

Sets the border position.

Parameters:

height - the height

width - the width

positionLeft - the absolute left position

positionTop - the absolute top position

setPosition

public void setPosition(PositionBean position)

Sets the border position.

Parameters:

position - the position data

show

public void show()

Shows the border.