echopoint.positionable
Interface Clippable

All Known Subinterfaces:

ScrollableContainer

All Known Implementing Classes:

AbstractScrollableComponent, AskScriptNameDialog, AskVariableNameDialog, ComponentInspectorDialog, Dialog, DialogPanel, DropDownBox, DynaColorChooserDialog, DynaQuickSelectFieldDialog, DynaTableSortDialog, GridPanel, HidingSlidingPanel, HorizontalPanel, HtmlTemplatePanel, InsetsEditorDialog, JavaBeanPropertyEditorDialog, JspTemplatePanel, NewsTicker, PickScriptVariableDialog, ScrapDialog, ScrollableBox, ScrollablePanel, ScrollablePanel2, SelectScriptDialog, ServerFileNameDialog, StackTraceViewerDialog, StyleManagerEditStyleDialog, TestDialog, ValidationDialog

public interface Clippable

A Clippable can have a clipping rectangle that can clip the component content to a define shape. The rectangle is in the form x, y, width, height.

Nested Class Summary

static class

Clippable.NestedStyleInfo Nested public static StyleInfo class.

Field Summary

static java.lang.String	CLIP_RECT_CHANGED_PROPERTY This property name is fired when the clip rect changes
static java.lang.String	STYLE_CLIP_RECT A style constant for the Clipping Rect property.

Method Summary

void	applyStyle(Style style)
ClipRect	getClipRect() Returns the clipping rectangle on the component.
void	setClipRect(ClipRect clipRect) Sets the clipping rectangle of the component.
void	setClipRect(int[] clipRect) Sets the clipping rectangle of the component.
void	setClipRect(int x, int y, int width, int height) Sets the clipping rectangle of the component to the specified values

Field Detail

STYLE_CLIP_RECT

static final java.lang.String STYLE_CLIP_RECT

A style constant for the Clipping Rect property. Values of this key must be of type ClipRect

See Also:

Constant Field Values

CLIP_RECT_CHANGED_PROPERTY

static final java.lang.String CLIP_RECT_CHANGED_PROPERTY

This property name is fired when the clip rect changes

See Also:

Constant Field Values

Method Detail

applyStyle

void applyStyle(Style style)

See Also:

Component.applyStyle(nextapp.echo.Style)

setClipRect

void setClipRect(int[] clipRect)

Sets the clipping rectangle of the component. This should be a 4 in array containing the clipping poath.

eg. new int { 2,3,10,15}

If no clipping is required, this should be set to null.

setClipRect

void setClipRect(int x,
                 int y,
                 int width,
                 int height)

Sets the clipping rectangle of the component to the specified values

getClipRect

ClipRect getClipRect()

Returns the clipping rectangle on the component. This can be null or a ClipRect object.

setClipRect

void setClipRect(ClipRect clipRect)

Sets the clipping rectangle of the component. This should be a ClipRect object.

eg. new ClipRect{ 2,3,10,15}

If no clipping is required, this should be set to null.