Package com.intellij.openapi.util

Class DimensionService

java.lang.Object

com.intellij.openapi.util.SimpleModificationTracker

com.intellij.openapi.util.DimensionService

All Implemented Interfaces:

PersistentStateComponent<Element>, ModificationTracker

public class DimensionService
extends SimpleModificationTracker
implements PersistentStateComponent<Element>

This class represents map between strings and rectangles. It's intended to store sizes of window, dialogs, etc.

Field Summary

Fields inherited from interface com.intellij.openapi.util.ModificationTracker

EVER_CHANGED, NEVER_CHANGED

Constructor Summary

Constructors

Constructor and Description
DimensionService()

Method Summary

Modifier and Type	Method and Description
static DimensionService	getInstance()
java.awt.Point	getLocation(java.lang.String key)
java.awt.Point	getLocation(java.lang.String key, Project project)
java.awt.Dimension	getSize(java.lang.String key)
java.awt.Dimension	getSize(java.lang.String key, Project project)
Element	getState()
void	loadState(Element element) This method is called when new component state is loaded.
void	setLocation(java.lang.String key, java.awt.Point point) Store specified point under the key.
void	setLocation(java.lang.String key, java.awt.Point point, Project project)
void	setSize(java.lang.String key, java.awt.Dimension size) Store specified size under the key.
void	setSize(java.lang.String key, java.awt.Dimension size, Project project)

Methods inherited from class com.intellij.openapi.util.SimpleModificationTracker

getModificationCount, incModificationCount

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.components.PersistentStateComponent

initializeComponent, noStateLoaded

Constructor Detail

DimensionService

public DimensionService()

Method Detail

getInstance

public static DimensionService getInstance()

getLocation

public java.awt.Point getLocation(java.lang.String key)

Parameters:

key - a String key to perform a query for.

Returns:

point stored under the specified key. The method returns null if there is no stored value under the key. If point is outside of current screen bounds then the method returns null. It properly works in multi-monitor configuration.

Throws:

java.lang.IllegalArgumentException - if key is null.

getLocation

public java.awt.Point getLocation(java.lang.String key,
                                  Project project)

setLocation

public void setLocation(java.lang.String key,
                        java.awt.Point point)

Store specified point under the key. If point is null then the value stored under key will be removed.

Parameters:

key - a String key to store location for.

point - location to save.

Throws:

java.lang.IllegalArgumentException - if key is null.

setLocation

public void setLocation(java.lang.String key,
                        java.awt.Point point,
                        Project project)

getSize

public java.awt.Dimension getSize(java.lang.String key)

Parameters:

key - a String key to perform a query for.

Returns:

point stored under the specified key. The method returns null if there is no stored value under the key.

Throws:

java.lang.IllegalArgumentException - if key is null.

getSize

public java.awt.Dimension getSize(java.lang.String key,
                                  Project project)

setSize

public void setSize(java.lang.String key,
                    java.awt.Dimension size)

Store specified size under the key. If size is null then the value stored under key will be removed.

Parameters:

key - a String key to to save size for.

size - a Size to save.

Throws:

java.lang.IllegalArgumentException - if key is null.

setSize

public void setSize(java.lang.String key,
                    java.awt.Dimension size,
                    Project project)

getState

public Element getState()

Specified by:

getState in interface PersistentStateComponent<Element>

Returns:

a component state. All properties, public and annotated fields are serialized. Only values, which differ from the default (i.e., the value of newly instantiated class) are serialized. null value indicates that the returned state won't be stored, as a result previously stored state will be used.

See Also:

XmlSerializer

loadState

public void loadState(Element element)

Description copied from interface: PersistentStateComponent

This method is called when new component state is loaded. The method can and will be called several times, if config files were externally changed while IDE was running.

State object should be used directly, defensive copying is not required.

Specified by:

loadState in interface PersistentStateComponent<Element>

Parameters:

element - loaded component state

See Also:

XmlSerializerUtil.copyBean(Object, Object)