Package com.intellij.designer.model

Class RadComponent

java.lang.Object

com.intellij.designer.model.PropertiesContainer

com.intellij.designer.model.RadComponent

Direct Known Subclasses:

RadVisualComponent

public abstract class RadComponent
extends PropertiesContainer

Field Summary

Fields

Modifier and Type	Field and Description
protected MetaModel	myMetaModel

Constructor Summary

Constructors

Constructor and Description
RadComponent()

Method Summary

Modifier and Type	Method and Description
void	accept(RadComponentVisitor visitor, boolean forward)
void	acceptChildren(RadComponentVisitor visitor, boolean forward)
void	add(RadComponent component, RadComponent insertBefore)
static void	addError(RadComponent component, ErrorInfo errorInfo)
void	addSelectionActions(DesignerEditorPanel designer, DefaultActionGroup actionGroup, javax.swing.JComponent shortcuts, java.util.List<RadComponent> selection)
void	addStaticDecorators(java.util.List<StaticDecorator> decorators, java.util.List<RadComponent> selection)
boolean	canDelete()
static void	clearErrors(RadComponent component)
java.awt.Point	convertPoint(java.awt.Component relativeFrom, int x, int y) Returns the point in the model coordinate space (see getBounds()) given a coordinate x, y in the given Swing component.
void	copyTo(Element parentElement)
void	delete()
<T> T	extractClientProperty(java.lang.String key)
java.awt.Dimension	fromModel(java.awt.Component target, java.awt.Dimension size) Converts the given rectangle (in model coordinates) to coordinates in the given target component's coordinate system.
java.awt.Point	fromModel(java.awt.Component target, java.awt.Point point) Converts the given point (in model coordinates) to coordinates in the given target component's coordinate system.
java.awt.Rectangle	fromModel(java.awt.Component target, java.awt.Rectangle rectangle) Converts the given rectangle (in model coordinates) to coordinates in the given target component's coordinate system.
java.awt.Rectangle	getBounds() Returns the bounds of this RadComponent in the model.
java.awt.Rectangle	getBounds(java.awt.Component relativeTo) Returns the bounds of this RadComponent in the coordinate system of the given Swing component.
ICaption	getCaption()
java.util.List<RadComponent>	getChildren()
protected java.util.List<RadComponent>	getChildrenForAccept(RadComponentVisitor visitor)
<T> T	getClientProperty(java.lang.String key)
InputTool	getDragTracker(java.awt.Point location, java.awt.event.InputEvent event, boolean isTree)
static java.util.List<ErrorInfo>	getError(RadComponent component)
java.util.List<Property>	getInplaceProperties()
RadLayout	getLayout()
RadLayoutData	getLayoutData()
MetaModel	getMetaModel()
MetaModel	getMetaModelForProperties()
RadComponent	getParent()
<T extends RadComponent> T	getParent(java.lang.Class<T> clazz)
static java.util.Set<RadComponent>	getParents(java.util.List<? extends RadComponent> components)
java.util.List<Property>	getProperties()
java.util.List<Property>	getProperties(java.lang.String key)
java.lang.String	getPropertyValue(java.lang.String name)
static java.util.List<RadComponent>	getPureSelection(java.util.List<RadComponent> selection)
RadComponent	getRoot()
java.lang.Object[]	getTreeChildren()
static java.util.Map<RadComponent,java.util.List<RadComponent>>	groupSiblings(java.util.List<? extends RadComponent> components) Partitions the given list of components into a map where each value is a list of siblings, in the same order as in the original list, and where the keys are the parents (or null for the components that do not have a parent).
boolean	isAncestorFor(RadComponent component, boolean strict)
boolean	isBackground() Whether this view is considered to be the background.
static boolean	isParentsContainedIn(java.util.List<RadComponent> components, RadComponent component)
boolean	isSameType(RadComponent other) Returns true if this component is of the same logical type as the given other component.
RadComponent	morphingTo(MetaModel target)
void	processDropOperation(OperationContext context)
void	remove(RadComponent component)
void	removeFromParent()
void	setClientProperty(java.lang.Object key, java.lang.Object value)
void	setLayout(RadLayout layout)
void	setMetaModel(MetaModel metaModel)
void	setParent(RadComponent parent)
java.awt.Dimension	toModel(java.awt.Component source, java.awt.Dimension size) Converts the given size (in coordinates relative to the given component) into the equivalent size in model coordinates.
java.awt.Point	toModel(java.awt.Component source, java.awt.Point point) Converts the given point (in coordinates relative to the given component) into the equivalent point in model coordinates.
java.awt.Rectangle	toModel(java.awt.Component source, java.awt.Rectangle rectangle) Converts the given rectangle (in coordinates relative to the given component) into the equivalent rectangle in model coordinates.
RadComponent	wrapIn(MetaModel target)

Methods inherited from class java.lang.Object

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

Field Detail

myMetaModel

protected MetaModel myMetaModel

Constructor Detail

RadComponent

public RadComponent()

Method Detail

getMetaModel

public MetaModel getMetaModel()

getMetaModelForProperties

public MetaModel getMetaModelForProperties()
                                    throws java.lang.Exception

Throws:

java.lang.Exception

setMetaModel

public void setMetaModel(MetaModel metaModel)

getRoot

public RadComponent getRoot()

getParent

public final RadComponent getParent()

getParent

public final <T extends RadComponent> T getParent(java.lang.Class<T> clazz)

setParent

public final void setParent(RadComponent parent)

getChildren

public java.util.List<RadComponent> getChildren()

getTreeChildren

public java.lang.Object[] getTreeChildren()

add

public void add(RadComponent component,
                RadComponent insertBefore)

remove

public void remove(RadComponent component)

removeFromParent

public void removeFromParent()

isBackground

public boolean isBackground()

Whether this view is considered to be the background. This can for example return true for the root layout, such that marquee selection, and Select All, will not include it in marquee selection or select all operations.

Returns:

true if this view should be considered part of the background

isSameType

public boolean isSameType(RadComponent other)

Returns true if this component is of the same logical type as the given other component. This is used to for example select "Select Same Type".

getBounds

public java.awt.Rectangle getBounds()

Returns the bounds of this RadComponent in the model.

Caller should not modify this rectangle.

Returns:

the bounds of this RadComponent in the model coordinate system (e.g. unaffected by a view zoom for example)

getBounds

public java.awt.Rectangle getBounds(java.awt.Component relativeTo)

Returns the bounds of this RadComponent in the coordinate system of the given Swing component. This will scale the coordinates if the view is zoomed (see DesignerEditorPanel.zoom(com.intellij.designer.designSurface.ZoomType)) and will apply any relative position offsets of views in the hierarchy between the two components.

Returns a new Rectangle, so callers are free to modify the result.

Parameters:

relativeTo - the component whose coordinate system the model bounds should be shifted and scaled into

Returns:

the bounds of this RadComponent in the given coordinate system

fromModel

public java.awt.Rectangle fromModel(java.awt.Component target,
                                    java.awt.Rectangle rectangle)

Converts the given rectangle (in model coordinates) to coordinates in the given target component's coordinate system. The model coordinate system refers to the same coordinate system as the bounds returned by getBounds().

This means that calling getBounds(java.awt.Component) is equivalent to calling this method and passing in getBounds().

Returns a new Rectangle, so callers are free to modify the result.

Parameters:

target - the component whose coordinate system the rectangle should be translated into

rectangle - the model rectangle to convert

Returns:

the rectangle converted to the coordinate system of the target

toModel

public java.awt.Rectangle toModel(java.awt.Component source,
                                  java.awt.Rectangle rectangle)

Converts the given rectangle (in coordinates relative to the given component) into the equivalent rectangle in model coordinates.

Returns a new Rectangle, so callers are free to modify the result.

Parameters:

source - the component which defines the coordinate system of the rectangle

rectangle - the rectangle to be converted into model coordinates

Returns:

the rectangle converted to the model coordinate system

fromModel

public java.awt.Point fromModel(java.awt.Component target,
                                java.awt.Point point)

Converts the given point (in model coordinates) to coordinates in the given target component's coordinate system. The model coordinate system refers to the same coordinate system as the bounds returned by getBounds().

Returns a new Point, so callers are free to modify the result.

Parameters:

target - the component whose coordinate system the point should be translated into

point - the model point to convert

Returns:

the point converted to the coordinate system of the target

toModel

public java.awt.Point toModel(java.awt.Component source,
                              java.awt.Point point)

Converts the given point (in coordinates relative to the given component) into the equivalent point in model coordinates.

Returns a new Point, so callers are free to modify the result.

Parameters:

source - the component which defines the coordinate system of the point

point - the point to be converted into model coordinates

Returns:

the point converted to the model coordinate system

fromModel

public java.awt.Dimension fromModel(java.awt.Component target,
                                    java.awt.Dimension size)

Converts the given rectangle (in model coordinates) to coordinates in the given target component's coordinate system. The model coordinate system refers to the same coordinate system as the bounds returned by getBounds().

Returns a new Dimension, so callers are free to modify the result.

Parameters:

target - the component whose coordinate system the dimension should be translated into

size - the model dimension to convert

Returns:

the size converted to the coordinate system of the target

toModel

public java.awt.Dimension toModel(java.awt.Component source,
                                  java.awt.Dimension size)

Converts the given size (in coordinates relative to the given component) into the equivalent size in model coordinates.

Returns a new Dimension, so callers are free to modify the result.

Parameters:

source - the component which defines the coordinate system of the size

size - the dimension to be converted into model coordinates

Returns:

the size converted to the model coordinate system

convertPoint

public java.awt.Point convertPoint(java.awt.Component relativeFrom,
                                   int x,
                                   int y)

Returns the point in the model coordinate space (see getBounds()) given a coordinate x, y in the given Swing component.

Returns a new Point, so callers are free to modify the result.

Parameters:

relativeFrom - the component whose coordinate system defines the rectangle

x - the x coordinate of the point

y - the y coordinate of the point

Returns:

a corresponding Point in the model coordinate system

getDragTracker

public InputTool getDragTracker(java.awt.Point location,
                                java.awt.event.InputEvent event,
                                boolean isTree)

processDropOperation

public void processDropOperation(OperationContext context)

addStaticDecorators

public void addStaticDecorators(java.util.List<StaticDecorator> decorators,
                                java.util.List<RadComponent> selection)

addSelectionActions

public void addSelectionActions(DesignerEditorPanel designer,
                                DefaultActionGroup actionGroup,
                                javax.swing.JComponent shortcuts,
                                java.util.List<RadComponent> selection)

getCaption

public ICaption getCaption()

getLayout

public RadLayout getLayout()

setLayout

public void setLayout(RadLayout layout)

getLayoutData

public RadLayoutData getLayoutData()

getProperties

public java.util.List<Property> getProperties()

Specified by:

getProperties in class PropertiesContainer

getProperties

public java.util.List<Property> getProperties(java.lang.String key)

getPropertyValue

public java.lang.String getPropertyValue(java.lang.String name)

getInplaceProperties

public java.util.List<Property> getInplaceProperties()
                                              throws java.lang.Exception

Throws:

java.lang.Exception

getClientProperty

public final <T> T getClientProperty(java.lang.String key)

extractClientProperty

public final <T> T extractClientProperty(java.lang.String key)

setClientProperty

public final void setClientProperty(java.lang.Object key,
                                    java.lang.Object value)

accept

public void accept(RadComponentVisitor visitor,
                   boolean forward)

acceptChildren

public void acceptChildren(RadComponentVisitor visitor,
                           boolean forward)

getChildrenForAccept

protected java.util.List<RadComponent> getChildrenForAccept(RadComponentVisitor visitor)

canDelete

public boolean canDelete()

delete

public void delete()
            throws java.lang.Exception

Throws:

java.lang.Exception

copyTo

public void copyTo(Element parentElement)
            throws java.lang.Exception

Throws:

java.lang.Exception

morphingTo

public RadComponent morphingTo(MetaModel target)
                        throws java.lang.Exception

Throws:

java.lang.Exception

wrapIn

public RadComponent wrapIn(MetaModel target)
                    throws java.lang.Exception

Throws:

java.lang.Exception

getError

public static java.util.List<ErrorInfo> getError(RadComponent component)

addError

public static void addError(RadComponent component,
                            ErrorInfo errorInfo)

clearErrors

public static void clearErrors(RadComponent component)

groupSiblings

public static java.util.Map<RadComponent,java.util.List<RadComponent>> groupSiblings(java.util.List<? extends RadComponent> components)

Partitions the given list of components into a map where each value is a list of siblings, in the same order as in the original list, and where the keys are the parents (or null for the components that do not have a parent).

The value lists will never be empty. The parent key will be null for components without parents.

Parameters:

components - the components to be grouped

Returns:

a map from parents (or null) to a list of components with the corresponding parent

getParents

public static java.util.Set<RadComponent> getParents(java.util.List<? extends RadComponent> components)

isParentsContainedIn

public static boolean isParentsContainedIn(java.util.List<RadComponent> components,
                                           RadComponent component)

getPureSelection

public static java.util.List<RadComponent> getPureSelection(java.util.List<RadComponent> selection)

isAncestorFor

public boolean isAncestorFor(RadComponent component,
                             boolean strict)