001: /*
002: * Copyright 2005-2007 The Kuali Foundation.
003: *
004: * Licensed under the Educational Community License, Version 1.0 (the "License");
005: * you may not use this file except in compliance with the License.
006: * You may obtain a copy of the License at
007: *
008: * http://www.opensource.org/licenses/ecl1.php
009: *
010: * Unless required by applicable law or agreed to in writing, software
011: * distributed under the License is distributed on an "AS IS" BASIS,
012: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013: * See the License for the specific language governing permissions and
014: * limitations under the License.
015: */
016: package org.kuali.core.datadictionary.control;
017:
018: import org.kuali.core.datadictionary.DataDictionaryDefinition;
019:
020: /**
021: * ControlDefinition
022: *
023: *
024: */
025: public interface ControlDefinition extends DataDictionaryDefinition {
026:
027: public boolean isDatePicker();
028:
029: public void setDatePicker(boolean datePicker);
030:
031: /**
032: * @return true if this ControlDefinition instance represents an HTML checkbox control
033: */
034: public boolean isCheckbox();
035:
036: /**
037: * @return true if this ControlDefinition instance represents an HTML hidden control
038: */
039: public boolean isHidden();
040:
041: /**
042: * @return true if this ControlDefinition instance represents an HTML radiobutton control
043: */
044: public boolean isRadio();
045:
046: /**
047: * @return true if this ControlDefinition instance represents an HTML select control
048: */
049: public boolean isSelect();
050:
051: /**
052: * @return true if this ControlDefinition instance represents an HTML select control that is tied to an APC rule
053: */
054: public boolean isApcSelect();
055:
056: /**
057: * @return true if this ControlDefinition instance represents an HTML text control
058: */
059: public boolean isText();
060:
061: /**
062: * @return true if this ControlDefinition instance represents an HTML textarea control
063: */
064: public boolean isTextarea();
065:
066: /**
067: *
068: * @return any Script associated with this control
069: */
070: public String getScript();
071:
072: /**
073: * @return true if the ControlDefinition instance represents a currency control
074: */
075: public boolean isCurrency();
076:
077: /**
078: *
079: * @return true if the ControlDefinition instance represents a kualiUser control
080: */
081: public boolean isKualiUser();
082:
083: /**
084: * @return true if the ControlDefinition instance represents a workflow workgroup control
085: */
086: public boolean isWorkflowWorkgroup();
087:
088: /**
089: * @return true if the ControlDefinition instance represents a lookupHidden control
090: */
091: public boolean isLookupHidden();
092:
093: /**
094: * @return true if the ControlDefinition instance represents a lookupReadonly control
095: */
096: public boolean isLookupReadonly();
097:
098: /**
099: * Sets the Class used to retrieve the complete range of values for radiobutton and select controls.
100: *
101: * @param valuesFinderClass
102: */
103: public void setValuesFinderClass(Class valuesFinderClass);
104:
105: /**
106: * Sets the Script
107: *
108: * @param script
109: */
110: public void setScript(String script);
111:
112: /**
113: * @return Class used to retrieve the complete range of values for radiobutton and select controls.
114: */
115: public Class getValuesFinderClass();
116:
117: /**
118: * Sets the size parameter for text controls.
119: *
120: * @param size
121: */
122: public void setSize(Integer size);
123:
124: /**
125: * @return size parameters for text controls
126: */
127: public Integer getSize();
128:
129: /**
130: * Sets the rows parameter for textarea controls.
131: *
132: * @param rows
133: */
134: public void setRows(Integer rows);
135:
136: /**
137: * @return rows parameters for textarea controls
138: */
139: public Integer getRows();
140:
141: /**
142: * Sets the cols parameter for textarea controls.
143: *
144: * @param cols
145: */
146: public void setCols(Integer cols);
147:
148: /**
149: * @return cols parameter for textarea controls.
150: */
151: public Integer getCols();
152:
153: }
|