0001: // @@
0002: // @@
0003: /*
0004: * Wi.Ser Framework
0005: *
0006: * Version: 1.8.1, 20-September-2007
0007: * Copyright (C) 2005 Dirk von der Weiden <dvdw@imail.de>
0008: *
0009: * This library is free software; you can redistribute it and/or
0010: * modify it under the terms of the GNU Lesser General Public
0011: * License as published by the Free Software Foundation; either
0012: * version 2 of the License, or (at your option) any later version.
0013: *
0014: * This library is distributed in the hope that it will be useful,
0015: * but WITHOUT ANY WARRANTY; without even the implied warranty of
0016: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
0017: * Lesser General Public License for more details.
0018: *
0019: * You should have received a copy of the GNU Lesser General Public
0020: * License along with this library located in LGPL.txt in the
0021: * license directory; if not, write to the
0022: * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
0023: * Boston, MA 02111-1307, USA.
0024: *
0025: * If this agreement does not cover your requirements, please contact us
0026: * via email to get detailed information about the commercial license
0027: * or our service offerings!
0028: *
0029: */
0030: // @@
0031: package de.ug2t.unifiedGui.interfaces;
0032:
0033: import de.ug2t.connector.*;
0034: import de.ug2t.kernel.interfaces.*;
0035: import de.ug2t.model.values.*;
0036: import de.ug2t.unifiedGui.*;
0037: import de.ug2t.unifiedGui.plugins.*;
0038:
0039: /**
0040: * @author Dirk
0041: *
0042: * date: 26.01.2004 project: WiSer-Framework
0043: *
0044: * <p>
0045: * IUnComponent is the common interface to all widgets of JmcFrame. General
0046: * functions are collected within this interface.
0047: * </p>
0048: */
0049: public interface IUnComponent extends IKeTreeNode {
0050: public static int NO_BORDER = 0;
0051: public static int INSETS_BORDER = 1;
0052: public static int OUTSETS_BORDER = 2;
0053: public static int LINE_BORDER = 3;
0054:
0055: public static final int TEXT_ALIGN_EAST = 0;
0056: public static final int TEXT_ALIGN_WEST = 1;
0057: public static final int TEXT_ALIGN_CENTER = 2;
0058:
0059: public static final String CURSOR_CROSSHAIR = "CORSSHAIR";
0060: public static final String CURSOR_HAND = "HAND";
0061: public static final String CURSOR_POINTER = "POINTER";
0062: public static final String CURSOR_MOVE = "MOVE";
0063: public static final String CURSOR_WAIT = "WAIT";
0064:
0065: /**
0066: * Latency for scroll events
0067: */
0068: public static int EVENT_LATENCY_SCROLL = 200;
0069: /**
0070: * Latency for move events
0071: */
0072: public static int EVENT_LATENCY_MOVE = 200;
0073: /**
0074: * Latency for resize events
0075: */
0076: public static int EVENT_LATENCY_RESIZE = 200;
0077:
0078: /**
0079: * <p>
0080: * Gets the associated gui-object which implements all common methods
0081: * </p>
0082: * <p>
0083: *
0084: * @return gui-object
0085: * </p>
0086: * <p>
0087: * </p>
0088: */
0089: public UnComponent pcmf_getUnComponent();
0090:
0091: /**
0092: * <p>
0093: * Sets a border line. To remove a border all the method with (NO_BORDER, "",
0094: * 0)
0095: * </p>
0096: * <p>
0097: *
0098: * </p>
0099: * <p>
0100: *
0101: * @param xBorder
0102: * border-style [NO_BORDER || INSETS_BORDER || OTSETS_BORDER ||
0103: * LINE_BORDER]
0104: * @param xColor
0105: * border-color
0106: * @param xWidth
0107: * border-width in pixel
0108: * </p>
0109: */
0110: public void pcmf_setBorder(int xBorder, String xColor, int xWidth);
0111:
0112: /**
0113: * <p>
0114: * Sets a widget as global. This means that the widget can be accessed from
0115: * client-side whether the containing page is active or not
0116: * </p>
0117: * <p>
0118: *
0119: * </p>
0120: * <p>
0121: *
0122: * @param xGlobal
0123: * true indicates global, false indicates page-local
0124: * </p>
0125: */
0126: public void pcmf_setGlobal(boolean xGlobal);
0127:
0128: /**
0129: * <p>
0130: * Gets the information whether the page is global accessible from client-side
0131: * or not
0132: * </p>
0133: * <p>
0134: *
0135: * @return true indicates global, false indicates page-local
0136: * </p>
0137: * <p>
0138: * </p>
0139: */
0140: public boolean pcmf_getGlobal();
0141:
0142: /**
0143: * <p>
0144: * Sets a direct refresh flag of the widget. Due to this the connected
0145: * event-listeners will be called during the next event-dispatch. After the
0146: * event-dispatch this flag is set to false
0147: * </p>
0148: * <p>
0149: * </p>
0150: * <p>
0151: * </p>
0152: */
0153: public void pcmf_setRefresh();
0154:
0155: /**
0156: * <p>
0157: * Gets the status of the widgets refresh flag
0158: * </p>
0159: * <p>
0160: *
0161: * @return true if the widgets value has been refreshed since the last
0162: * event-dispatch, otherwise false
0163: * </p>
0164: * <p>
0165: * </p>
0166: */
0167: public boolean pcmf_isRefreshed();
0168:
0169: /**
0170: * <p>
0171: * Sets a indirect refresh flag of the widget. Due to this the connected
0172: * indirect event-listeners will be called during the next event-dispatch.
0173: * After the event-dispatch this flag is set to false. The meaning of the
0174: * indirect refresh flag is that not the widgets value has been changed but
0175: * one of the widgets children value has been changed since the last
0176: * event-dispatch.
0177: * </p>
0178: * <p>
0179: * </p>
0180: * <p>
0181: * </p>
0182: */
0183: public void pcmf_setIndirectRefresh();
0184:
0185: /**
0186: * <p>
0187: * Gets the status of the widgets indirect refresh flag
0188: * </p>
0189: * <p>
0190: *
0191: * @return true if the widgets children value has been refreshed since the
0192: * last event-dipatch, otherwise false
0193: * </p>
0194: * <p>
0195: * </p>
0196: */
0197: public boolean pcmf_isIndirectRefreshed();
0198:
0199: /**
0200: * <p>
0201: * Adds a listener to the widget. The listener is called every time the value
0202: * of the widget is changed by the gui.
0203: * </p>
0204: * <p>
0205: *
0206: * </p>
0207: * <p>
0208: *
0209: * @param xListener
0210: * listener to add
0211: * </p>
0212: */
0213: public void pcmf_addListener(IUnGuiEventListener xListener);
0214:
0215: /**
0216: * <p>
0217: * Removes a listener from a widget.
0218: * </p>
0219: * <p>
0220: *
0221: * </p>
0222: * <p>
0223: *
0224: * @param xListener
0225: * listener to remove
0226: * </p>
0227: */
0228: public void pcmf_remListener(IUnGuiEventListener xListener);
0229:
0230: /**
0231: * <p>
0232: * Adds an event channel to the widget.
0233: * </p>
0234: * <p>
0235: *
0236: * </p>
0237: * <p>
0238: *
0239: * @param xEvC
0240: * channel to add
0241: * </p>
0242: */
0243: public void pcmf_addEventChannel(IUnEventChannel xEvC);
0244:
0245: /**
0246: * <p>
0247: * Removes an event channle from a widget.
0248: * </p>
0249: * <p>
0250: *
0251: * </p>
0252: * <p>
0253: *
0254: * @param xEvC
0255: * channel to remove
0256: * </p>
0257: */
0258: public void pcmf_remEventChannel(IUnEventChannel xEvC);
0259:
0260: /**
0261: * <p>
0262: * Adds an indirect listener to the widget. The indirect listener is called
0263: * every time a value of a child of the widget is changed by the gui.
0264: * </p>
0265: * <p>
0266: *
0267: * </p>
0268: * <p>
0269: *
0270: * @param xListener
0271: * listener to add
0272: * </p>
0273: */
0274: public void pcmf_addIndirectListener(IUnGuiEventListener xListener);
0275:
0276: /**
0277: * <p>
0278: * Removes an indirect listener from a widget.
0279: * </p>
0280: * <p>
0281: *
0282: * </p>
0283: * <p>
0284: *
0285: * @param xListener
0286: * indirect listener to remove
0287: * </p>
0288: */
0289: public void pcmf_remIndirectListener(IUnGuiEventListener xListener);
0290:
0291: /**
0292: * <p>
0293: * Enables or disables preFunction handling of widget. Prefunction are
0294: * executed by default. For performance-reasons disabling this feature may be
0295: * reasonable
0296: * </p>
0297: * <p>
0298: *
0299: * </p>
0300: * <p>
0301: *
0302: * @param xPreFct
0303: * true enables handling, false disables
0304: * </p>
0305: */
0306: public void pcmf_setPreFct(boolean xPreFct);
0307:
0308: /**
0309: * <p>
0310: * Adds a pre-display function to the widget. This function is called before
0311: * the widget is displayed on screen by activating the page which contains the
0312: * widget.
0313: * </p>
0314: * <p>
0315: *
0316: * </p>
0317: * <p>
0318: *
0319: * @param xpreFct
0320: * pre-display function to add
0321: * </p>
0322: */
0323: public void pcmf_addPreFct(IUnPreDisplayFunction xpreFct);
0324:
0325: /**
0326: * <p>
0327: * Removes a pre-display function from a widget
0328: * </p>
0329: * <p>
0330: *
0331: * </p>
0332: * <p>
0333: *
0334: * @param xpreFct
0335: * pre-display function to remove
0336: * </p>
0337: */
0338: public void pcmf_remPreFct(IUnPreDisplayFunction xpreFct);
0339:
0340: /**
0341: * <p>
0342: * Enables or disables postFunction handling of widget. Postfunction are
0343: * executed by default. For performance-reasons disabling this feature may be
0344: * reasonable
0345: * </p>
0346: * <p>
0347: *
0348: * </p>
0349: * <p>
0350: *
0351: * @param xPostFct
0352: * true enables handling, false disables
0353: * </p>
0354: */
0355: public void pcmf_setPostFct(boolean xPostFct);
0356:
0357: /**
0358: * <p>
0359: * Adds a post-display function to the widget. This function is called after
0360: * the widget has been removed from screen by activating an other page than
0361: * the one which contains the widget.
0362: * </p>
0363: * <p>
0364: *
0365: * </p>
0366: * <p>
0367: *
0368: * @param xpostFct
0369: * post-display function to add
0370: * </p>
0371: */
0372: public void pcmf_addPostFct(IUnPostDisplayFunction xpostFct);
0373:
0374: /**
0375: * <p>
0376: * Removes a post-display function from a widget
0377: * </p>
0378: * <p>
0379: *
0380: * </p>
0381: * <p>
0382: *
0383: * @param xpostFct
0384: * post-display function to remove
0385: * </p>
0386: */
0387: public void pcmf_remPostFct(IUnPostDisplayFunction xpostFct);
0388:
0389: /**
0390: * <p>
0391: * Returns the String representation of the widgets value
0392: * </p>
0393: * <p>
0394: *
0395: * @return String representation
0396: * </p>
0397: * <p>
0398: * </p>
0399: */
0400: public String toString();
0401:
0402: /**
0403: * <p>
0404: * Enables the submit flag of a widget. If this flag is enabled a change of
0405: * the widget value within the gui, or lost of focus leads to a server-side
0406: * event-dispatch.
0407: * </p>
0408: * <p>
0409: *
0410: * </p>
0411: * <p>
0412: * </p>
0413: */
0414: public void pcmf_enableSubmit();
0415:
0416: /**
0417: * <p>
0418: * Disables the submit Flag of a component
0419: * </p>
0420: */
0421: public void pcmf_disableSubmit();
0422:
0423: /**
0424: * <p>
0425: * Disables the submit flag of a widget. If this flag is disabled the widgets
0426: * value will be stored at client-side until an other widget initiates a
0427: * server-side event-dispatch
0428: * </p>
0429: * <p>
0430: *
0431: * </p>
0432: * <p>
0433: * </p>
0434: */
0435: public boolean pcmf_isSubmit();
0436:
0437: /**
0438: * <p>
0439: * Associates a data-getter object with this widget. The data-getter sets the
0440: * value of the widget from an external data-source when 'pcmf_selfRefresh' is
0441: * called.
0442: * </p>
0443: * <p>
0444: *
0445: * </p>
0446: * <p>
0447: *
0448: * @param xDg
0449: * data-getter
0450: * @param xId
0451: * id of the data (-record) to get
0452: * @param xRefresh
0453: * true if the widgets refresh flag has to be enabled after refresh,
0454: * otherwise false
0455: * </p>
0456: */
0457: public void pcmf_setDataGetter(ACoDataGetter xDg, String xId,
0458: boolean xRefresh);
0459:
0460: /**
0461: * <p>
0462: * A call to this function make the widget load a new value from an associated
0463: * data-getter
0464: * </p>
0465: * <p>
0466: *
0467: * </p>
0468: * <p>
0469: * </p>
0470: */
0471: public void pcmf_selfRefresh() throws Exception;
0472:
0473: /**
0474: * <p>
0475: * Gets the application which is the owner of this widget
0476: * </p>
0477: * <p>
0478: *
0479: * @return interface to application object
0480: * </p>
0481: * <p>
0482: * </p>
0483: */
0484: public IUnApplication pcmf_getAppl();
0485:
0486: /**
0487: * <p>
0488: * Sets the application which owns this widget. In most cases there is no need
0489: * to use this function.
0490: * </p>
0491: * <p>
0492: *
0493: * </p>
0494: * <p>
0495: *
0496: * @param xAppl
0497: * interface to application object
0498: * </p>
0499: */
0500: public void pcmf_setAppl(IUnApplication xAppl);
0501:
0502: /**
0503: * <p>
0504: * Sets the tooltip to a widget. A tooltip is a small window which contains a
0505: * short explanation. This window pops up if the mouse-cursor stay above the
0506: * widget for some seconds.
0507: * </p>
0508: * <p>
0509: *
0510: * </p>
0511: * <p>
0512: *
0513: * @param xTip
0514: * tooltip text
0515: * </p>
0516: */
0517: public void pcmf_setToolTip(String xTip);
0518:
0519: /**
0520: * <p>
0521: * Gets the tooltip which has been set to this widget.
0522: * </p>
0523: * <p>
0524: *
0525: * @return tooltip text
0526: * </p>
0527: * <p>
0528: * </p>
0529: */
0530: public String pcmf_getToolTip();
0531:
0532: /**
0533: * <p>
0534: * Sets the foreground-color of the widget.
0535: * </p>
0536: * <p>
0537: *
0538: * </p>
0539: * <p>
0540: *
0541: * @param xCol
0542: * foreground-color as string. For swing channel all constant-names
0543: * for colors are supported. For MARKUP channel all supported
0544: * string-values are supported.
0545: * </p>
0546: */
0547: public void pcmf_setFgColor(String xCol);
0548:
0549: /**
0550: * <p>
0551: * Gets the foreground-color of a widget.
0552: * </p>
0553: * <p>
0554: *
0555: * @return foreground-color as string
0556: * </p>
0557: * <p>
0558: * </p>
0559: */
0560: public String pcmf_getFgColor();
0561:
0562: /**
0563: * <p>
0564: * Sets the background-color of the widget.
0565: * </p>
0566: * <p>
0567: *
0568: * </p>
0569: * <p>
0570: *
0571: * @param xCol
0572: * background-color as string. For swing channel all constant-names
0573: * for colors are supported. For MARKUP channel all supported
0574: * string-values are supported.
0575: * </p>
0576: */
0577: public void pcmf_setBgColor(String xCol);
0578:
0579: /**
0580: * <p>
0581: * Gets the background-color of a widget.
0582: * </p>
0583: * <p>
0584: *
0585: * @return background-color as string
0586: * </p>
0587: * <p>
0588: * </p>
0589: */
0590: public String pcmf_getBgColor();
0591:
0592: /**
0593: * <p>
0594: * Initiates a complete repaint and reinitialise of the widget. This may lead
0595: * to produce events. If you only want to be rendered call pcmf_draw.
0596: * </p>
0597: * <p>
0598: *
0599: * </p>
0600: * <p>
0601: * </p>
0602: */
0603: public void pcmf_repaint();
0604:
0605: /**
0606: * <p>
0607: * Initiates a repaint of the widget.
0608: * </p>
0609: * <p>
0610: *
0611: * </p>
0612: * <p>
0613: * </p>
0614: */
0615: public void pcmf_draw();
0616:
0617: /**
0618: * <p>
0619: * Sets the model-value which belongs to the widget.
0620: * </p>
0621: * <p>
0622: *
0623: * @return previous model-value
0624: * </p>
0625: * <p>
0626: * @param xModel
0627: * new model-value
0628: * </p>
0629: */
0630: public IMoValue pcmf_setModel(IMoValue xModel);
0631:
0632: /**
0633: * <p>
0634: * Gets the model value which belongs to the widget.
0635: * </p>
0636: * <p>
0637: *
0638: * @return model-value
0639: * </p>
0640: * <p>
0641: * </p>
0642: */
0643: public IMoValue pcmf_getModel();
0644:
0645: /**
0646: * <p>
0647: * Sets the template of the model-value which belongs to the widget.
0648: * </p>
0649: * <p>
0650: *
0651: * @return previous template
0652: * </p>
0653: * <p>
0654: * @param xModel
0655: * new template
0656: * </p>
0657: */
0658: public IMoValue pcmf_setModelTpl(IMoValue xModel);
0659:
0660: /**
0661: * <p>
0662: * Gets the template of the model-value which belongs to the widget.
0663: * </p>
0664: * <p>
0665: *
0666: * @return template
0667: * </p>
0668: * <p>
0669: * </p>
0670: */
0671: public IMoValue pcmf_getModelTpl();
0672:
0673: /**
0674: * <p>
0675: * Creates a new model-value from the template.
0676: * </p>
0677: * <p>
0678: *
0679: * @return new model-value
0680: * </p>
0681: * <p>
0682: * @param xName
0683: * identifier of the model-value
0684: * @param xChilds
0685: * true if all sub-values are created immediately, otherwise false
0686: * </p>
0687: */
0688: public IMoValue pcmf_newModelValue(String xName, boolean xChilds);
0689:
0690: /**
0691: * <p>
0692: * Creates a new model-value from the template.
0693: * </p>
0694: * <p>
0695: *
0696: * @return new model-value
0697: * </p>
0698: * <p>
0699: * @param xName
0700: * identifier of the model-value
0701: * @param xChilds
0702: * true if all sub-values are created immediately, otherwise false
0703: * @param xFull
0704: * true if all sub-values (including the non mandatory ones) are
0705: * created immediately, otherwise false
0706: * </p>
0707: */
0708: public IMoValue pcmf_newModelValue(String xName, boolean xChilds,
0709: boolean xFull);
0710:
0711: /**
0712: * <p>
0713: * Sets the font which is used to display text within the widget.
0714: * </p>
0715: * <p>
0716: *
0717: * </p>
0718: * <p>
0719: *
0720: * @param xFont
0721: * font-descriptor
0722: * </p>
0723: */
0724: public void pcmf_setFont(UnFontDescriptor xFont);
0725:
0726: /**
0727: * <p>
0728: * Gets the font which is used to display text within the widget.
0729: * </p>
0730: * <p>
0731: *
0732: * @return font-descriptor
0733: * </p>
0734: * <p>
0735: * </p>
0736: */
0737: public UnFontDescriptor pcmf_getFont();
0738:
0739: /**
0740: * <p>
0741: * Requests the input-focus for the widget.
0742: * </p>
0743: * <p>
0744: *
0745: * </p>
0746: * <p>
0747: * </p>
0748: */
0749: public void pcmf_requestFocus();
0750:
0751: /**
0752: * <p>
0753: * Sets the value of the widget. Listeners of Swing widgets might be called as
0754: * as side-effect. The behaviour of events might be different in Swing and
0755: * Web/MARKUP
0756: * </p>
0757: * <p>
0758: *
0759: * </p>
0760: * <p>
0761: *
0762: * @param xValue
0763: * new widget-value
0764: * </p>
0765: */
0766: public void pcmf_setValue(Object xValue);
0767:
0768: /**
0769: * <p>
0770: * Sets the value of the widget. Listeners are called as as side-effect. The
0771: * behaviour of events is similar in Swing and Web/MARKUP
0772: * </p>
0773: * <p>
0774: *
0775: * </p>
0776: * <p>
0777: *
0778: * @param xValue
0779: * new widget-value
0780: * </p>
0781: */
0782: public void pcmf_setWidgetValue(Object xValue);
0783:
0784: /**
0785: * <p>
0786: * Sets the value of the server side part of the widget. No Listeners are
0787: * called as as side-effect.
0788: * </p>
0789: * <p>
0790: *
0791: * </p>
0792: * <p>
0793: *
0794: * @param xValue
0795: * new widget-value
0796: * </p>
0797: */
0798: public void pcmf_setLocalValue(Object xValue);
0799:
0800: /**
0801: * <p>
0802: * Applies a fixed size to a widget
0803: * </p>
0804: * <p>
0805: *
0806: * </p>
0807: * <p>
0808: *
0809: * @param w
0810: * new size width
0811: * @param h
0812: * new size height
0813: * @param type
0814: * of the size setting (UnFixedSize.FIX_SIZE, UnFixedSize.MIN_SIZE,
0815: * UnFixedSize.MAX_SIZE)
0816: * </p>
0817: */
0818: public void pcmf_setFixedSize(int w, int h, int xType);
0819:
0820: /**
0821: * <p>
0822: * Gets the fixed size of a widget
0823: * </p>
0824: * <p>
0825: *
0826: * @return a copy of the fixed size object of the widget
0827: *
0828: * </p>
0829: * <p>
0830: * </p>
0831: */
0832: public UnFixedSize pcmf_getFixedSize();
0833:
0834: /**
0835: * <p>
0836: * Deletes a fixed size setting from a widget
0837: * </p>
0838: * <p>
0839: *
0840: * </p>
0841: * <p>
0842: * </p>
0843: */
0844: public void pcmf_deleteFixedSize();
0845:
0846: /**
0847: * <p>
0848: * Sets whether only value-change leads to an event or not
0849: * </p>
0850: * <p>
0851: *
0852: * </p>
0853: * <p>
0854: *
0855: * @param xEvC
0856: * true indicates that the event is generated every time, false
0857: * indicates that the event is only generated in case if value-change
0858: * </p>
0859: */
0860: public void pcmf_setEventOnChange(boolean xEvC);
0861:
0862: /**
0863: * <p>
0864: * Returns whether only value-change leads to an event or not
0865: * </p>
0866: * <p>
0867: *
0868: * @return true indicates that the event is generated every time, false
0869: * indicates that the event is only generated in case if value-change
0870: * </p>
0871: * <p>
0872: * </p>
0873: */
0874: public boolean pcmf_getEventOnChange();
0875:
0876: /**
0877: * <p>
0878: * The renderIfHidden flag indicates that a widget is rendered always
0879: * </p>
0880: * <p>
0881: *
0882: * </p>
0883: * <p>
0884: *
0885: * @param xRiH
0886: * true render widget if hidden flag is true false do not render
0887: * widget if hidden flag is true
0888: * </p>
0889: */
0890: public void pcmf_setRenderIfHidden(boolean xRiH);
0891:
0892: /**
0893: * <p>
0894: * The renderIfHidden flag indicates that a widget is rendered always
0895: * </p>
0896: * <p>
0897: *
0898: * @return true indicates that widget renders if hidden flag is true false
0899: * indicates that widget renders not if hidden flag is true
0900: * value-change
0901: * </p>
0902: * <p>
0903: * </p>
0904: */
0905: public boolean pcmf_getRenderIfHidden();
0906:
0907: /**
0908: * <p>
0909: * Sets the style-sheet class of the widget (MARKUP only)
0910: * </p>
0911: * <p>
0912: *
0913: * </p>
0914: * <p>
0915: *
0916: * @param xClass
0917: * style-class
0918: * </p>
0919: */
0920: public void pcmf_setCssClass(String xClass);
0921:
0922: /**
0923: * <p>
0924: * Gets the style-sheet class (MARKUP only)
0925: * </p>
0926: * <p>
0927: *
0928: * </p>
0929: * <p>
0930: * </p>
0931: */
0932: public String pcmf_getCssClass();
0933:
0934: /**
0935: * <p>
0936: * Set a property that indicates that a widget takes all space available in a
0937: * layout (MARKUP only)
0938: * </p>
0939: * <p>
0940: *
0941: * </p>
0942: * <p>
0943: *
0944: * @param xSpace
0945: * </p>
0946: */
0947: public void pcmf_setTakeMaxSpace(boolean xSpace);
0948:
0949: /**
0950: * <p>
0951: * Gets the maxSpace property (MARKUP only)
0952: * </p>
0953: * <p>
0954: *
0955: * </p>
0956: * <p>
0957: * </p>
0958: */
0959: public boolean pcmf_getTakeMaxSpace();
0960:
0961: /**
0962: * <p>
0963: * Consumes the event for this widget. It does not prevent event bubbling!
0964: * </p>
0965: * <p>
0966: *
0967: * </p>
0968: * <p>
0969: * </p>
0970: */
0971: public void pcmf_consumeEvent();
0972:
0973: /**
0974: * <p>
0975: * Deletes all (foreground/background) color settings of a widget
0976: * </p>
0977: */
0978: public void pcmf_resetColorSettings();
0979:
0980: /**
0981: * <p>
0982: * Sets the delay (latency) in millis for iterative events as there are
0983: * scroll, moved, resized. For Example: A delay of 200 ms means that a scroll
0984: * event is passed to the server after 200ms, presumed that there is no
0985: * further scroll event generated during this time. This feature is able to
0986: * reduce network trafic significant.
0987: * </p>
0988: * <p>
0989: *
0990: * @param xLatency
0991: * time in millis
0992: * </p>
0993: */
0994: public void pcmf_setIterativeEventLatency(int xLatency);
0995:
0996: /**
0997: * <p>
0998: * Gets the latency time
0999: * </p>
1000: * <p>
1001: *
1002: * @returns Latency time in millis
1003: * </p>
1004: */
1005: public int pcmf_getIterativeEventLatency();
1006:
1007: /**
1008: * <p>
1009: * Gets the the border-style [NO_BORDER || INSETS_BORDER || OTSETS_BORDER ||
1010: * LINE_BORDER]
1011: * </p>
1012: * <p>
1013: *
1014: * @returns style
1015: * </p>
1016: */
1017: public int pcmf_getBorder();
1018:
1019: /**
1020: * <p>
1021: * Gets the the border color
1022: * </p>
1023: * <p>
1024: *
1025: * @returns color
1026: * </p>
1027: */
1028: public String pcmf_getBorderColor();
1029:
1030: /**
1031: * <p>
1032: * Gets the border width in pixel
1033: * </p>
1034: * <p>
1035: *
1036: * @returns width
1037: * </p>
1038: */
1039: public int pcmf_getBorderWidth();
1040:
1041: /**
1042: * <p>
1043: * Returns a related plugin object if available
1044: * </p>
1045: * <p>
1046: *
1047: * @returns plugin object
1048: * </p>
1049: */
1050: public PlBasicComponentAggregat pcmf_getPluginPeer();
1051:
1052: /**
1053: * <p>
1054: * Returns a related plugin parent object if available
1055: * </p>
1056: * <p>
1057: *
1058: * @returns plugin object
1059: * </p>
1060: */
1061: public PlBasicComponentAggregat pcmf_getParentPlugin();
1062:
1063: /**
1064: * <p>
1065: * Returns wheter the component has a context menu or not, this flag is set
1066: * once the context menu is added.
1067: * </p>
1068: */
1069: public boolean pcmf_hasCtxMenu();
1070:
1071: /**
1072: * <p>
1073: * Sets the cursor of the component
1074: * </p>
1075: * <p>
1076: *
1077: * @param Either IUnComonent.CURSOR_CROSSHAIR, ...
1078: * </p>
1079: */
1080: public void pcmf_setCursor(String xCursor);
1081:
1082: /**
1083: * <p>
1084: * Gets the cursor of the component
1085: * </p>
1086: * <p>
1087: *
1088: * @param null if no special cursor has been set or either IUnComonent.CURSOR_CROSSHAIR, ...
1089: * </p>
1090: */
1091: public String pcmf_getCurser();
1092: }
|